Inquire device details & status
Version 4.0.0
Endpoint
GET
undefined/resource
Copy
This operation retrieves Resource entities - device details. (TMF 639)
oauth2
Get a JWT Token from AT&T's Azure AD
authorizationCode:
scopes:
tokenUrl:https://login.microsoftonline.com/xxxxxxxxx/oauth2/v2.0/token
authorizationUrl:https://login.microsoftonline.com/xxxxxxxxxx/oauth2/v2.0/token
Query Parameters
- @typestringRequiredEnum: [MobileDevice]This represent type of model
- deviceDetails.modestringEnum: [C, H, D, S, A, T, DU]Comma-separated properties to provide in response
- resourceRelationship.idstringUse for Subscriber NumberPattern: \d{10}$
- resourceRelationship.@typestringEnum: [MSISDN]This represent resource Relationshiptype of model
- idstringUse for SIM IMEI number. Required for mode A and mode TPattern: ^[0-9]+$Length: 15
- fieldsstringEnum: [deviceDetails, deviceStatusDetails]Fields is used to indicate which object’s details will be returned
- billingMarketstringIf mode D or T are sent or imeiTypeDetailsIndicator is True, then this should be populated.Pattern: [A-Z]{3}$
- billingSubMarketstringPattern: [A-Z0-9]{2,3}$
- localMarketstringContains the Market from which the NBI Customer was migrated
- deviceDetails.partnerIdstring
- deviceDetails.imeiSKURequireFlagstringEnum: [D, T, B]Indicates if the client requested to call for dlc data or tlg data or both. Valid Values D – requested for dlc call T – requested for Telegence call B – requested for both
- deviceDetails.sourceTypestringRequired when requested for biller or network imei or both
- deviceDetails.imeiTypeDetailsIndicatorbooleanSet True to request IMEITypeDetails information to be returned with mode H or C. IMEITypeDetails is returned by default with mode T and D.
- deviceDetails.softwareVersionstringUsed with IMEI to return a specific IMEI Type, LTE Type and Device Capability for the requested software version
Header Parameters
- AuthorizationstringRequiredJWT Bearer Token. Token URL: https://login.microsoftonline.com/xxxxxxxxx/oauth2/v2.0/token See example below. curl --location --request POST 'https://login.microsoftonline.com/xxxxxxxx/oauth2/v2.0/token' --header 'Content-Type: application/x-www-form-urlencoded' --header 'Cookie: fpc=Aswi39iZZIlGtxxxxxxxxxgOAAAA; stsservicecookie=estsfd; x-ms-gateway-slice=estsfd' --data-urlencode 'scope=api://testHarnessCustomersStage1/.default' --data-urlencode 'grant_type=client_credentials' --data-urlencode 'client_id=xxxxx-xxxxxx' --data-urlencode 'client_secret=k_xxxxxx__e.xxxxx' Note: client id/secret are not the right ones - contact API provider, via 'Request Access' button to get the correct on
- x-att-clientIdstring
- x-att-conversationIdstring
- x-att-correlationIdstring
Body Parameters
Responses
Success
Body
application/json