Jump to

• Request
• Response

Update crew reservation

put

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

This is to update a crew reservation record.

Request

Supported Media Types

• application/json

Path Parameters

• reservationId(required): integer(int32)
  Minimum Value: 1

  Reservation Id
• shipId(required): number
  Ship Id

Body ()

Crew reservation request

Root Schema : crewReservationRequest

Type: object

Crew reservation request

Show Source

• berthNumber: string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[a-zA-Z0-9 ]+?$

  Berth Number

  Example: A
• cabinNumber: string
  Minimum Length: 1

  Maximum Length: 20

  Cabin Number

  Example: 12345
• denyBoardingFlag: boolean
  Deny Boarding Flag

  Example: true
• denyBoardingReason: string
  Maximum Length: 40

  Deny Boarding Reason

  Example: Passport Issue
• discountTemplate: object discountTemplate
  Discount Template
• disembarkationHarborComment: string
  Maximum Length: 20

  Disembarkation Harbor Comment

  Example: Going to the land
• embarkationHarborComment: string
  Maximum Length: 20

  Embarkation Harbor Comment

  Example: Going to the sea
• expectedDisembarkationDate(required): string(date)
  Expected Disembarkation Date

  Example: 2025-01-01
• expectedDisembarkationHarborCode(required): string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Expected Disembarkation Harbor Code

  Example: PQRST
• expectedEmbarkationDate(required): string(date)
  Expected Embarkation Date

  Example: 2024-01-01
• expectedEmbarkationHarborCode(required): string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Expected Embarkation Harbor Code

  Example: ABCDE
• extResId: string
  Minimum Length: 1

  Maximum Length: 50

  External Reservation Id

  Example: 12345678
• finNumber: string
  Maximum Length: 20

  FIN Number * `null` if empty

  Example: a1234
• guestCategories: array guestCategories
• lifeBoat: string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Life Boat Code

  Example: L1
• longShoremanWork: boolean
  Long Shoreman Work

  Example: true
• musterStation: string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Muster Station Code

  Example: M
• onboardEmail: string
  Minimum Length: 1

  Maximum Length: 72

  Pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-]+)(\.([a-zA-Z]{2,5})){1,}$

  Onboard Email Address

  Example: [e-mail]
• onboardStatus: boolean
  Onboard Status

  Example: true
• otherParameter: object otherParameter
  Other Parameter
• paymentDetails: object paymentDetails
  Payment Details
• pinCode: number
  Pincode

  Example: 1234
• profileInformation: object profileInformationRequest
  Profile information request
• reEmbarkationDate: string(date)
  Return Embarkation Date

  Example: 2024-01-01
• setSailPassNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Set Sail Pass Number

  Example: 1234
• shoreGId: string
  Minimum Length: 1

  Maximum Length: 15

  Shore G Id

  Example: 12345678

{
    "description":"Crew reservation request",
    "type":"object",
    "properties":{
        "guestCategories":{
            "$ref":"#/definitions/guestCategories"
        },
        "shoreGId":{
            "$ref":"#/definitions/shoreGId"
        },
        "extResId":{
            "$ref":"#/definitions/extResId"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "finNumber":{
            "$ref":"#/definitions/finNumber"
        },
        "expectedEmbarkationDate":{
            "$ref":"#/definitions/expectedEmbarkationDate"
        },
        "expectedEmbarkationHarborCode":{
            "$ref":"#/definitions/expectedEmbarkationHarborCode"
        },
        "expectedDisembarkationDate":{
            "$ref":"#/definitions/expectedDisembarkationDate"
        },
        "expectedDisembarkationHarborCode":{
            "$ref":"#/definitions/expectedDisembarkationHarborCode"
        },
        "reEmbarkationDate":{
            "$ref":"#/definitions/reEmbarkationDate"
        },
        "embarkationHarborComment":{
            "$ref":"#/definitions/embarkationHarborComment"
        },
        "disembarkationHarborComment":{
            "$ref":"#/definitions/disembarkationHarborComment"
        },
        "cabinNumber":{
            "$ref":"#/definitions/cabinNumber"
        },
        "berthNumber":{
            "$ref":"#/definitions/berthNumber"
        },
        "musterStation":{
            "$ref":"#/definitions/musterStationCode"
        },
        "lifeBoat":{
            "$ref":"#/definitions/lifeBoatCode"
        },
        "denyBoardingFlag":{
            "$ref":"#/definitions/denyBoardingFlag"
        },
        "denyBoardingReason":{
            "$ref":"#/definitions/denyBoardingReason"
        },
        "pinCode":{
            "$ref":"#/definitions/pinCode"
        },
        "longShoremanWork":{
            "$ref":"#/definitions/longShoremanWork"
        },
        "onboardStatus":{
            "$ref":"#/definitions/onboardStatus"
        },
        "discountTemplate":{
            "$ref":"#/definitions/discountTemplate"
        },
        "paymentDetails":{
            "$ref":"#/definitions/paymentDetails"
        },
        "otherParameter":{
            "$ref":"#/definitions/otherParameter"
        },
        "onboardEmail":{
            "$ref":"#/definitions/onboardEmail"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformationRequest"
        }
    },
    "required":[
        "expectedEmbarkationDate",
        "expectedEmbarkationHarborCode",
        "expectedDisembarkationDate",
        "expectedDisembarkationHarborCode"
    ]
}

Nested Schema : discountTemplate

Type: object

Discount Template

Show Source

• code: string
  Discount Template Code

  Example: LV2
• description: string
  Discount Template Description

  Example: Disc Template 2

{
    "description":"Discount Template",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/discountTemplateCode"
        },
        "description":{
            "$ref":"#/definitions/discountTemplateDescription"
        }
    }
}

Nested Schema : guestCategories

Type: array

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 6

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

  Guest Category Code

  Example: GCAT

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/guestCategoryCode"
    }
}

Nested Schema : otherParameter

Type: object

Other Parameter

Show Source

• isManifestPrintout: boolean
  Is Manifest Printout

  Example: true
• isNoticeAndConsent: boolean
  Acknowledge Notice and Consent

  Example: true
• isStayOvernightTour: boolean
  Is Stay Overnight Tour

  Example: true
• isSwitchToPassengerManifest: boolean
  Is Switch To Passenger Manifest

  Example: true

{
    "description":"Other Parameter",
    "type":"object",
    "properties":{
        "isManifestPrintout":{
            "$ref":"#/definitions/isManifestPrintout"
        },
        "isSwitchToPassengerManifest":{
            "$ref":"#/definitions/isSwitchToPassengerManifest"
        },
        "isStayOvernightTour":{
            "$ref":"#/definitions/isStayOvernightTour"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        }
    }
}

Nested Schema : paymentDetails

Type: object

Payment Details

Show Source

• paymentMethodCode: string
  Maximum Length: 10

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Payment Method Code

  Example: 1234
• paymentRemarks: string
  Maximum Length: 3000

  Payment Remarks

  Example: Example Payment Remark

{
    "description":"Payment Details",
    "type":"object",
    "properties":{
        "paymentMethodCode":{
            "$ref":"#/definitions/paymentMethodCode"
        },
        "paymentRemarks":{
            "$ref":"#/definitions/paymentRemarks"
        }
    }
}

Nested Schema : profileInformationRequest

Type: object

Profile information request

Show Source

• birthPlace: string
  Maximum Length: 50

  Birth Place * `null` if empty

  Example: KL
• crewPostId: string
  Minimum Length: 1

  Maximum Length: 15

  Crew Post ID

  Example: 12345678
• dateOfBirth: string(ISO 8601 (YYYY-MM-DD))
  Date Of Birth

  Example: 1999-02-15
• externalId: string
  Minimum Length: 1

  Maximum Length: 20

  Crew External ID

  Example: 12345678
• eyeColor: string
  Maximum Length: 20

  Eye Color

  Example: Brown
• firstName(required): string
  Minimum Length: 1

  Maximum Length: 40

  The first name of the guest

  Example: Kobe
• gender: string
  Gender Code

  Example: F
• hairColor: string
  Maximum Length: 20

  Hair Color

  Example: Black
• height: string
  Minimum Length: 0

  Maximum Length: 10

  Height

  Example: 190
• internalId: string
  Minimum Length: 1

  Maximum Length: 20

  Crew Internal ID

  Example: 12345678
• isIntoxication: boolean
  Is Intoxication

  Example: true
• isSmoker: boolean
  Is Smoker

  Example: true
• lastName(required): string
  Minimum Length: 1

  Maximum Length: 40

  The last name of the guest

  Example: James
• maritalStatus: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9 ]{1,6}$

  Marital Status Code

  Example: D
• middleName: string
  Minimum Length: 1

  Maximum Length: 20

  The middle name of the guest

  Example: Bean
• nationality: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Nationality Code

  Example: MY
• nationId: string
  Minimum Length: 1

  Maximum Length: 20

  Nation Id

  Example: 123456
• orderEmpNo: number
  Order Employee Number

  Example: 12345678
• otherFirstName: string
  Other First Name

  Example: Mäya
• otherLastName: string
  Other Last Name

  Example: Wälters
• passportIssuedCountry: string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Passport Issued Country Code

  Example: MY
• passportIssuedDate: string(ISO 8601)
  Passport Issued Date

  Example: 2009-10-31
• passportIssuedExpiryDate: string(date)
  Passport Issued Expiry Date

  Example: 2026-11-11
• passportIssuedPlace: string
  Maximum Length: 50

  Passport Issued Place

  Example: Shah Alam
• passportNumber: string
  Passport Number

  Example: A1510202
• salutation: string
  Minimum Length: 1

  Maximum Length: 20

  The salutation of the guest

  Example: Mr.
• seamanBookExpiryDate: string(date)
  Seaman Book Expiry Date

  Example: 2025-11-11
• seamanBookIssuedCountry: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Seaman Book Issued Country Code

  Example: MY
• seamanBookIssuedDate: string(ISO 8601)
  Seaman Book Issued Date

  Example: 2009-10-31
• seamanBookIssuedPlace: string
  Minimum Length: 1

  Maximum Length: 50

  Passport Issued Place

  Example: Kuala Lumpur
• seamanBookNumber: string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Seaman Book Number

  Example: ABC12345678
• title: string
  Title

  Example: Countess
• weight: number
  Weight

  Example: 70

{
    "description":"Profile information request",
    "type":"object",
    "properties":{
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "title":{
            "$ref":"#/definitions/title"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "gender":{
            "$ref":"#/definitions/genderCode"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationality":{
            "$ref":"#/definitions/nationalityCode"
        },
        "nationId":{
            "$ref":"#/definitions/nationId"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "hairColor":{
            "$ref":"#/definitions/hairColor"
        },
        "eyeColor":{
            "$ref":"#/definitions/eyeColor"
        },
        "height":{
            "$ref":"#/definitions/height"
        },
        "weight":{
            "$ref":"#/definitions/weight"
        },
        "isSmoker":{
            "$ref":"#/definitions/isSmoker"
        },
        "isIntoxication":{
            "$ref":"#/definitions/isIntoxication"
        },
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/passportIssuedCountryCode"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatusCode"
        },
        "seamanBookNumber":{
            "$ref":"#/definitions/seamanBookNumber"
        },
        "seamanBookIssuedDate":{
            "$ref":"#/definitions/seamanBookIssuedDate"
        },
        "seamanBookExpiryDate":{
            "$ref":"#/definitions/seamanBookExpiryDate"
        },
        "seamanBookIssuedPlace":{
            "$ref":"#/definitions/seamanBookIssuedPlace"
        },
        "seamanBookIssuedCountry":{
            "$ref":"#/definitions/seamanBookIssuedCountryCode"
        },
        "externalId":{
            "$ref":"#/definitions/externalId"
        },
        "internalId":{
            "$ref":"#/definitions/internalId"
        },
        "crewPostId":{
            "$ref":"#/definitions/crewPostId"
        },
        "orderEmpNo":{
            "$ref":"#/definitions/orderEmpNo"
        }
    },
    "required":[
        "lastName",
        "firstName"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Updated

Body ()

Root Schema : crewReservationResponse

Type: object

Crew Reservation response

Show Source

• actualEmbarkationDate: string(date)
  Actual Embarkation Date

  Example: 2024-01-01
• actualEmbarkationHarbor: string
  Actual Embarkation Harbor

  Example: DUBAI
• assign: string
  Assign

  Example: A
• berthNumber: string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[a-zA-Z0-9 ]+?$

  Berth Number

  Example: A
• boardCardNumber: string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9 ]+?$

  Board Card Number

  Example: 12345678
• bookingNumber: string
  Minimum Length: 1

  Maximum Length: 100

  Booking Number

  Example: 12345678
• cabinNumber: string
  Minimum Length: 1

  Maximum Length: 20

  Cabin Number

  Example: 12345
• denyBoardingFlag: boolean
  Deny Boarding Flag

  Example: true
• denyBoardingReason: string
  Maximum Length: 40

  Deny Boarding Reason

  Example: Passport Issue
• discountTemplate: object discountTemplate
  Discount Template
• disembarkationHarborComment: string
  Maximum Length: 20

  Disembarkation Harbor Comment

  Example: Going to the land
• embarkationHarborComment: string
  Maximum Length: 20

  Embarkation Harbor Comment

  Example: Going to the sea
• expectedDisembarkationDate: string(date)
  Expected Disembarkation Date

  Example: 2025-01-01
• expectedDisembarkationHarbor: string
  Expected Disembarkation Harbor

  Example: DUBAI
• expectedEmbarkationDate: string(date)
  Expected Embarkation Date

  Example: 2024-01-01
• expectedEmbarkationHarbor: string
  Expected Embarkation Harbor

  Example: NEW YORK CITY
• extResId: string
  Minimum Length: 1

  Maximum Length: 50

  External Reservation Id

  Example: 12345678
• finNumber: string
  Maximum Length: 20

  FIN Number * `null` if empty

  Example: a1234
• guestCategories: array guestCategoryGET
• lifeBoat: object lifeBoat
  Life Boat
• longShoremanWork: boolean
  Long Shoreman Work

  Example: true
• musterStation: object musterStation
  Muster Station
• onboardEmail: string
  Minimum Length: 1

  Maximum Length: 72

  Pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-]+)(\.([a-zA-Z]{2,5})){1,}$

  Onboard Email Address

  Example: [e-mail]
• onboardStatus: boolean
  Onboard Status

  Example: true
• otherParameter: object otherParameter
  Other Parameter
• paymentDetails: object paymentDetails
  Payment Details
• pinCode: number
  Pincode

  Example: 1234
• profileInformation: object profileInformationResponse
  Profile information response
• reEmbarkationDate: string(date)
  Return Embarkation Date

  Example: 2024-01-01
• reservationId: object reservationId
  Reservation Id
• reservationStatus: string
  Minimum Length: 2

  Maximum Length: 2

  Pattern: ^RR|RE|CC|CL|DD|RN|RX$

  Reservation Status, RR=Reservation, RX=Cancelled, RE=Embark today, RN=No Show, CC=Checked In, CL=Leaving today, DD=Disembarked

  Example: CC
• setSailPassNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Set Sail Pass Number

  Example: 1234
• shoreGId: string
  Minimum Length: 1

  Maximum Length: 15

  Shore G Id

  Example: 12345678

{
    "description":"Crew Reservation response",
    "type":"object",
    "properties":{
        "reservationId":{
            "$ref":"#/definitions/reservationId"
        },
        "guestCategories":{
            "$ref":"#/definitions/guestCategoryGET"
        },
        "bookingNumber":{
            "$ref":"#/definitions/bookingNumber"
        },
        "shoreGId":{
            "$ref":"#/definitions/shoreGId"
        },
        "extResId":{
            "$ref":"#/definitions/extResId"
        },
        "boardCardNumber":{
            "$ref":"#/definitions/boardCardNumber"
        },
        "setSailPassNumber":{
            "$ref":"#/definitions/setSailPassNumber"
        },
        "finNumber":{
            "$ref":"#/definitions/finNumber"
        },
        "expectedEmbarkationDate":{
            "$ref":"#/definitions/expectedEmbarkationDate"
        },
        "expectedEmbarkationHarbor":{
            "$ref":"#/definitions/expectedEmbarkationHarbor"
        },
        "expectedDisembarkationDate":{
            "$ref":"#/definitions/expectedDisembarkationDate"
        },
        "expectedDisembarkationHarbor":{
            "$ref":"#/definitions/expectedDisembarkationHarbor"
        },
        "actualEmbarkationDate":{
            "$ref":"#/definitions/actualEmbarkationDate"
        },
        "actualEmbarkationHarbor":{
            "$ref":"#/definitions/actualEmbarkationHarbor"
        },
        "reEmbarkationDate":{
            "$ref":"#/definitions/reEmbarkationDate"
        },
        "embarkationHarborComment":{
            "$ref":"#/definitions/embarkationHarborComment"
        },
        "disembarkationHarborComment":{
            "$ref":"#/definitions/disembarkationHarborComment"
        },
        "reservationStatus":{
            "$ref":"#/definitions/reservationStatus"
        },
        "cabinNumber":{
            "$ref":"#/definitions/cabinNumber"
        },
        "berthNumber":{
            "$ref":"#/definitions/berthNumber"
        },
        "musterStation":{
            "$ref":"#/definitions/musterStation"
        },
        "lifeBoat":{
            "$ref":"#/definitions/lifeBoat"
        },
        "denyBoardingFlag":{
            "$ref":"#/definitions/denyBoardingFlag"
        },
        "denyBoardingReason":{
            "$ref":"#/definitions/denyBoardingReason"
        },
        "pinCode":{
            "$ref":"#/definitions/pinCode"
        },
        "longShoremanWork":{
            "$ref":"#/definitions/longShoremanWork"
        },
        "assign":{
            "$ref":"#/definitions/assign"
        },
        "onboardStatus":{
            "$ref":"#/definitions/onboardStatus"
        },
        "discountTemplate":{
            "$ref":"#/definitions/discountTemplate"
        },
        "paymentDetails":{
            "$ref":"#/definitions/paymentDetails"
        },
        "otherParameter":{
            "$ref":"#/definitions/otherParameter"
        },
        "onboardEmail":{
            "$ref":"#/definitions/onboardEmail"
        },
        "profileInformation":{
            "$ref":"#/definitions/profileInformationResponse"
        }
    }
}

Nested Schema : discountTemplate

Type: object

Discount Template

Show Source

• code: string
  Discount Template Code

  Example: LV2
• description: string
  Discount Template Description

  Example: Disc Template 2

{
    "description":"Discount Template",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/discountTemplateCode"
        },
        "description":{
            "$ref":"#/definitions/discountTemplateDescription"
        }
    }
}

Nested Schema : guestCategoryGET

Type: array

Show Source

• Array of: object guestCategoryGETGroup
  Guest Category Items

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/guestCategoryGETGroup"
    }
}

Nested Schema : lifeBoat

Type: object

Life Boat

Show Source

• code: string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Life Boat Code

  Example: L1
• description: string
  Life Boat Code Description

  Example: Guest Boat A

{
    "description":"Life Boat",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/lifeBoatCode"
        },
        "description":{
            "$ref":"#/definitions/lifeBoatCodeDescription"
        }
    }
}

Nested Schema : musterStation

Type: object

Muster Station

Show Source

• code: string
  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Muster Station Code

  Example: M
• description: string
  Muster Station Code Description

  Example: Guest Deck 1

{
    "description":"Muster Station",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/musterStationCode"
        },
        "description":{
            "$ref":"#/definitions/musterStationCodeDescription"
        }
    }
}

Nested Schema : otherParameter

Type: object

Other Parameter

Show Source

• isManifestPrintout: boolean
  Is Manifest Printout

  Example: true
• isNoticeAndConsent: boolean
  Acknowledge Notice and Consent

  Example: true
• isStayOvernightTour: boolean
  Is Stay Overnight Tour

  Example: true
• isSwitchToPassengerManifest: boolean
  Is Switch To Passenger Manifest

  Example: true

{
    "description":"Other Parameter",
    "type":"object",
    "properties":{
        "isManifestPrintout":{
            "$ref":"#/definitions/isManifestPrintout"
        },
        "isSwitchToPassengerManifest":{
            "$ref":"#/definitions/isSwitchToPassengerManifest"
        },
        "isStayOvernightTour":{
            "$ref":"#/definitions/isStayOvernightTour"
        },
        "isNoticeAndConsent":{
            "$ref":"#/definitions/isNoticeAndConsent"
        }
    }
}

Nested Schema : paymentDetails

Type: object

Payment Details

Show Source

• paymentMethodCode: string
  Maximum Length: 10

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Payment Method Code

  Example: 1234
• paymentRemarks: string
  Maximum Length: 3000

  Payment Remarks

  Example: Example Payment Remark

{
    "description":"Payment Details",
    "type":"object",
    "properties":{
        "paymentMethodCode":{
            "$ref":"#/definitions/paymentMethodCode"
        },
        "paymentRemarks":{
            "$ref":"#/definitions/paymentRemarks"
        }
    }
}

Nested Schema : profileInformationResponse

Type: object

Profile information response

Show Source

• birthPlace: string
  Maximum Length: 50

  Birth Place * `null` if empty

  Example: KL
• crewPostId: string
  Minimum Length: 1

  Maximum Length: 15

  Crew Post ID

  Example: 12345678
• dateOfBirth: string(ISO 8601 (YYYY-MM-DD))
  Date Of Birth

  Example: 1999-02-15
• departmentPosition: object departmentPosition
  Department Position
• externalId: string
  Minimum Length: 1

  Maximum Length: 20

  Crew External ID

  Example: 12345678
• eyeColor: string
  Maximum Length: 20

  Eye Color

  Example: Brown
• firstName: string
  Minimum Length: 1

  Maximum Length: 40

  The first name of the guest

  Example: Kobe
• gender: object gender
  Gender
• hairColor: string
  Maximum Length: 20

  Hair Color

  Example: Black
• height: string
  Minimum Length: 0

  Maximum Length: 10

  Height

  Example: 190
• internalId: string
  Minimum Length: 1

  Maximum Length: 20

  Crew Internal ID

  Example: 12345678
• isIntoxication: boolean
  Is Intoxication

  Example: true
• isSmoker: boolean
  Is Smoker

  Example: true
• lastName: string
  Minimum Length: 1

  Maximum Length: 40

  The last name of the guest

  Example: James
• maritalStatus: object maritalStatus
  Marital Status
• middleName: string
  Minimum Length: 1

  Maximum Length: 20

  The middle name of the guest

  Example: Bean
• nationality: object nationality
  Nationality
• nationId: string
  Minimum Length: 1

  Maximum Length: 20

  Nation Id

  Example: 123456
• operationalDepartment: object operationalDepartment
  Operational Department
• orderEmpNo: number
  Order Employee Number

  Example: 12345678
• otherFirstName: string
  Other First Name

  Example: Mäya
• otherLastName: string
  Other Last Name

  Example: Wälters
• passportIssuedCountry: object passportIssuedCountry
  Passport Issued Country
• passportIssuedDate: string(ISO 8601)
  Passport Issued Date

  Example: 2009-10-31
• passportIssuedExpiryDate: string(date)
  Passport Issued Expiry Date

  Example: 2026-11-11
• passportIssuedPlace: string
  Maximum Length: 50

  Passport Issued Place

  Example: Shah Alam
• passportNumber: string
  Passport Number

  Example: A1510202
• profileId: integer
  Profile ID

  Example: 1001
• salutation: string
  Minimum Length: 1

  Maximum Length: 20

  The salutation of the guest

  Example: Mr.
• seamanBookExpiryDate: string(date)
  Seaman Book Expiry Date

  Example: 2025-11-11
• seamanBookIssuedCountry: object seamanBookIssuedCountry
  Passport Issued Country
• seamanBookIssuedDate: string(ISO 8601)
  Seaman Book Issued Date

  Example: 2009-10-31
• seamanBookIssuedPlace: string
  Minimum Length: 1

  Maximum Length: 50

  Passport Issued Place

  Example: Kuala Lumpur
• seamanBookNumber: string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Seaman Book Number

  Example: ABC12345678
• title: string
  Title

  Example: Countess
• weight: number
  Weight

  Example: 70

{
    "description":"Profile information response",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "title":{
            "$ref":"#/definitions/title"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "gender":{
            "$ref":"#/definitions/gender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "nationality":{
            "$ref":"#/definitions/nationality"
        },
        "nationId":{
            "$ref":"#/definitions/nationId"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "hairColor":{
            "$ref":"#/definitions/hairColor"
        },
        "eyeColor":{
            "$ref":"#/definitions/eyeColor"
        },
        "height":{
            "$ref":"#/definitions/height"
        },
        "weight":{
            "$ref":"#/definitions/weight"
        },
        "isSmoker":{
            "$ref":"#/definitions/isSmoker"
        },
        "isIntoxication":{
            "$ref":"#/definitions/isIntoxication"
        },
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportIssuedExpiryDate":{
            "$ref":"#/definitions/passportIssuedExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/passportIssuedCountry"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatus"
        },
        "seamanBookNumber":{
            "$ref":"#/definitions/seamanBookNumber"
        },
        "seamanBookIssuedDate":{
            "$ref":"#/definitions/seamanBookIssuedDate"
        },
        "seamanBookExpiryDate":{
            "$ref":"#/definitions/seamanBookExpiryDate"
        },
        "seamanBookIssuedPlace":{
            "$ref":"#/definitions/seamanBookIssuedPlace"
        },
        "seamanBookIssuedCountry":{
            "$ref":"#/definitions/seamanBookIssuedCountry"
        },
        "operationalDepartment":{
            "$ref":"#/definitions/operationalDepartment"
        },
        "departmentPosition":{
            "$ref":"#/definitions/departmentPosition"
        },
        "externalId":{
            "$ref":"#/definitions/externalId"
        },
        "internalId":{
            "$ref":"#/definitions/internalId"
        },
        "crewPostId":{
            "$ref":"#/definitions/crewPostId"
        },
        "orderEmpNo":{
            "$ref":"#/definitions/orderEmpNo"
        }
    }
}

Nested Schema : reservationId

Type: object

Reservation Id

Show Source

• onBoardStatus: integer
  Example: 0
• reservationId: integer(int64)
  Example: 989323

{
    "description":"Reservation Id",
    "type":"object",
    "properties":{
        "reservationId":{
            "type":"integer",
            "format":"int64",
            "example":"989323"
        },
        "onBoardStatus":{
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : guestCategoryGETGroup

Type: object

Guest Category Items

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Guest Category Code

  Example: GCAT
• description: string
  Guest Category Code Description

  Example: Guest Category

{
    "description":"Guest Category Items",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/guestCategoryCode"
        },
        "description":{
            "$ref":"#/definitions/guestCategoryCodeDescription"
        }
    }
}

Nested Schema : departmentPosition

Type: object

Department Position

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Department Position Code

  Example: D1001
• description: string
  Department Position Description

  Example: STAFF CAPTAIN

{
    "description":"Department Position",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/departmentPositionCode"
        },
        "description":{
            "$ref":"#/definitions/departmentPositionDescription"
        }
    }
}

Nested Schema : gender

Type: object

Gender

Show Source

• code: string
  Gender Code

  Example: F
• description: string
  Gender Description

  Example: Female

{
    "description":"Gender",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/genderCode"
        },
        "description":{
            "$ref":"#/definitions/genderDescription"
        }
    }
}

Nested Schema : maritalStatus

Type: object

Marital Status

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z0-9 ]{1,6}$

  Marital Status Code

  Example: D
• description: string
  Marital Status Description

  Example: Single

{
    "description":"Marital Status",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/maritalStatusCode"
        },
        "description":{
            "$ref":"#/definitions/maritalStatusDesc"
        }
    }
}

Nested Schema : nationality

Type: object

Nationality

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Nationality Code

  Example: MY
• description: string
  Nationality Code Description

  Example: Malaysia

{
    "description":"Nationality",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/nationalityCode"
        },
        "description":{
            "$ref":"#/definitions/nationalityCodeDescription"
        }
    }
}

Nested Schema : operationalDepartment

Type: object

Operational Department

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Operational Department Code

  Example: S1001
• description: string
  Operational Department Description

  Example: DECK

{
    "description":"Operational Department",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/operationalDepartmentCode"
        },
        "description":{
            "$ref":"#/definitions/operationalDepartmentDescription"
        }
    }
}

Nested Schema : passportIssuedCountry

Type: object

Passport Issued Country

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Country Code

  Example: MY
• description: string
  Country Name

  Example: Malaysia

{
    "description":"Passport Issued Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/cpCountryCode"
        },
        "description":{
            "$ref":"#/definitions/countryDesc"
        }
    }
}

Nested Schema : seamanBookIssuedCountry

Type: object

Passport Issued Country

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$

  Country Code

  Example: MY
• description: string
  Country Name

  Example: Malaysia

{
    "description":"Passport Issued Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/cpCountryCode"
        },
        "description":{
            "$ref":"#/definitions/countryDesc"
        }
    }
}

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/crewReservationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"The parameter shipId has incorrect format"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"The parameter shipId has incorrect format"
}

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/crewReservationErrorResponse"
        }
    ],
    "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/crewReservationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is 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/crewReservationErrorResponse"
        }
    ],
    "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/crewReservationErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not 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"
        }
    }
}

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/crewReservationErrorResponse"
        }
    ],
    "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"
        }
    }
}

409 Response

Conflict

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/crewReservationErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Reservation cannot be updated because reservation status is 'DD' or 'RX'"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Reservation cannot be updated because reservation status is 'DD' or 'RX'"
}

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/crewReservationErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "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/crewReservationErrorResponse"
        }
    ],
    "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/crewReservationErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

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