subscriptions/short_name

The subscriptions/short_name URI manipulates a web service subscription record.

URI path

subscriptions/short_name

Subscription configuration records

Subscription configuration records include:

uri: The URI of the element to be delivered.
buffer: The buffering policy for the subscription, which can include:
- queue: If the Event Channel is closed, updates are placed in the Event Channel delivery queue.
- discard: Messages are discarded if the event channel is closed.
interval: The number of seconds between updates. This must be an integer greater than zero.

Supported request methods

GET

Queries the system for the record associated with the specified short name, which is supplied by the user when the record is first stored in the device.

PUT

If the requested record does not yet exist, adds a new record with the requested URI to the system. If the requested record already exists in the system, the existing record is modified to match the supplied record data.

DELETE

Removes the specified record from the system.

Supported content types

XML

The GET and PUT forms use a subscription record. For example:

<subscription>
         <uri>vehicle/data/EngineSpeed</uri>
          <buffer>queue</buffer>
          <interval>10</interval>
</subscription>

JSON

The GET and PUT forms create an object assigned to a subscription field. In PUT requests, numeric fields need not be quoted, but GET responses feature all fields and values as quoted strings, regardless of type. For example:

{ “subscription” : { “uri” :  “vehicle/data/EngineSpeed”,
                     “buffer” :  “queue”, “interval” : “10” }}