Service Provider: Create Annotation
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 case. Provision for the following data elements or fields should be made accordingly:
- Id (string, optional) - The service provider's unique identifier for the annotation.
- Case Number (string, required) - The customer FMS' unique identifier for the case.
- Repair Order Number (string, optional): The service provider's unique identifier for the RO corresponding with the case to which the annotation is 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.
- Annotation Text (multi-line string, required) - The content of the Annotation.
- 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.
- Recipient (string, optional) - The party that the message is addressing. This field is informational only; the annotation is delivered to all parties regardless of the recipient value. An example of this usage may be a service provider user posing a question for the customer. The user would set `Customer' as the recipient for the annotation, but all parties would be able to see the annotation.