Versions Compared

Old Version 67

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Mickey Bushman

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space MOBUD and version 3


Status
colourGreen
title3.35.0

The Asset 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 asset via their own systems.

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

Note

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Retrieve the Service History for a specified Asset matching search criteria

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

Include Page
_Default HTTP Headers for Interfaces
_Default HTTP Headers for Interfaces

Include Page
_URI Default Paging Parameters
_URI Default Paging Parameters

API Specifics

Panel
borderColor#D3D3D3

Retrieve the Service History for a specified Asset matching search criteria

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

HTTP Request Body

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

HTTP Response

Response Codes

HTTP CodeDescription
200OK.
401Invalid Logon.
500Server 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 Assets Service History REST API.

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