Accounts

The following resources are applicable:

/accounts

Mount Point: /v2/accounts

GET

Returns the list of all the Accounts visible to the currently connected user.

Response Body

element: accountsResult
media types: application/xml
application/json

The list of requested Account objects.

POST

Creates a new Account based on the information provided in AccountCreator parameter.

Request Body

element: accountCreator
media types: application/xml

Provides the information for the new Account to be created.

Response Body

element: account
media types: application/xml

The newly created Account object.

/accounts/{accountId}

Mount Point: /v2/accounts/{accountId}

The following operations are supported on this resource:

GET

Returns the Account specified by the "id" path parameter.

Parameters

name description type default
accountId The id of the Account requested. path

Response Body

element: account
media types: application/xml
application/json

The requested Account object.

PUT

Updates the Account specified by the "id" path parameter based on the information provided in the Account parameter.

Parameters

name description type default
accountId The id of the Account to be updated. path

Request Body

element: account
media types: application/xml

The modified Account whose attributed need to be updated.

Response Body

element: account
media types: application/xml

The updated account.

DELETE

Deletes the Account specified by the "id" path parameter.

Parameters

name description type default
accountId The id of the Account to be deleted. path

/accounts/{accountId}/childAccounts

Mount Point: /v2/accounts/{accountId}/childAccounts

GET

Returns the list of all direct child accounts for the Account specified by the "id" path parameter.

Parameters

name description type default
accountId The id of the Account requested. path
recoursive (no documentation provided) query false

Response Body

element: accountsResult
media types: application/xml
application/json

The requested list of child accounts.

/accounts/{accountId}/devices/count

Mount Point: /v2/accounts/{accountId}/devices/count

GET

Returns the number of currently connected devices for the specified account.

Parameters

name description type default
accountId The id of the Account. path

Response Body

element: countResult
media types: application/xml
application/json

The requested DeviceCountResult object.

/accounts/{accountId}/servicePlan

Mount Point: /v2/accounts/{accountId}/servicePlan

GET

Returns the Service Plan for the Account specified by the "id" path parameter.

Parameters

name description type default
accountId The id of the Account for which the Service Plan is requested. path

Response Body

element: servicePlan
media types: application/xml
application/json

The requested AccountServicePlan object.

/accounts/{accountId}/usageByDay

Mount Point: /v2/accounts/{accountId}/usageByDay

GET

Returns the daily usage for the Account specified by the "id" path parameter.

Parameters

name description type default
accountId The id of the Account for which the usage is requested. path
limit Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 50
offset Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 0
startDate Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0

Response Body

element: accountUsageResult
media types: application/xml
application/json

The requested UsageResult object.

/accounts/{accountId}/usageByHour

Mount Point: /v2/accounts/{accountId}/usageByHour

GET

Returns the usage for the Account specified by the "id" path parameter.

Parameters

name description type default
accountId The id of the Account for which the usage is requested. path
limit Maximum number of entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 50
offset Starting offset for the entries to be returned. Note that an error will be returned if the maximum allowed value is exceeded. query 0
startDate Start date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no start date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0
endDate End date of the date range requested. The parameter is expressed as a long counting the number of milliseconds since January 1, 1970, 00:00:00 GMT. The default value of 0 means no end date. Alternatively, the date can be expressed as a string following the ISO 8601 format. query 0

Response Body

element: accountUsageResult
media types: application/xml
application/json

The requested UsageResult object.