Update service order notes
POST /api/connector/v1/serviceOrderNotes/update
Updates one or more given service order notes with new text.
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.
Notes to be updated.
object
Unique identifier of the Service order note
.
Content of the service order note (or null
if the content should not be updated).
object
Value which is to be updated.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ServiceOrderNoteUpdates": [ { "ServiceOrderNoteId": "a06a225b-00f7-48c8-a463-af5c016768e9", "Text": { "Value": "Shaken, not stirred." } } ]}
Responses
Section titled “ Responses ”OK
object
Updated 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.
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" } ]}
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.