Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.0.0

The Account Location REST API is used to manage individual locations associated with an account. Account locations are always associated with an account and therefore are accessed starting from the account URL.

To retrieve a list of all locations for a specific account, use the REST Standard REST APIs Account Locations REST API


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Retrieve the details of a Location for a specific Account

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

Insert or Update the details of a Location for a specific Account

PUT /seiapi/v3/trans/Account/${AccountNum}/Location/${LocationID}

Delete a Location for a specific Account

DELETE /seiapi/v3/trans/Account/${AccountNum}/Location/${LocationID}

API Specific Parameters

ParameterDescription

${AccountNum}

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

Include Page
_Default HTTP Headers
_Default HTTP Headers
 



API Specifics


Panel
borderColor#D3D3D3

Retrieve the details of a Location for a specific Account

This 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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success, an HTTP response code of 200 will be returned, and the response body will contain an REST Object Definitions Account Location Related Objects Account Location ObjectOtherwise, on error, the response body will contain a descriptive reason for the error. 

Include Page
_Account Location Object Formats
_Account Location Object Formats


Panel
borderColor#D3D3D3

Insert or Update the details of a Location for a specific Account

This 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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /seiapi/v3/trans/Account/${AccountID}/Location/${LocationID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Account Location Related Objects Account Location Object

HTTP Response

On success the API will return an HTTP response code of 200. 


Panel
borderColor#D3D3D3

Delete a Location for a specific Account

This 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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

DELETE /seiapi/v3/trans/Account/${AccountID}/Location/${LocationID}

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent REST Object Definitions Account Location Related Objects Account Location Object.