Workflow: Delete Guest Message

External system deletes a guest message from the PMS for an existing reservation.

Workflow Diagram


This image shows the sequence of the workflow.

Description of Steps:

  Description of Steps Operation
UC3.1

Use case: External system posts a new guest message to the PMS for a specific reservation checked in to store the message. The message will be available to show to the guest at reception.

Use the post guestMessages operation.

POST GuestMessage

New Guest Message

POST {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{reservationId}}/guestMessages

body: 

{
    "hotelId": "{{HotelId}}",
    "reservationIdList": {
        "type": "Reservation",
        "id": "{{reservationId}}"
    },
    "guestMessages": [
        {
            "message": {
                "messageText": "Dear Mr Guest, This message is a test",
                "messageDate": "2020-08-31 11:37:20.0",
                "typeOfMessage": "Tm",
                "recipient": "",
                "operator": "PBX System"
            },
            "delivery": {
                "deliveryStatus": "Nr",
                "textMessageSentBy": "PBX System"
            }
        }
    ]
}

201 response:

body: 

{
    "guestMessages": [
        {
            "message": {
                "messageText": "Dear Mr Guest, This message is a test",
                "messageDate": "2020-08-31 11:37:20.0",
                "typeOfMessage": "Tm",
                "operator": "PBX System",
                "reservationId": {
                    "type": "Reservation",
                    "id": "2783606"
                }
            },
            "delivery": {
                "deliveryStatus": "Nr",
                "textMessageSentBy": "PBX System"
            },
            "id": "347000"
        }
    ],
    "links": [
        {
            "href": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/guestMessages",
            "rel": "self",
            "templated": false,
            "method": "GET",
            "operationId": "getGuestMessages"
        },
        {
            "href": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/2783606/guestMessages/347000",
            "rel": "self",
            "templated": false,
            "method": "PUT",
            "operationId": "putGuestMessages"
        },
        {
            "href": "{{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/2783606/guestMessages/347000",
            "rel": "self",
            "templated": false,
            "method": "DELETE",
            "operationId": "deleteGuestMessages"
        }
    ]
}
UC3.2

Use case: External system deletes a guest message for an existing reservation.

Use the DELETE GuestMessages operation with the related Guest Message Id as received from OPERA Cloud.

Once OPERA Cloud receives a DELETE GuestMessages operation, the related Message will be deleted from the reservation and will not be visible anymore in OPERA Cloud.

DELETE GuestMessage

Delete Guest Message

DELETE {{HostName}}/rsv/v1/hotels/{{HotelId}}/reservations/{{reservationId}}/guestMessages/347000

Response 200 OK

Parent topic: Workflows