GET v1/core/Accounts/{accId}/devices/iotdevices/paged?pageSize={pageSize}&pageNumber={pageNumber}&includeTotal={includeTotal}

List a paged set of IOT devices

Request Information

Parameters

Name	Description	Additional information
accId	The account ID	Define this parameter in the request URI.
pageSize	The number of results to return per page. Allowable values between 0 and 1000. The default value is 0. If an invalid value is supplied, 1000 will be used instead.	Define this parameter in the request URI.
pageNumber	The page number, starting from 0. The default value is 0. If an invalid value is supplied, 1000 will be used instead.	Define this parameter in the request URI.
includeTotal	Flag indicating whether to include the total row count. Default value is false.	Define this parameter in the request URI.
sortColumn	The column to sort by. Allowable values are (LastConnected). The default sort column is LastConnected.	Define this parameter in the request URI.
sortDirection	The sort direction. Allowable values are (ASC\|DESC). The default direction is DESC.	Define this parameter in the request URI.

Response Information

A paged set of IOT devices.

Response body formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "PreviousPage": 1,
    "CurrentPage": 1,
    "NextPage": 1,
    "PageSize": 2,
    "TotalCount": 1,
    "ResultSet": [
      {
        "ID": 1,
        "Description": "sample string 2",
        "AuthType": "CLI|SharedCredentials|UserCredentials|Certificate",
        "Status": "Activation|Enabled|Disabled|Deleted",
        "UserID": 1
      },
      {
        "ID": 1,
        "Description": "sample string 2",
        "AuthType": "CLI|SharedCredentials|UserCredentials|Certificate",
        "Status": "Activation|Enabled|Disabled|Deleted",
        "UserID": 1
      },
      {
        "ID": 1,
        "Description": "sample string 2",
        "AuthType": "CLI|SharedCredentials|UserCredentials|Certificate",
        "Status": "Activation|Enabled|Disabled|Deleted",
        "UserID": 1
      }
    ]
  },
  "ErrorCode": 2,
  "ErrorDescription": "sample string 3",
  "Meta": "sample string 4"
}

text/javascript

Sample:

{"Success":true,"Data":{"PreviousPage":1,"CurrentPage":1,"NextPage":1,"PageSize":2,"TotalCount":1,"ResultSet":[{"ID":1,"Description":"sample string 2","AuthType":0,"Status":0,"UserID":1},{"ID":1,"Description":"sample string 2","AuthType":0,"Status":0,"UserID":1},{"ID":1,"Description":"sample string 2","AuthType":0,"Status":0,"UserID":1}]},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:

<PBNBReturnOfPagedListOfIOTDeviceLiteCA1DLPoZCA1DLPoZ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/pbnb_models">
  <Data>
    <CurrentPage>1</CurrentPage>
    <NextPage>1</NextPage>
    <PageSize>2</PageSize>
    <PreviousPage>1</PreviousPage>
    <ResultSet>
      <IOTDeviceLite>
        <AuthType>CLI|SharedCredentials|UserCredentials|Certificate</AuthType>
        <Description>sample string 2</Description>
        <ID>1</ID>
        <Status>Activation|Enabled|Disabled|Deleted</Status>
        <UserID>1</UserID>
      </IOTDeviceLite>
      <IOTDeviceLite>
        <AuthType>CLI|SharedCredentials|UserCredentials|Certificate</AuthType>
        <Description>sample string 2</Description>
        <ID>1</ID>
        <Status>Activation|Enabled|Disabled|Deleted</Status>
        <UserID>1</UserID>
      </IOTDeviceLite>
      <IOTDeviceLite>
        <AuthType>CLI|SharedCredentials|UserCredentials|Certificate</AuthType>
        <Description>sample string 2</Description>
        <ID>1</ID>
        <Status>Activation|Enabled|Disabled|Deleted</Status>
        <UserID>1</UserID>
      </IOTDeviceLite>
    </ResultSet>
    <TotalCount>1</TotalCount>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfPagedListOfIOTDeviceLiteCA1DLPoZCA1DLPoZ>

application/bson

Sample:

�SuccessDataiPreviousPageCurrentPageNextPagePageSizeTotalCountResultSet
0TIDDescriptionsample string 2AuthTypeStatusUserID1TIDDescriptionsample string 2AuthTypeStatusUserID2TIDDescriptionsample string 2AuthTypeStatusUserIDErrorCodeErrorDescriptionsample string 3Metasample string 4