Getting the status of all PINs for a customer account

Request

To get the status of all the PINs for a customer account, send a GET request to:

http://<server>:<port>/adm/v1/accounts/{accountId}/pins/status

Headers

• Content-Type: application/json

• Authorisation

• nv-tenant-id

Mandatory arguments

• accountId – the URL of the account (in URL)

Other arguments

None

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

A forbidden request returns an HTTP 403 status.

If the account does not exist, the request returns an HTTP 404 status.

Example

A successful request returns a response like this. The array will contain one item for each defined PIN type.

{
  "totalRecords": 1,
  "resourceSet": [
    {
      "pinType": "Parental",
      "status": "UNSET",
      "extendedStatus": "MANDATORY",
      "lockTimeRemaining": 20
    }
  ]
}

Here:

• pinType is the defined type for the PIN.

• status is the PIN status. It can be one of:
  UNSET SET LOCKED 

• extendedStatus indicates whether the PIN is MANDATORY or OPTIONAL.

• lockTimeRemaining is the time remaining until the user can try entering the PIN again (in seconds).

See also

For full details of this API, see the Account and Device Manager (ADM) API documentation.