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 8 Next »

3.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. 

On this page:

Related pages:

Resource URL Summary

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.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.

 

API Specifics

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

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 Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Format 
{
    "Address": {
        "AddrLine1": "", 
        "AddrLine2": "", 
        "AddrLine3": "", 
        "AddrLine4": "",
        "AddrType": "", 
        "City": "", 
        "Country": "", 
        "Intersection" : "",
        "Lat" : "",
        "Lon" : "",
        "Region": "", 
        "Zip": ""
    }, 
    "Contacts": [
        {
            "Email": "", 
            "FirstName": "", 
            "IsPrimary": true, 
            "LastName": "", 
            "Phones": [
                {
                    "PhoneNum": "", 
                    "PhoneType": ""
                }
            ]
        }
    ], 
	"Edited": false,
    "Email": "", 
	"Integrations": {
		"Financial": {
			"ID": "",
			"Extensions": {
				"": ""
			}
		}
	},
	"IsActive": true,
    "LanguageID": "", 
    "LocationNum": "", 
    "Name": "", 
    "Notes" : "",
    "POReq": false, 
    "ServiceAreaID": "",
    "SigReq": true, 
    "StorageLocationID": ""
}

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

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. 

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

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.

  • No labels