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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "4d0201db-36f5-428b-8d11-4f0a65e960cc"
    ],
    "ServiceOrderIds": [
        "1dc0c6bf-2ce6-4a9f-af97-af5c01676720"
    ],
    "ServiceOrderNoteIds": [
        "a06a225b-00f7-48c8-a463-af5c016768e9"
    ],
    "Limitation": { "Count": 1 }
}

Response

{
    "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"
}

Service order

Service order note

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": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceOrderNotes": [
        {
            "ServiceOrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "Text": "Sample text"
        }
    ]
}

Service order note parameters

Response

{
    "ServiceOrderNotes": [
        {
            "Id": "a06a225b-00f7-48c8-a463-af5c016768e9",
            "ServiceOrderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "Text": "Sample text"
            "Type": "General",
            "CreatedUtc": "2022-11-29T21:48:32Z"
        }
    ]
}

Update service order notes

Updates one or more given service order notes with new text.

Request

[PlatformAddress]/api/connector/v1/serviceOrderNotes/update

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceOrderNoteUpdates": [
        {
            "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "Text": {
               "Value": "Sample text"
            }
        }
    ]
}

Service order note update parameters

Response

{
    "ServiceOrderNotes": [
        {
            "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ServiceOrderId": "1dc0c6bf-2ce6-4a9f-af97-af5c01676720",
            "Text": "Sample text",
            "Type": "General",
            "CreatedUtc": "2022-11-29T21:48:32Z"
        }
    ]
}

Delete service order notes

Deletes service order notes.

Request

[PlatformAddress]/api/connector/v1/serviceOrderNotes/delete

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ServiceOrderNoteIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    ]
}

Response

{}

Last updated