REST Operations and HTTP Mappings

All operations across all resources (primary and secondary) are on single instances of a resource, for example, a single device. To perform multiple operations in one transaction, use the MtxRequestMulti function.

Data Operations and REST HTTP Mappings lists the supported operations.

Table 1. Data Operations and REST HTTP Mappings
Operation Description REST HTTP Mapping
add Adds an existing resource to another resource. POST a resource with optional data.
create Creates a new resource in the system. POST a resource with optional data.
delete Removes a resource from the system. DELETE a resource from the system.
Note: The DELETE method is also used to remove the association of a device with a subscriber. In this case, the device object is not deleted from the database so it can be added to a new subscriber.
get Retrieves data for a specific resource. GET a resource.
deactivate Deactivates a resource in the system. DELETE a resource but it remains in the system for audit purposes.
query Search for an existing resource. GET a resource using a query string.
update Updates an existing resource. PUT a resource and data.

You can change most information in a resource including the ExternalId of a subscriber, group, and device. The Object ID and primary key cannot be changed.

Note: It is good practice to use a GET on a resource before a PUT. The GET retrieves the existing resource parameters. Your program can modify them and then send the modified resource parameters in a subsequent PUT call.