Customer/Fleet Management: Create Annotation

In this situation, the service provider submits a POST message to this web service endpoint to notify the customer FMS that a new annotation has been added to a RO/Case.

NOTE: To ensure lean network traffic and overhead, TMC recommends that the events to be reported should first be grouped and accumulated by the customer FMS for a pre-defined duration or maximum number of events (whichever is reached first). Each group should then be posted to its appropriate customer FMS. The customer FMS submits a POST message to this web service endpoint to notify the service provider that a new annotation has been added to a RO/Case. TMC recommends that the REST standard is to be used because the REST technology is newer and preferred over the older Simple Object Access Protocol (SOAP) specification.

Provision for the following data elements or fields should be made accordingly:

ID (string, optional) - The service provider's unique identifier for the annotation.
RO/Case Number (string, required) - The service provider's unique identifier for the RO to which the annotation is added.
Case Number (string, optional) - The customer FMS' unique identifier for the case corresponding with the RO/Case to which the annotation was added.
Created On (date/time, required) - The date/time that the annotation was added to the RO/Case.
Created By (string, optional) - The display name of the user who created the annotation.
NOTE: For Annotation Text (multi-line string, required), UTF8 should be the standard.
Is Action Required? (Boolean, optional) - An indicator for whether the user who created the annotation is expecting some form of response from the recipient party.

NOTE: When it comes to approving individual job lines for estimates, TMC recommends that solution developers specify a predefined action required if possible within the workflow, (e.g., "Please approve attached estimate." "Please provide a purchase order number." "Call for repair to continue." "Please verify what time the vehicle will be picked up.")

NOTE: Each software vendor's system capabilities will be different. If systems can support line item approval, then the API should support that process. Automation should be employed when possible. For example, approval of a specific dollar amount is needed. Whenever something new has developed or is found during the service event, authorization is required. (About 50 percent of the time, authorizations are required for this reason.) A process of "re-approval" should be supported if the software vendor's system can support this process.

Recipient (string, optional) - The party that the message is addressing. Note that the annotation is delivered to all parties regardless of recipient.