Retrieve the details of a specific Asset

GET /seiapi/v3/Assets/${AssetNum}

Retrieve the Service History of a specific Asset

GET /seiapi/v3/Assets/${AssetNum}/History

Retrieve a list of all Assets

GET /seiapi/v3/query/Assets

Retrieve a list of Assets for a specific Account

GET /seiapi/v3/Account/${AccountNum}/Assets

Retrieve a list of Assets for a specific Location

GET /seiapi/v3/Location/${LocationNum}/Assets

Insert or Update the details of a specific Asset

PUT /seiapi/v3/Assets/${AssetNum}

Bulk Insert or Update the details of specific Assets

PUT /seiapi/v3/Assets

Bulk associate Assets and Locations

PUT /seiapi/v3/Location/${LocationNum}/Asset

Delete a specific Asset

DELETE /seiapi/v3/Assets/${AssetNum}

Retrieve the details of a specific Asset

This REST API will return an Asset with the specified ID. The Asset with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body.

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain an Asset Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

Retrieve the Service History of a specific Asset

This REST API will return the Service History of an Asset with the specified ID. The Asset with specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain a Service History Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

{
	"_t" : "assetHistory",
	"_v" : "1.0",
	"History": [
		{
			"Account": {
				"AccountNum": "", 
				"Name": ""
			},
    		"ActualEndDate": "",
    		"ActualStartDate": "",
    		"FlexAttrs": "",
    		"FlexForms": [
        		"${FlexFormID}"
    		],
			"Items": [],
			"Location": {
				"Address": {
            		"AddrLine1": "", 
            		"AddrLine2": "", 
            		"AddrLine3": "", 
            		"AddrLine4": "", 
            		"AddrType": "", 
            		"City": "", 
            		"Country": "", 
            		"Region": "", 
            		"Zip": ""
        		},
				"LocationNum": "",
				"Name": ""
			},
    		"Notes": [
        		{
            		"Author": "", 
            		"Date": "", 
            		"Text": ""
        		}
    		],
    		"OrderDate": "",
    		"OrderNum": "",
    		"OrderStatus": "",
    		"OrderSubStatus": "",
    		"OrderType": "",
    		"PrimaryUserName": "",
    		"ReasonCode": "",
    		"Rules": {
				"IsOps": true
			}
    		"ServiceCodes": [],
    		"Status": "",
    		"Type": "",
    		"UserName": ""
		}
	]
}

Retrieve a list of all Assets

This REST API will return a list of all Assets that exist in the system.

URL

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 a collection of Asset Objects.

 It is possible for the returned collection to be empty if the system does not have any Assets.

// A collection of zero or more Asset Objects.
[
    {
        // Asset Object
    },
    {
        // Asset Object
    },
    {
        // etc., as required
    }
]

Retrieve a list of Assets for a specific Account

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

URL

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 a collection of Asset Objects.

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

// A collection of zero or more Asset Objects.
[
    {
        // Asset Object
    },
    {
        // Asset Object
    },
    {
        // etc., as required
    }
]

Retrieve a list of Assets for a specific Location

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

URL

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 a collection of Asset Objects.

 It is possible for the returned collection to be empty if the Location does not have any Assets associated with it. 

// A collection of zero or more Asset Objects.
[
    {
        // Asset Object
    },
    {
        // Asset Object
    },
    {
        // etc., as required
    }
]

Insert or Update the details of a specific Asset

This REST API will insert a new Asset with the specified ID into the system, if an Asset with the specified ID does not already exist in the system.

If, however, the Asset with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Asset with the specified ID with the details of the Asset supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must contain a valid Asset Object.

HTTP Response

On success the API will return a response code of 200.

Bulk Insert or Update the details of specific Assets

This REST API will insert new Assets with the specified IDs into the system, if the Assets with the specified IDs do not already exist in the system.

If, however, the Assets with the specified IDs do already exist in the system, then this REST API will update (i.e. replace) the already existing Assets with the specified IDs with the details of the Assets supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must be a JSON array of one or more Asset Object definitions.

[
	{
		// Asset Object
	},
	{
		// Asset Object
	},
	{
		// etc., as required
	}
]

HTTP Response

On success the API will return a response code of 200.

Bulk associate Assets and Locations

URL

HTTP Request Body

The HTTP request body must be a JSON array of one or more Asset Object definitions.

[
	{
		// Asset Object
	},
	{
		// Asset Object
	},
	{
		// etc., as required
	}
]

HTTP Response

On success the API will return a response code of 200.

Delete a specific Asset

This REST API will delete an Asset with the specified ID from the system. The Asset with the specified ID must already exist in the system.

URL

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 Asset Object.