Customer/Fleet Management: Repair Order/Case Created/Updated
In this situation, the service provider submits a POST message to this web service endpoint to notify the customer's FMS that an RO has been created or updated. Provision for the following data elements or fields should be made accordingly:
- Event Date/Time (date/time, required) - The date/time that the RO was created.
- Repair Order Number (string, required) - The service provider's unique identifier for the RO.
- Case Number (string, optional) - The customer FMS' unique identifier for the case corresponding with this RO. It is provided by the customer FMS through the service provider's Create Case web service endpoint (see below).
- Uniform Resource Identifer (URI) (string, required) - The URI for the web service end-point to retrieve the latest data for this RO/Case (see RO Detail).
NOTE:
An API is always less prone to high-traffic creation if there is no need for real-time actions submitted by local actions. Unless there is a need for real-time updates, a scheduled job or services can call the following requests on regular intervals as needed. This also means less development required to create the standard, and less effort to come into compliance. POST and GET terminology is used here to indicate the nature of a request. POSTS and GETS often handle one specific direction of query vs. another. It is common for API structures to handle multiple verbs for any given request to support flexibility of transactions. This is important when building the solution especially if it follows a representational state transfer (RESTful or REST) standard in development.
NOTE:
Regarding restriction limitations on data traffic, TMC recommends that developer solutions limit the data on GET - e.g., when gathering/requesting 300 R O/cases at a time. Snapshots of data are recommended versus sending all data since last transmission, as are use of appropriate VMRS codes. Security restrictions should be in place secure data integrity and guidelines implemented to restrict someone from pulling data for another location, maliciously or without proper user credentials and authority.