GET v1/accounts/{foreignaccountkey}/networks/{foreignkey}/devices/iots/{deviceid}/datacontrolgroup

Get the Data Control Group name for this individual device.

Request Information

URI Parameters

Name	Description	Type	Additional information
foreignaccountkey	The Api Account the IOT device is on	string	Required
foreignkey	The network on the account IOT APN device is on	string	Required
deviceid	The unique device id supplied during IOT device creation	string	Required

Body Parameters

None.

Response Information

Resource Description

The control group name for the IOT device if found, otherwise a failure result with a 404 error code

PBPRReturnOfDataControDetails

Name	Description	Type	Additional information
Data		DataControDetails	None.
Success	Gets the success status of the API call	boolean	None.
Meta	Gets the optional meta-data	Dictionary of string [key] and string [value]	None.
Code	Get the http code of the API call e.g. 200, 202, 409	integer	None.
ErrorCode	Get the failure error code of the API call. This is available if Success is false	integer	None.
ErrorSubCode	Gets the error sub code if available	integer	None.
ErrorDescription	Gets a textual description of the error	string	None.
StatusUrl	Gets the status url for any ACCEPTed API commands. Any command (POST,DELETE,PATCh,PUT) to the API usually returns a 202 response code. The status of the command can be queried using the URL provided	string	None.
ContinuationToken	Gets the token to be used for paged queries	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Meta": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Code": 2,
  "ErrorCode": 3,
  "Data": {
    "GroupName": "sample string 1",
    "LocalPolicy": {
      "RateLimitDownstream": 1,
      "RateLimitUpstream": 1
    }
  },
  "ErrorSubCode": 4,
  "ErrorDescription": "sample string 5",
  "StatusUrl": "sample string 6",
  "ContinuationToken": "sample string 7"
}

application/xml, text/xml

Sample:

<PBPRReturnOfDataControDetails7NMnQmOk xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AS.Models.API">
  <Code>2</Code>
  <ContinuationToken>sample string 7</ContinuationToken>
  <ErrorCode>3</ErrorCode>
  <ErrorDescription>sample string 5</ErrorDescription>
  <ErrorSubCode>4</ErrorSubCode>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <StatusUrl>sample string 6</StatusUrl>
  <Success>true</Success>
  <Data>
    <GroupName>sample string 1</GroupName>
    <LocalPolicy>
      <RateLimitDownstream>1</RateLimitDownstream>
      <RateLimitUpstream>1</RateLimitUpstream>
    </LocalPolicy>
  </Data>
</PBPRReturnOfDataControDetails7NMnQmOk>