3.35.0

The Account Location Service History REST API Interface defines the REST API interface which customers will need to implement if they would like ServiceMobility to search Service History for a specific account location via their own systems.

By implementing an API which matches the Account Location Service History REST API Interface, customers can configure ServiceMobility (via the Entity System Configuration object) so that requests to search Account Location Service History for a specific asset via the Account Location Service History REST API are passed through to their system.

Before the Appointment Search REST API can be used for a given entity, it will be necessary to use the Entity System Configuration REST API to update the entity's Entity System Configuration Object and configure the RestApi.SiteHistory property, to define the REST Endpoint URI of an API that implements the Account Location History REST API Interface.

On this page:

Related pages:

Account Location REST API

Resource URL Summary

Retrieve the Service History for a specified Account Location matching search criteria

POST <REST Endpoint URI>?start=${start}&limit=${limit}

HTTP Headers

ServiceMobility will set both of the Standard HTTP Headers when calling this REST API Interface.

That is:

The Content-Type header will be set to application/json; and
The x-access-token header will be set to the JWT that was used in the call to the API that triggered ServiceMobility to call the configured endpoint that implements this interface.

The x-access-token header will either be the JWT issued by ServiceMobility, or by the endpoint that implements the Authentication REST API Interface that ServiceMobility has been configured to use.

Implementations of this interface may evaluate the JWT supplied, if required, but please note that ServiceMobility will have already authenticated the JWT in the initial API call before passing the call on to the configured endpoint.

Query Parameters

Parameter	Description
limit	Identifies the maximum number of objects to be returned.
start	Identifies the number of objects to be skipped. This is used for pagination and allows skipping previously returned objects.

API Specifics

Retrieve the Service History for a specified Account Location matching search criteria

This REST API must return a collection of zero or more Work Order Objects, based on the specified Account Location Service History Request Object.

URL

POST <REST Endpoint URI>?start=${start}&limit=${limit}

HTTP Request Body

The HTTP request body must contain a valid Account Location Service History Request Object.

HTTP Response

Response Codes

HTTP Code	Description
200	OK.
401	Invalid Logon.
500	Server error. An error occurred while processing the request. The HTTP response body should have more details as to the possible cause.

On success, an HTTP response code of 200 must be returned, and the response body must contain a valid response body that is the same as would be returned from the Account Location Service History REST API.

ServiceMobility will return the response code (and response body, if present) as the response to the initiating Account Location Service History REST API call.