Related Topics
In a REST API, each resource has its own address or URI. Resource URIs are returned in the response body of any create/update (POST/PUT) operation and in some list and read operations (GET). The element name will follow the pattern of THING-URI, where THING is a topic, category, subscriber, subscriber question, etc. This URI is the correct path for performing a GET operation for the resource and may also be appropriate for POST, PUT, or DELETE operations as well.
Identifiers for a resource will also be returned by any create/update operations as a <to-param> field. This is the identifier used in the construction of a particular resource's URI. For example, the resource identifier for a topic is the topic's code.
You can see both URIs and Identifiers in the example below:
<topics type='array'>
<topic>
<to-param>TOPIC_1</to-param>
<link rel="self" href="/api/account/ACCOUNT_CODE/topics/TOPIC_1" />
</topic>
<topic>
<to-param>TOPIC_2</to-param>
<link rel="self" href="/api/account/ACCOUNT_CODE/topics/TOPIC_2" />
</topic>
</topics>
Related Topics
Was this page helpful? Can't find what you need? Let us know
