Service order notes
Service order: This is the general name for an order made against a service, which includes both 'stay' service orders, called Reservations, and 'product' service orders, which we simply call Orders. Operations such as Get all service order notes will accept Reservation IDs or Order IDs as service order identifiers.
Get all service order notes
Returns all notes associated with the given service orders. Service orders can be reservations or product orders. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/serviceOrderNotes/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| array of string | required, max 1000 items | Unique identifiers of Service order. Reservation IDs or Order IDs can be used as service order identifiers. |
| array of string | optional, max 1000 items | Unique identifiers of Service order notes. Use this property if you want to fetch specific service order notes. |
| required | Limitation on the quantity of Service order notes returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Service order note | required | The collection of service order notes. |
| string | required | Unique identifier of the last and hence oldest service order note returned. This can be used in Limitation in a subsequent request to fetch the next batch of older service order notes. |
Service order
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the service order. |
Service order note
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the service order note. |
| string | required | Unique identifier of the Service order to which the Service Order Note belongs. |
| string | required | Content of the service order note. |
| string | required | A discriminator specifying the type of service order note, e.g. general or channel manager. |
| string | required | Creation date and time of the block in UTC timezone in ISO 8601 format. |
Service order note type
General
ChannelManager
...
Add service order notes
Adds one or more notes with a provided text to a specific service order. Service orders can be reservations or product orders.
Request
[PlatformAddress]/api/connector/v1/serviceOrderNotes/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Service order note parameters | required, max 1000 items | Notes to be added. |
Service order note parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Service order to which note will be added. |
| string | required, min 1 character | Content of the service order note. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Service order note | required | Added service order notes. |
Update service order notes
Updates one or more given service order notes with new text.
Request
[PlatformAddress]/api/connector/v1/serviceOrderNotes/update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Service order note update parameters | required, max 1000 items | Notes to be updated. |
Service order note update parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of Service order note. |
| string | required, min 1 character | Content of the service order note. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Service order note | required | Updated service order notes. |
Delete service order notes
Deletes service order notes.
Request
[PlatformAddress]/api/connector/v1/serviceOrderNotes/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of strings | required, max 1000 items | Unique identifiers of the service order notes to be deleted. |
Response
Last updated