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

List a paged set of APN devices

Request Information

Parameters

NameDescriptionAdditional 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 (Imsi|Number|Description|Status).
            The default sort column is Number (MSISDN).

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.

hasApnAccess
Flag indicating whether to filter out objects that have (have not) apn access

Define this parameter in the request URI.

Response Information

A paged set of APN 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,
        "UserID": 1,
        "Description": "sample string 2",
        "MSisdn": "sample string 3",
        "Imsi": "sample string 4",
        "LockIMEI": true,
        "IMEI": "sample string 6",
        "AuthType": "CLI",
        "Status": "Enabled",
        "OperatorName": "sample string 7",
        "OperatorCountry": "sample string 8",
        "APNName": "sample string 9",
        "RateLimits": {
          "Downstream": 1,
          "Upstream": 1
        }
      },
      {
        "ID": 1,
        "UserID": 1,
        "Description": "sample string 2",
        "MSisdn": "sample string 3",
        "Imsi": "sample string 4",
        "LockIMEI": true,
        "IMEI": "sample string 6",
        "AuthType": "CLI",
        "Status": "Enabled",
        "OperatorName": "sample string 7",
        "OperatorCountry": "sample string 8",
        "APNName": "sample string 9",
        "RateLimits": {
          "Downstream": 1,
          "Upstream": 1
        }
      },
      {
        "ID": 1,
        "UserID": 1,
        "Description": "sample string 2",
        "MSisdn": "sample string 3",
        "Imsi": "sample string 4",
        "LockIMEI": true,
        "IMEI": "sample string 6",
        "AuthType": "CLI",
        "Status": "Enabled",
        "OperatorName": "sample string 7",
        "OperatorCountry": "sample string 8",
        "APNName": "sample string 9",
        "RateLimits": {
          "Downstream": 1,
          "Upstream": 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,"UserID":1,"Description":"sample string 2","MSisdn":"sample string 3","Imsi":"sample string 4","LockIMEI":true,"IMEI":"sample string 6","AuthType":0,"Status":0,"OperatorName":"sample string 7","OperatorCountry":"sample string 8","APNName":"sample string 9","RateLimits":{"Downstream":1,"Upstream":1}},{"ID":1,"UserID":1,"Description":"sample string 2","MSisdn":"sample string 3","Imsi":"sample string 4","LockIMEI":true,"IMEI":"sample string 6","AuthType":0,"Status":0,"OperatorName":"sample string 7","OperatorCountry":"sample string 8","APNName":"sample string 9","RateLimits":{"Downstream":1,"Upstream":1}},{"ID":1,"UserID":1,"Description":"sample string 2","MSisdn":"sample string 3","Imsi":"sample string 4","LockIMEI":true,"IMEI":"sample string 6","AuthType":0,"Status":0,"OperatorName":"sample string 7","OperatorCountry":"sample string 8","APNName":"sample string 9","RateLimits":{"Downstream":1,"Upstream":1}}]},"ErrorCode":2,"ErrorDescription":"sample string 3","Meta":"sample string 4"}

application/xml, text/xml

Sample:
<PBNBReturnOfPagedListOfAPNDeviceCA1DLPoZCA1DLPoZ 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>
      <APNDevice>
        <APNName>sample string 9</APNName>
        <AuthType>CLI</AuthType>
        <Description>sample string 2</Description>
        <ID>1</ID>
        <IMEI>sample string 6</IMEI>
        <Imsi>sample string 4</Imsi>
        <LockIMEI>true</LockIMEI>
        <MSisdn>sample string 3</MSisdn>
        <OperatorCountry>sample string 8</OperatorCountry>
        <OperatorName>sample string 7</OperatorName>
        <RateLimits>
          <Downstream>1</Downstream>
          <Upstream>1</Upstream>
        </RateLimits>
        <Status>Enabled</Status>
        <UserID>1</UserID>
      </APNDevice>
      <APNDevice>
        <APNName>sample string 9</APNName>
        <AuthType>CLI</AuthType>
        <Description>sample string 2</Description>
        <ID>1</ID>
        <IMEI>sample string 6</IMEI>
        <Imsi>sample string 4</Imsi>
        <LockIMEI>true</LockIMEI>
        <MSisdn>sample string 3</MSisdn>
        <OperatorCountry>sample string 8</OperatorCountry>
        <OperatorName>sample string 7</OperatorName>
        <RateLimits>
          <Downstream>1</Downstream>
          <Upstream>1</Upstream>
        </RateLimits>
        <Status>Enabled</Status>
        <UserID>1</UserID>
      </APNDevice>
      <APNDevice>
        <APNName>sample string 9</APNName>
        <AuthType>CLI</AuthType>
        <Description>sample string 2</Description>
        <ID>1</ID>
        <IMEI>sample string 6</IMEI>
        <Imsi>sample string 4</Imsi>
        <LockIMEI>true</LockIMEI>
        <MSisdn>sample string 3</MSisdn>
        <OperatorCountry>sample string 8</OperatorCountry>
        <OperatorName>sample string 7</OperatorName>
        <RateLimits>
          <Downstream>1</Downstream>
          <Upstream>1</Upstream>
        </RateLimits>
        <Status>Enabled</Status>
        <UserID>1</UserID>
      </APNDevice>
    </ResultSet>
    <TotalCount>1</TotalCount>
  </Data>
  <ErrorCode>2</ErrorCode>
  <ErrorDescription>sample string 3</ErrorDescription>
  <Meta>sample string 4</Meta>
  <Success>true</Success>
</PBNBReturnOfPagedListOfAPNDeviceCA1DLPoZCA1DLPoZ>

application/bson

Sample:
�SuccessData3PreviousPageCurrentPageNextPagePageSizeTotalCountResultSet�0BIDUserIDDescriptionsample string 2MSisdnsample string 3Imsisample string 4LockIMEIIMEIsample string 6AuthTypeStatusOperatorNamesample string 7OperatorCountrysample string 8APNNamesample string 9RateLimits#DownstreamUpstream1BIDUserIDDescriptionsample string 2MSisdnsample string 3Imsisample string 4LockIMEIIMEIsample string 6AuthTypeStatusOperatorNamesample string 7OperatorCountrysample string 8APNNamesample string 9RateLimits#DownstreamUpstream2BIDUserIDDescriptionsample string 2MSisdnsample string 3Imsisample string 4LockIMEIIMEIsample string 6AuthTypeStatusOperatorNamesample string 7OperatorCountrysample string 8APNNamesample string 9RateLimits#DownstreamUpstreamErrorCodeErrorDescriptionsample string 3Metasample string 4