POST /managedaccounts/actions/add
Adds a list of accounts for managed billing to a primary account. The managed accounts must then activate the service. The primary account will receive consolidated billing for all Device Location services used by the managed accounts.
See also:
About Aggregated Billing Services
Activate a managed service for an account
Cancel a managed service for an account
Get a list of managed accounts
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.
POST https://thingspace.verizon.com/api/subsc/v1/managedaccounts/actions/add
None.
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
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. |
Content-Type required |
string | Must be application/json . |
The body contains the the primary account name and list of account that you want to manage under the primary account.
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 service to manage. Must be “Location” for the Device Location Service. |
type required |
string | The SKU of the location service that was purchased by the primary account. |
managedAccList required |
array | List of accounts to be added to the primary account as managed accounts. These accounts will be added to any accounts that are already on the list. |
id
required |
strings | The name of an account to be managed. |
{
"accountName": "1234567890-00001",
"serviceName": "Location",
"type": "TS-LOC-COARSE-CellID-Aggr",
"managedAccList": [
"1223334444-00001",
"2334445555-00001",
"3445556666-00001"
]
}
Status 200
A success response contains a unique transaction ID for the request, plus the list and status of accounts that were added.
Parameter Name | Data Type | Description |
---|---|---|
TxId | string | Unique ID of this request. This ID must be used to activate each managed account that was added in this request. |
statusList | array | The list of added accounts, and the status of each one. |
id
|
string | The account name of a managed account that was in the request. |
status
|
string | The status of the add request for this account, either “Success” or “Fail”. |
reason
|
string | Either “Success” or additional information about a failure, such as “Invalid account name”. |
{
"TxId": "2c90bd28-ece4-42ef-9f02-7e3bd4fbff33",
"statusList": [
{
"id": "1223334444-00001",
"status": "Success",
"reason": "Success"
},
{
"id": "2334445555-00001",
"status": "Success",
"reason": "Success"
},
{
"id": "3445556666-00001",
"status": "Success",
"reason": "Success"
}
]
}
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.