Get Managed Account List

Get a list of managed accounts:
GET /managedaccounts/{accountName}/service/{servicename}/status/{status}

Returns a list of managed accounts for a primary account. The resource path specifies the type of service and the service status to use to filter the response.

NOTE: The accounts must be enabled for Aggregated Billing Services before you can use this request. See About Aggregated Billing Services for more information.

Contents

See also:
Activate a managed service for an account
Add accounts for managed billing
Cancel a managed service for an account

Uses and Requirements

This request must be sent with a VZ-M2M-Token created with the primary account’s UWS credentials.

NOTE: This method uses the /subsc/v1 basepath, not /loc/v1 used by other Device Location API requests.

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/subsc/v1/managedaccounts/{accountName}/service/{servicename}/status/{status}

Resource Path and Query Parameters

You must include the name of the primary account in the path, and the name of the managed service. You can optionally include /status and a service status to restrict the results to only managed accounts with that status.

Parameter Name Data Type Description
accountName
required
string The name of the primary billing account, which is usually in the format of 10 digits, a hyphen, and then five more digits. Must include any leading zeros.
serviceName
required
string The name of the managed service. Must be “Location” for the Device Location Service.
status
optional
string Account state filter:
  • ADD: managed accounts that have been added but not yet activated, or that have been cancelled.
  • PROVISION: managed accounts that have been aded and for which service has been activated.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization bearer token.
VZ-M2M-Token
required
string A valid session token returned by POST /api/m2m/v1/session/login using the primary account’s UWS credentials.

Request Body

None.

Success Responses

Status 200

A success response the primary account name and an array containing all of the requested managed accounts.

Parameter Name Data Type Description
accountName string The name of the primary account.
managedAccList array List of managed accounts
id
string The account name of the managed account.
TxId
string The unique transaction ID from the add or provision request, whichever is most recent.

Example Success Response

{
  "accountName": "2024009649-00001",
  "managedAccList": [ 
    {
      "id": "1223334444-00001",
      "TxId": "2c90bd28-ece4-42ef-9f02-7e3bd4fbff33"
    },
    {
      "id": "2334445555-00001",
      "TxId": "d4fbff33-ece4-9f02-42ef-2c90bd287e3b"
    }
  ]
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "The type of error, such as INVALID_REQUEST.",
  "errorMessage": "Additional error information."
}

Error codes and messages are listed on the Error Codes page, along with explanations and suggestions for corrective actions.

Try It Out!