Resource URL Summary
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
Retrieve the details of a Location for a specific Account
Insert or Update the details of a Location for a specific Account
Delete a Location for a specific Account
|
API Specific Parameters
| Parameter | Description |
|---|---|
| Identifies the REST Object Definitions Account Location Related Objects Account Object. |
${LocationID} | Identifies the Account Location Object. |
| Include Page | ||||
|---|---|---|---|---|
|
API Specifics
| Panel | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Retrieve the details of a Location for a specific AccountThis REST API will return a Location with the specified ID, for the Account with the specified ID. The Location with the specified ID and the Account with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success, an HTTP response code of 200 will be returned, and the response body will contain an Account Location Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
|
| Panel | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
Insert or Update the details of a Location for a specific AccountThis REST API will insert a new Location with the specified ID, for the Account with the specified ID, into the system, if a Location with the specified ID does not already exist in the system for the Account with the specified ID. If, however, the Location with the specified ID, for the Account with the specified ID, does already exist in the system, then this REST API will update (i.e. replace) the already existing Location with the specified ID, for the Account with the specified ID, with the details of the Location supplied in the HTTP Request Body. URL
HTTP Request BodyThe HTTP request body must contain a valid Account Location Object. HTTP ResponseOn success the API will return an HTTP response code of 200. |
| Panel | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
Delete a Location for a specific AccountThis REST API will delete a Location with the specified ID, for the Account with the specified ID, from the system. The Location with the specified ID and the Account with the specified ID must already exist in the system. URL
HTTP Request BodyThis request does not require a request body. HTTP ResponseOn success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent Account Location Object. |