Versions Compared

Key

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

Status
colourGreen
title3.18.0

The Parts Ordering REST API Interface defines the REST API interface which customers will need to implement if they would like ServiceMobility to create parts orders via their own systems.

By implementing an API which matches the Parts Ordering REST API Interface, customers can configure ServiceMobility (via the Entity System Configuration object) so that part orders made via the REST Standard REST APIs Parts Ordering REST API are passed through to their system.


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Submit a Parts Order

POST <REST Endpoint URI>

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


API Specifics


Panel
borderColor#D3D3D3

Submit a Parts Order

This REST API must accept a parts order requested via the REST Standard REST APIs Parts Ordering REST API, and order the required parts (when possible).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

POST <REST Endpoint URI>

HTTP Request Body

The HTTP request body will contain a valid REST Object Definitions Work Order Activity Related Objects Parts Ordering Object.

HTTP Response

Response Codes

HTTP CodeDescription
200OK. The parts order has been processed. (Does not necessarily mean parts have been ordered - see possible response object Status values.)
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 REST Standard REST APIs Parts Ordering REST API.

ServiceMobility will return the response code (and response body, if present) as the response to the initiating REST Standard REST APIs Parts Ordering REST API call.