Response

The response format from the web services is standard. It does vary slightly depending on whether the web service call comes back as a paged query or as a non-paged query. Regardless of the query type and if there is data returned or not, the result property will always be an array. However, if no data is found, it will be an empty array. If you're querying a single result, it'll be an array with a single element. And in list queries, it'll be an array of objects.

Paged Query

The response format from the web services is standard. It does vary slightly depending on whether the web service call comes back as a paged query or as a non-paged query. Regardless of the query type and if there is data returned or not, the result property will always be an array. However, if no data is found, it will be an empty array. If you're querying a single result, it'll be an array with a single element. And in list queries, it'll be an array of objects.

Paged Query Sample Response

{
    "success": true,
    "requestId": "S59214236",
    "totalCount": 4,
    "isPaged": true,
    "totalPages": 1,
    "page": 1,
    "pageSize": 100,
    "result": [
        {...},
        {...}
    ]
}

Non-Paged Query

For a non-paged query, which are typically small list queries, the results will not contain the properties for total pages, page, or page size. However, the result property will still be an array containing zero or more objects.

Non-Paged Query Sample Repsonse

{
    "success": true,
    "requestId": "J59602219",
    "totalCount": 21,
    "isPaged": false,
    "result": [
        {...},
        {...}
    ]
}

Response Properties

Property	Description
success	Indicates whether the web service call was successful.
requestId	Unique identifier for the request. Used for server-side debugging.
totalCount	Total number of records in the query result.
isPaged	Indicates whether the query is a paged query or not.
totalPages	Total number of pages available on the server.
page	Current page number in the paged query result.
pageSize	Number of records per page in the paged query result.
result	Array containing the query result objects.