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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
ServiceOrderIds
array of string
required, max 1000 items
ServiceOrderNoteIds
array of string
optional, max 1000 items
Limitation
required
Limitation on the quantity of Service order notes returned.
Response
ServiceOrderNotes
required
The collection of service order notes.
Cursor
string
required
Service order
Id
string
required
Unique identifier of the service order.
Service order note
Id
string
required
Unique identifier of the service order note.
ServiceOrderId
string
required
Text
string
required
Content of the service order note.
Type
string
required
CreatedUtc
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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceOrderNotes
required, max 1000 items
Notes to be added.
Service order note parameters
ServiceOrderId
string
required
Text
string
required, min 1 character
Content of the service order note.
Response
ServiceOrderNotes
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
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceOrderNoteUpdates
required, max 1000 items
Notes to be updated.
Service order note update parameters
ServiceOrderNoteId
string
required
Text
string
required, min 1 character
Content of the service order note.
Response
ServiceOrderNotes
required
Updated service order notes.
Delete service order notes
Deletes service order notes.
Request
[PlatformAddress]/api/connector/v1/serviceOrderNotes/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ServiceOrderNoteIds
array of strings
required, max 1000 items
Unique identifiers of the service order notes to be deleted.
Response
Last updated