Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

3.0.0

This API returns all of the locations associated with the specified account. This API only supports the GET method. To manage individual account locations use the REST Standard REST APIs Account Location REST API.

Resource URL Summary

Retrieve a list of all Account Locations for a specific Account

GET /seiapi/v3/trans/Account/${AccountNum}/Location

API Specific Parameters

ParameterDescription
${AccountNum}Identifies the REST Object Definitions Account Location Related Objects Account Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

 


API Specifics

Retrieve a list of Account Locations for a specific Account

This REST API will return a list of all Account Locations associated with the Account with the specified ID. The Account with the specified ID must already exist in the system.

URL

GET /seiapi/v3/trans/Account/${AccountID}/Location

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success, an HTTP status code of 200 will be returned, and the response body will contain a collection of Account Location Objects associated with the Account. 

(warning) It is possible for the returned collection to be empty if the Account does not have any Account Locations associated with it. 

HTTP Response Body
{
	"Locations" : [
		// A collection of zero or more location object.
	]
}
  • No labels