Jump to

• Request
• Response

Create guest message

post

/spms/v2/ships/{shipId}/reservations/{reservationId}/guestMessages

This is to create a guest message and link to a specified reservation.

Request

Supported Media Types

• application/json

Path Parameters

• reservationId(required): number
  Reservation Id
• shipId(required): number
  Ship Id

Body ()

Guest Message Post Object

Root Schema : guestMessagePOSTObject

Type: object

Guest Message POST Object

Show Source

• effectiveDate: string(date)
  Effective Date

  Example: 2024-07-07T00:00:00.0
• expiryDate: string(date)
  Expiry Date

  Example: 2024-07-07T00:00:00.0
• messageAcknowledgementType: number
  Allowed Values: [ "0", "1", "2", "3" ]

  Indicates message acknowledgement Type. 0 stands for No Acknowledgement, 1 stands for User Acknowledgement with log, 2 stands for Manager Acknowledgement with log, 3 stands for Do not allow to continue with log

  Example: 3
• messageDeliveryType: number
  Allowed Values: [ "0", "1", "2", "3", "4" ]

  Indicates the message delivery type. 0 stands for No delivery, 1 stands Delivery during check-In, 2 stands for Delivery at gangway, 3 stands for Delivery at internal gate, 4 stands for Delivery at immigration gate

  Example: 4
• messageText: string
  Pattern: ^[a-zA-Z0-9 _,\?/\.\-\\+\* ~!@#$%&{}\[\]()=<>\|\^\'\":;@`]*$

  Message Text

  Example: Overdue balance
• messageType: string
  Minimum Length: 0

  Maximum Length: 12

  This is to indicate the message field is confirmation type , information type or error type

  Example: confirmation,information,error
• senderName: string
  Pattern: ^[a-zA-Z0-9 _,\?/\.\-\\+\* ~!@#$%&{}\[\]()=<>\|\^\'\":;@`]*$

  Sender Name

  Example: Front Office

{
    "description":"Guest Message POST Object",
    "type":"object",
    "properties":{
        "senderName":{
            "$ref":"#/definitions/senderName"
        },
        "messageText":{
            "$ref":"#/definitions/messageText"
        },
        "messageDeliveryType":{
            "$ref":"#/definitions/messageDeliveryType"
        },
        "messageAcknowledgementType":{
            "$ref":"#/definitions/messageAcknowledgementType"
        },
        "messageType":{
            "$ref":"#/definitions/messageType"
        },
        "effectiveDate":{
            "$ref":"#/definitions/effectiveDate"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDate"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : guestMessageGETObject

Type: object

Guest Message GET Object

Show Source

• createdBy: string
  Created By

  Example: FOPolly Pipe
• createdDateTime: string(date-time)
  Example: 2015-09-09T16:00:00
• effectiveDate: string(date)
  Effective Date

  Example: 2024-07-07T00:00:00.0
• expiryDate: string(date)
  Expiry Date

  Example: 2024-07-07T00:00:00.0
• isLightStatus: string
  Allowed Values: [ true, false ]

  Light Status

  Example: true
• messageAcknowledgementType: string
  Allowed Values: [ "No Acknowledgement", "User Acknowledgement with log", "Manager Acknowledgement with log", "Do not allow to continue with log" ]

  Message Acknowledgement Type

  Example: Manager Acknowledgement with log
• messageDeliveredBy: number
  Message Delivery By

  Example: 999
• messageDeliveredDateTime: string(Date)
  Message Delivered DateTime

  Example: 2024-07-07T00:00:00.0
• messageDeliveryStatus: string
  Allowed Values: [ "Not Delivered", "Delivered" ]

  Indicates the message delivery status.

  Example: Delivered
• messageDeliveryType: string
  Allowed Values: [ "No delivery", "Delivery during check-In", "Delivery at gangway", "Delivery at internal gate", "Delivery at immigration gate" ]

  Message Delivery Type

  Example: No delivery
• messageId: number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Message Id

  Example: 1234567
• messageText: string
  Pattern: ^[a-zA-Z0-9 _,\?/\.\-\\+\* ~!@#$%&{}\[\]()=<>\|\^\'\":;@`]*$

  Message Text

  Example: Overdue balance
• messageType: string
  Allowed Values: [ "Standard", "Priority", "Silent" ]

  Message Type

  Example: Standard
• printedDateTime: string(date)
  Printed Date Time

  Example: 2024-07-07T00:00:00.0
• reservationId: number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Reservation Id

  Example: 1001
• senderName: string
  Pattern: ^[a-zA-Z0-9 _,\?/\.\-\\+\* ~!@#$%&{}\[\]()=<>\|\^\'\":;@`]*$

  Sender Name

  Example: Front Office

{
    "description":"Guest Message GET Object",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "messageId":{
            "$ref":"#/definitions/messageId"
        },
        "senderName":{
            "$ref":"#/definitions/senderName"
        },
        "messageText":{
            "$ref":"#/definitions/messageText"
        },
        "isLightStatus":{
            "$ref":"#/definitions/isLightStatus"
        },
        "messageDeliveryStatus":{
            "$ref":"#/definitions/messageDeliveryStatus"
        },
        "messageDeliveryType":{
            "$ref":"#/definitions/messageDeliveryTypeStr"
        },
        "messageAcknowledgementType":{
            "$ref":"#/definitions/messageAcknowledgementTypeStr"
        },
        "messageType":{
            "$ref":"#/definitions/messageTypeStr"
        },
        "effectiveDate":{
            "$ref":"#/definitions/effectiveDate"
        },
        "expiryDate":{
            "$ref":"#/definitions/expiryDate"
        },
        "printedDateTime":{
            "$ref":"#/definitions/printedDateTime"
        },
        "createdBy":{
            "$ref":"#/definitions/createdBy"
        },
        "createdDateTime":{
            "$ref":"#/definitions/createdDateTime"
        },
        "messageDeliveredBy":{
            "$ref":"#/definitions/messageDeliveredBy"
        },
        "messageDeliveredDateTime":{
            "$ref":"#/definitions/messageDeliveredDateTime"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Invalid parameter(s) passed in"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Invalid parameter(s) passed in"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Ship Id could not be found"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Allowed",
        "detail":"The method is not available"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Allowed",
    "detail":"The method is not available"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Unsupported Media Type",
        "detail":"Content type not supported"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Unsupported Media Type",
    "detail":"Content type not supported"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/guestMessageErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service not available"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service not available"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail: string
• title: string
• type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

Back to Top