GET api/CUSTODIANS?f[0].Name={f[0].Name}&f[0].Value={f[0].Value}&f[0].CompOp={f[0].CompOp}&f[0].LogOp={f[0].LogOp}&f[1].Name={f[1].Name}&f[1].Value={f[1].Value}&f[1].CompOp={f[1].CompOp}&f[1].LogOp={f[1].LogOp}&s[0].FieldName={s[0].FieldName}&s[0].Direction={s[0].Direction}&s[1].FieldName={s[1].FieldName}&s[1].Direction={s[1].Direction}&IDs={IDs}&pSize={pSize}&pNo={pNo}&foreigns={foreigns}
Get CUSTODIANS list according to passed filters, sortings and paganation info
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| f |
Optional. Default value is null. Filter parameters |
Collection of Field |
Required |
| s |
Optional. Default value is null. Sorting parameters |
Collection of SortFields |
Required |
| IDs |
Optional. Default value is null. , Separated string of IDs for records that exists at mobile app database according to passed filters, sortings and paganation info. Mobile app should delete related records from local database if the are no returned from server |
string |
None. |
| pSize |
Optional. Default value is 1. Maximum records count (page size) that may return as a result of GET request. If not passed, a max of 50 records will be returned as a result for the request |
integer |
Default value is 50 |
| pNo |
Optional. Default value is 1. Page index (a number starting from 1) needed from server. If not passed page 1 will be returned |
integer |
Default value is 1 |
| foreigns |
Optional. Default value is false. True=> Include nested foreign objects within reply. False=> Do NOT Include nested foreign objects within reply |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
CUSTODIANS_GET_RESPONSE| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | Status |
None. |
|
| Page | Page |
None. |
|
| DATA | Collection of CUSTODIANS |
None. |
Response Formats
application/json, text/json
{
"Status": {
"Success": true,
"Code": "0",
"DetailedMessage": "sample string 3",
"Message": "sample string 2"
},
"Page": {
"PageSize": 4,
"PageNo": 3,
"PagesCount": 2,
"TotalRecords": 1
},
"DATA": [
{
"ACTIVE": true,
"CUSTODIAN_TYPE": 64,
"CUSTODIAN_ID": 1,
"LAST_NOTIFY_DELETE": "2025-11-14T21:22:27.9317356Z",
"NOTES": "sample string 7",
"LOGIN_PASSWORD": "sample string 5",
"LOGIN_NAME": "sample string 4",
"CUSTODIAN_NAME": "sample string 2"
},
{
"ACTIVE": true,
"CUSTODIAN_TYPE": 64,
"CUSTODIAN_ID": 1,
"LAST_NOTIFY_DELETE": "2025-11-14T21:22:27.9317356Z",
"NOTES": "sample string 7",
"LOGIN_PASSWORD": "sample string 5",
"LOGIN_NAME": "sample string 4",
"CUSTODIAN_NAME": "sample string 2"
}
]
}
