General
As customer you can add comments to your assignment. This requires your assignment to have a value for CustomerReference.
Specification
Endpoint route: POST /assignments/{customerReference}/comment
TEST
Open-api specification: https://berger.test.assistanceonline.nl/api/assignments-external/v2/swagger/v1/swagger.json
Swagger-ui: https://berger.test.assistanceonline.nl/api/assignments-external/v2/swagger/
PROD
Open-api specification: https://berger.assistanceonline.nl/api/assignments-external/v2/swagger/v1/swagger.json
Swagger-ui: https://berger.assistanceonline.nl/api/assignments-external/v2/swagger/
XSD
| View file | ||
|---|---|---|
|
| View file | ||
|---|---|---|
|
Example message
| View file | ||
|---|---|---|
|
Models
AddCommentRequest
General set of fields, describing the general completion characteristics.
Element | Description | Type | Mandatory | Example |
|---|---|---|---|---|
Receiver | Identifier of the sender (customer) of the original order | String | Yes | Van Eijck |
Sender | Unique AO identifier for the towing company | String | Yes | tenant-1 |
CustomerReference | Unique reference from the customer | String | Yes | S34897 |
Comment | Comment given by the towing company when the order is completed | String | Yes | Please call the driver when you are en route. |
Author | The author of this comment | String | No | Remco |
AddCommentResponse
Element | Description | Type | Mandatory | Example |
|---|---|---|---|---|
Success | Indicator if the request has been processed successfully | Boolean | Yes | true |
Result | Textual result representation | String | Yes | InProgress |
ReasonNoSuccess | Not used in this context | String | No |
|