Get all service order notes
POST /api/connector/v1/serviceOrderNotes/getAll
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.
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.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of Service order. Reservation IDs or Order IDs can be used as service order identifiers.
Unique identifiers of Service order note. Use this property if you want to fetch specific service order notes.
Timestamp in UTC timezone ISO 8601 format when the service order note was updated.
object
Type of the service order note. Defaults to ["General", "ChannelManager"].
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ServiceOrderIds": [ "1dc0c6bf-2ce6-4a9f-af97-af5c01676720" ], "ServiceOrderNoteIds": [ "a06a225b-00f7-48c8-a463-af5c016768e9" ], "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "Limitation": { "Count": 100 }}Responses
Section titled “ Responses ”OK
object
The collection of service order notes.
object
Unique identifier of the service order note.
Unique identifier of the Service order to which the Service Order Note belongs.
Content of the service order note.
A discriminator specifying the type of service order note, e.g. general or channel manager.
General
ChannelManager
SpecialRequest
Creation date and time of the service order note in UTC timezone in ISO 8601 format.
Last update date and time of the service order note in UTC timezone in ISO 8601 format.
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.
Example
{ "ServiceOrderNotes": [ { "Id": "a06a225b-00f7-48c8-a463-af5c016768e9", "OrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720", "Text": "Shaken, not stirred.", "Type": "General", "CreatedUtc": "2022-11-29T21:48:32Z", "UpdatedUtc": "2022-11-30T12:36:37Z" } ], "Cursor": "a06a225b-00f7-48c8-a463-af5c016768e9"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.