API Guide

<BASE_URI>/SessionService/Sessions?$skip=1&$top=2&
(To get the list of sessions by skipping to the 2
nd
session, and returning the top 3 )
Data pagination
Data pagination can be accomplished by providing additional information in the GET request corresponding to a chunk of data. The
response returns information on the total number of entries that could be used to reset any page numbering if the data has changed since
the last call:
<BASE_URI>/ SessionService/Sessions/$top=2
This query will return the first chunk of data corresponding to the top two sessions.
<BASE_URI>/ SessionService/Sessions /$skip=2&$top=3
This query will skip the first two records and return effectively the next three sessions.
NOTE: The pagination keywords ($top and $skip) are case sensitive.
Data pagination may be combined with data filtering. However, the data pagination key-value pairs must appear first. For example, if you
want to retrieve the top 100 devices with critical status, use the following command:
<BASE_URI>/ApplicationService/AuditLogs?$filter=CreatedDate gt '2016-11-15 16:35:39.820'&$top=20
A maximum of 20 logs with a date greater than '2016-11-15 16:35:39.820' will be returned. The number of logs returned could be less than
the maximum of 20 that was requested.
Request headers
The request header represents headers in the client HTTPS request that are used to communicate client preferences to the service end-
point. The service will indicate the supported preference in the response header. The following table includes a few examples of request
headers. For an extensive list of request headers, see List of HTTP header fields.
Table 2. Request headers
Request header Description Example
x-auth-token Authentication token taken from the
return header of the SessionService/
Sessions POST to create a session.
x-auth-token: d6399a19-38c8-467b-a1ec-75ffa03efb7c
Accept-Language Choice of language that can be
requested by the client. (Optional)
Accept-Language: en
Response codes
For synchronous operations, the server returns HTTP response codes 200 or 204 depending on the request. For long-running operations,
the server returns a status code of 202 along with a HTTP response header (Location), corresponding to the URI of the temporary
resource that can be used to monitor the operation. The following table includes a few examples of response codes. For an extensive list
of response codes, see List of HTTP status codes.
Table 3. Response codes
Request header Description
Success codes
GET 200 – OK with message body
204 – OK with no message body
206 – OK with partial message body
POST 201 – Resource created (operation complete)
202 – Resource accepted (operation pending)
Key integration concepts 7