API Reference

Quick API Reference

This API reference is organized by functional area, which generally equates to resource type.

Find device locations

HTTP Request Description
POST /locations Find the locations of up to 20 devices (synchronous)
POST /locationreports Create a report of device locations (asynchronous)
GET /locationreports/{account}/report/{txid}/index/{startindex} Retrieve a device location report
GET /locationreports/{account}/report/{txid}/status Get the status of a device location report
DELETE /locationreports/{account}/report/{txid} Cancel a queued device location report
DELETE /devicelocations/{txid}?accountname={accountname} Cancel an asynchronous device location request.

Exclude devices from location services

HTTP Request Description
POST /consents Exclude or included devices from location services
GET /consents/{account} Get a list of excluded devices
DELETE /consents Removes devices from the exclusion list

Manage subscription status and usage

HTTP Request Description
GET /subscriptions/{account} Get location service subscription status
POST /usage Get Location Service Usage information for a specified period
POST /usage/triggers Create a new usage trigger
GET /usage/accounts/{accountName}/triggers
GET /usage/accounts/{accountName}/triggers/{triggerId}
Retrieve information about a trigger, or all triggers in an account
POST /usage/triggers/{triggerId} Change an existing trigger's settings.
DELETE /usage/accounts/{accountName}/triggers/{triggerId} Delete a specified trigger.

Receive callback messages

HTTP Request Description
POST /callbacks/{account} Register to receive callback messages
GET /callbacks/{account} View registered callback listener URLs
DELETE /callbacks/{account}/name/{service} Deregister a callback listener

Aggregated billing services

HTTP Request Description
POST /managedaccounts/actions/add Adds a list of account for managed billing to a primary account.
POST /managedaccounts/actions/provision Activates a managed billing service relationship between managed account and primary account
GET /managedaccounts/{accountName}/service/{servicename/status/{status} Returns a list of managed accounts for a primary account.
POST /managedaccounts/actions/cancel Deactivates a managed billing service relationship between managed account and the primary account.