Versions Compared

Old Version 72

changes.mady.by.user Mickey Bushman

Saved on

compared with

New Version Current

changes.mady.by.user Jason Andrew

Saved on

Key

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

Status
colourGreen
title3.18.0

The Followup WorkOrder REST API Interface defines the REST API interface which customers will need to implement if they would like ServiceMobility to book a follow-up work order via their own systems.

By implementing an API which matches the Followup WorkOrder REST API Interface, customers can configure ServiceMobility (via the Entity System Configuration object) so that requests to book a follow-up work order via the REST Standard REST APIs Book Job REST API are passed through to their system.

(info) Before being able to book a follow-up work order via their own systems, customers will also need to implement the REST Interfaces Appointment Search REST API Interface, so that the REST Standard REST APIs Appointment Search REST API will search open appointment slots via their own systems first, so that a slot can be selected, and then booked.


Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Request to book a new work order for the specified time slot

POST <REST Endpoint URI>

API Specific Parameters

ParameterDescription

{0}

ServiceMobility with replace the text {0} within the configured REST Endpoint URI with the value of the ${WorkOrderID} parameter from the initiating REST Standard REST APIs Book Job REST API call.

(warning) It is mandatory for the REST Endpoint URI to contain the text {0} within the URI at some point.

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

API Specifics


Panel
borderColor#D3D3D3

Request to book a new work order for the specified time slot

This REST API must request the booking of a new Work Order for an available appointment slot that has been obtained via the REST Standard REST APIs Appointment Search REST API, using the REST Interfaces Appointment Search REST API Interface.

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 Book Job Object.

HTTP Response

Response Codes

HTTP CodeDescription
200OK. The IVR message was sent successfully.
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 Book Job REST API.

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