GET NoteCategories?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves note categories for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
take |
Number of note categories to retrieve. Default is all note categories |
integer |
None. |
skip |
Number of note categories to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the note categories before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of note categories.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of NoteCategory |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "NoteCategoryId": "77b39f15-0e93-4ed6-ac24-a039a446cbd3", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "87310bb0-e42f-4354-9c7f-e8f90be45616", "CreateDate": "2024-12-08T18:44:04.1034597-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-08T18:44:04.1034597-08:00", "LastModifiedUser": "sample string 5" }, { "NoteCategoryId": "77b39f15-0e93-4ed6-ac24-a039a446cbd3", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "87310bb0-e42f-4354-9c7f-e8f90be45616", "CreateDate": "2024-12-08T18:44:04.1034597-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-08T18:44:04.1034597-08:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }