Jump to

• Request
• Response

Update a crew profile by profile Id

put

/spms/v2/ships/{shipId}/profiles/crews/{profileId}

This is to update a crew profile details by profile Id

Request

Supported Media Types

• application/json

Path Parameters

• profileId: integer
  Profile Id
• shipId: number
  Ship Id

Body ()

Crew Profile Object

Root Schema : Crew Profile Request

Type: object

Title: Crew Profile Request

Crew Profile Request Body

Show Source

• age(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Age

  Example: 25
• birthNation(optional): string
  Minimum Length: 1

  Maximum Length: 3

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

  Country Code

  Example: US
• birthPlace(optional): string
  Maximum Length: 50

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

  Birth Place * `null` if empty

  Example: KL
• dateOfBirth(optional): string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1970-02-15
• eyeColour(optional): string
  Eye Colour

  Example: Blue
• finNumber(optional): string
  Maximum Length: 20

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

  FIN Number * `null` if empty

  Example: a1234
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  First name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Doe
• gender(optional): object gender
  Gender
• hairColour(optional): string
  Hair Colour

  Example: Blonde
• height(optional): string
  Height

  Example: 190
• intoxication(optional): boolean
  Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicated

  Example: false
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Last name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jaden
• maritalStatus(optional): object maritalStatusCode
  maritalStatusCode
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Middle name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jay
• nationalId(optional): string
  Maximum Length: 20

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

  National Id * `null` if empty

  Example: 1234
• nationality(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

  Example: US
• nationalityFlag(optional): string
  Nationality Flag

  Example: China
• otherFirstName(optional): string
  Other First Name

  Example: Mäya
• otherLastName(optional): string
  Other Last Name

  Example: Wälters
• passportDetails(optional): object passportDetailsRequest
  Passport Details
• photo(optional): string
  Photo

  Example: https://[HOSTNAME]/resources/img_01.jpg
• preferredLanguage1(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z_0-9-! ]+$

  Preferred Language Code

  Example: EN
• preferredLanguage2(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z_0-9-! ]+$

  Preferred Language Code

  Example: EN
• preferredLanguage3(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z_0-9-! ]+$

  Preferred Language Code

  Example: EN
• privilegeLevel(optional): string
  Award Level * `null` if empty

  Example: platinum
• salutation(optional): string
  Salutation

  Example: Dr.
• seamanBookDetails(optional): object seamanBookDetailsRequest
  Seaman Book Details
• smoke(optional): boolean
  Is the guest a smoker: * `true` - Smoker * `false` - Non-smoker

  Example: true
• weight(optional): string
  Weight

  Example: 70

{
    "title":"Crew Profile Request",
    "description":"Crew Profile Request Body",
    "type":"object",
    "properties":{
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "gender":{
            "$ref":"#/definitions/gender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "age":{
            "$ref":"#/definitions/age"
        },
        "photo":{
            "$ref":"#/definitions/photo"
        },
        "nationality":{
            "$ref":"#/definitions/countryCode"
        },
        "birthNation":{
            "$ref":"#/definitions/birthNationCode"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatusCode"
        },
        "preferredLanguage1":{
            "$ref":"#/definitions/preferredLanguageCode"
        },
        "preferredLanguage2":{
            "$ref":"#/definitions/preferredLanguageCode"
        },
        "preferredLanguage3":{
            "$ref":"#/definitions/preferredLanguageCode"
        },
        "privilegeLevel":{
            "$ref":"#/definitions/privilegeLevel"
        },
        "nationalId":{
            "$ref":"#/definitions/nationalId"
        },
        "nationalityFlag":{
            "$ref":"#/definitions/nationalityFlag"
        },
        "finNumber":{
            "$ref":"#/definitions/finNumber"
        },
        "smoke":{
            "$ref":"#/definitions/smoke"
        },
        "intoxication":{
            "$ref":"#/definitions/intoxication"
        },
        "hairColour":{
            "$ref":"#/definitions/hairColour"
        },
        "eyeColour":{
            "$ref":"#/definitions/eyeColour"
        },
        "height":{
            "$ref":"#/definitions/height"
        },
        "weight":{
            "$ref":"#/definitions/weight"
        },
        "passportDetails":{
            "$ref":"#/definitions/passportDetailsRequest"
        },
        "seamanBookDetails":{
            "$ref":"#/definitions/seamanBookDetailsRequest"
        }
    }
}

Nested Schema : gender

Type: object

Gender

Show Source

• code(optional): string
  Pattern: ^[FMX]$

  Gender Code

  Example: F
• description(optional): string
  Gender Name

  Example: Female

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

Nested Schema : maritalStatusCode

Type: object

maritalStatusCode

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Marital Status Code

  Example: D
• comments(optional): string
  Maximum Value: 4000

  Account Category Comments

  Example: The term profit and loss (P&L) statement refers to a financial statement that summarizes the revenues, costs, and expenses incurred during a specified period, usually a quarter or fiscal year. These records provide information about a companys ability or inability to generate profit by increasing revenue, reducing costs, or both. These statements are often presented on a cash or accrual basis.
• description(optional): string
  Minimum Value: 1

  Maximum Value: 1000

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

  Account Category Description

  Example: Profit and Loss Account
• id(optional): string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Currency Exchange Id

  Example: 12345
• isEnabled(optional): boolean
  This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account category

  Example: true

{
    "description":"maritalStatusCode",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/id"
        },
        "code":{
            "$ref":"#/definitions/code"
        },
        "description":{
            "$ref":"#/definitions/description"
        },
        "comments":{
            "$ref":"#/definitions/comments"
        },
        "isEnabled":{
            "$ref":"#/definitions/isEnabled"
        }
    }
}

Nested Schema : passportDetailsRequest

Type: object

Passport Details

Show Source

• passportExpiryDate(optional): string(ISO 8601 (YYYY-MM-DD))
  Passport Expiry Date

  Example: 2025-02-25
• passportIssuedCountry(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

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

  Example: 2009-10-31
• passportIssuedPlace(optional): string
  Passport Issued Place

  Example: Paramount
• passportNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

  Passport number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: A123409982

{
    "description":"Passport Details",
    "type":"object",
    "properties":{
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportExpiryDate":{
            "$ref":"#/definitions/passportExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/countryCode"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        }
    }
}

Nested Schema : seamanBookDetailsRequest

Type: object

Seaman Book Details

Show Source

• seamanBookExpiredDate(optional): string(ISO 8601)
  Seaman Book Expired Date

  Example: 2009-10-31
• seamanBookIssuedCountry(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

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

  Example: 2009-10-31
• seamanBookIssuedPlace(optional): string
  Passport Issued Place

  Example: Kuala Lumpur
• seamanBookNumber(optional): string
  Seaman Book Number

  Example: ABC12345678

{
    "description":"Seaman Book Details",
    "type":"object",
    "properties":{
        "seamanBookNumber":{
            "$ref":"#/definitions/seamanBookNumber"
        },
        "seamanBookIssuedDate":{
            "$ref":"#/definitions/seamanBookIssuedDate"
        },
        "seamanBookExpiredDate":{
            "$ref":"#/definitions/seamanBookExpiredDate"
        },
        "seamanBookIssuedPlace":{
            "$ref":"#/definitions/seamanBookIssuedPlace"
        },
        "seamanBookIssuedCountry":{
            "$ref":"#/definitions/countryCode"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/hal+json

200 Response

OK

Body ()

Root Schema : Crew Profile

Type: object

Title: Crew Profile

Crew Profile Response

Show Source

• accountCategory(optional): object accountCategory
  Account Category
• age(optional): integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Age

  Example: 25
• birthNation(optional): object birthNation
  Birth Nation
• birthPlace(optional): string
  Maximum Length: 50

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

  Birth Place * `null` if empty

  Example: KL
• dateOfBirth(optional): string(ISO 8601 (YYYY-MM-DD))
  Date of Birth

  Example: 1970-02-15
• eyeColour(optional): string
  Eye Colour

  Example: Blue
• finNumber(optional): string
  Maximum Length: 20

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

  FIN Number * `null` if empty

  Example: a1234
• firstName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  First name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Doe
• gender(optional): object gender
  Gender
• hairColour(optional): string
  Hair Colour

  Example: Blonde
• height(optional): string
  Height

  Example: 190
• intoxication(optional): boolean
  Is the guest intoxicated: * `true` - Intoxicated * `false` - Non-intoxicated

  Example: false
• lastName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Last name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jaden
• links(optional): array links
• maritalStatus(optional): object maritalStatus
  Marital Status
• middleName(optional): string
  Minimum Length: 1

  Maximum Length: 40

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?\/.\-+*~!@#$%&{}[\]\(\)=|^'":;@`\\]*$

  Middle name * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: Jay
• nationalId(optional): string
  Maximum Length: 20

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

  National Id * `null` if empty

  Example: 1234
• nationality(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Nationality code * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: US
• nationalityFlag(optional): string
  Nationality Flag

  Example: China
• otherFirstName(optional): string
  Other First Name

  Example: Mäya
• otherLastName(optional): string
  Other Last Name

  Example: Wälters
• passportDetails(optional): object passportDetailsResponse
  Passport Details
• photo(optional): string
  Photo

  Example: https://[HOSTNAME]/resources/img_01.jpg
• preferredLanguage1(optional): object preferredLanguage
  Preferred Language
• preferredLanguage2(optional): object preferredLanguage
  Preferred Language
• preferredLanguage3(optional): object preferredLanguage
  Preferred Language
• privilegeLevel(optional): string
  Award Level * `null` if empty

  Example: platinum
• profileId(optional): integer
  Profile ID

  Example: 1234
• profileType(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[PRCV]$

  Profile type

  Example: P
• salutation(optional): string
  Salutation

  Example: Dr.
• seamanBookDetails(optional): object seamanBookDetailsResponse
  Seaman Book Details
• smoke(optional): boolean
  Is the guest a smoker: * `true` - Smoker * `false` - Non-smoker

  Example: true
• weight(optional): string
  Weight

  Example: 70

{
    "title":"Crew Profile",
    "description":"Crew Profile Response",
    "type":"object",
    "properties":{
        "profileType":{
            "$ref":"#/definitions/profileType"
        },
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "accountCategory":{
            "$ref":"#/definitions/accountCategory"
        },
        "lastName":{
            "$ref":"#/definitions/lastName"
        },
        "firstName":{
            "$ref":"#/definitions/firstName"
        },
        "middleName":{
            "$ref":"#/definitions/middleName"
        },
        "otherLastName":{
            "$ref":"#/definitions/otherLastName"
        },
        "otherFirstName":{
            "$ref":"#/definitions/otherFirstName"
        },
        "salutation":{
            "$ref":"#/definitions/salutation"
        },
        "gender":{
            "$ref":"#/definitions/gender"
        },
        "dateOfBirth":{
            "$ref":"#/definitions/dateOfBirth"
        },
        "age":{
            "$ref":"#/definitions/age"
        },
        "photo":{
            "$ref":"#/definitions/photo"
        },
        "nationality":{
            "$ref":"#/definitions/nationality"
        },
        "birthNation":{
            "$ref":"#/definitions/birthNation"
        },
        "birthPlace":{
            "$ref":"#/definitions/birthPlace"
        },
        "maritalStatus":{
            "$ref":"#/definitions/maritalStatus"
        },
        "preferredLanguage1":{
            "$ref":"#/definitions/preferredLanguage"
        },
        "preferredLanguage2":{
            "$ref":"#/definitions/preferredLanguage"
        },
        "preferredLanguage3":{
            "$ref":"#/definitions/preferredLanguage"
        },
        "privilegeLevel":{
            "$ref":"#/definitions/privilegeLevel"
        },
        "nationalId":{
            "$ref":"#/definitions/nationalId"
        },
        "nationalityFlag":{
            "$ref":"#/definitions/nationalityFlag"
        },
        "finNumber":{
            "$ref":"#/definitions/finNumber"
        },
        "smoke":{
            "$ref":"#/definitions/smoke"
        },
        "intoxication":{
            "$ref":"#/definitions/intoxication"
        },
        "hairColour":{
            "$ref":"#/definitions/hairColour"
        },
        "eyeColour":{
            "$ref":"#/definitions/eyeColour"
        },
        "height":{
            "$ref":"#/definitions/height"
        },
        "weight":{
            "$ref":"#/definitions/weight"
        },
        "passportDetails":{
            "$ref":"#/definitions/passportDetailsResponse"
        },
        "seamanBookDetails":{
            "$ref":"#/definitions/seamanBookDetailsResponse"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/linksProfile"
            },
            "example":[
                {
                    "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profiles/crews/1001/crewEmployments",
                    "method":"get",
                    "operationId":"getCrewEmployment"
                },
                {
                    "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profiles/crew/1001/crewSafetyAssignments",
                    "method":"get",
                    "operationId":"getCrewSafetyAssignment"
                },
                {
                    "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/home",
                    "method":"get",
                    "operationId":"getHomeAddress"
                },
                {
                    "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/emergencyContact ",
                    "method":"get",
                    "operationId":"getEmergencyContact"
                }
            ]
        }
    }
}

Nested Schema : accountCategory

Type: object

Account Category

Show Source

• code(optional): string
  Minimum Value: 1

  Maximum Value: 6

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

  Account Category code

  Example: PROLOS
• description(optional): string
  Account Category Description

  Example: Regular Guest

{
    "description":"Account Category",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/accountCategoryCode"
        },
        "description":{
            "$ref":"#/definitions/accountCategoryDescription"
        }
    }
}

Nested Schema : birthNation

Type: object

Birth Nation

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 3

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

  Country Code

  Example: US
• description(optional): string
  Birth Nation Name * `null` if empty

  Example: United States

{
    "description":"Birth Nation",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/birthNationCode"
        },
        "description":{
            "$ref":"#/definitions/birthNationDesc"
        }
    }
}

Nested Schema : gender

Type: object

Gender

Show Source

• code(optional): string
  Pattern: ^[FMX]$

  Gender Code

  Example: F
• description(optional): string
  Gender Name

  Example: Female

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

Nested Schema : links

Type: array

Show Source

• Array of: object linksProfile
  links detail

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/linksProfile"
    },
    "example":[
        {
            "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profiles/crews/1001/crewEmployments",
            "method":"get",
            "operationId":"getCrewEmployment"
        },
        {
            "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profiles/crew/1001/crewSafetyAssignments",
            "method":"get",
            "operationId":"getCrewSafetyAssignment"
        },
        {
            "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/home",
            "method":"get",
            "operationId":"getHomeAddress"
        },
        {
            "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/emergencyContact ",
            "method":"get",
            "operationId":"getEmergencyContact"
        }
    ]
}

Example:

[
    {
        "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profiles/crews/1001/crewEmployments",
        "method":"get",
        "operationId":"getCrewEmployment"
    },
    {
        "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profiles/crew/1001/crewSafetyAssignments",
        "method":"get",
        "operationId":"getCrewSafetyAssignment"
    },
    {
        "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/home",
        "method":"get",
        "operationId":"getHomeAddress"
    },
    {
        "href":"http://[HOSTNAME]/spms/v2/ships/186000000117/profile/1001/addresses/emergencyContact ",
        "method":"get",
        "operationId":"getEmergencyContact"
    }
]

Nested Schema : maritalStatus

Type: object

Marital Status

Show Source

• code(optional): object maritalStatusCode
  maritalStatusCode
• description(optional): string
  Marital Status Description

  Example: Single

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

Nested Schema : passportDetailsResponse

Type: object

Passport Details

Show Source

• passportExpiryDate(optional): string(ISO 8601 (YYYY-MM-DD))
  Passport Expiry Date

  Example: 2025-02-25
• passportIssuedCountry(optional): object passportIssuedCountry
  Passport Issued Country
• passportIssuedDate(optional): string(ISO 8601)
  Passport Issued Date

  Example: 2009-10-31
• passportIssuedPlace(optional): string
  Passport Issued Place

  Example: Paramount
• passportNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

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

  Passport number * `Optional` (Do not provide if not in use) * `null` if searching `null` * For all Profile Types

  Example: A123409982

{
    "description":"Passport Details",
    "type":"object",
    "properties":{
        "passportNumber":{
            "$ref":"#/definitions/passportNumber"
        },
        "passportIssuedDate":{
            "$ref":"#/definitions/passportIssuedDate"
        },
        "passportExpiryDate":{
            "$ref":"#/definitions/passportExpiryDate"
        },
        "passportIssuedCountry":{
            "$ref":"#/definitions/passportIssuedCountry"
        },
        "passportIssuedPlace":{
            "$ref":"#/definitions/passportIssuedPlace"
        }
    }
}

Nested Schema : preferredLanguage

Type: object

Preferred Language

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Pattern: ^[a-zA-Z_0-9-! ]+$

  Preferred Language Code

  Example: EN
• description(optional): string
  Preferred Language Description

  Example: English

{
    "description":"Preferred Language",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/preferredLanguageCode"
        },
        "description":{
            "$ref":"#/definitions/preferredLanguageDesc"
        }
    }
}

Nested Schema : seamanBookDetailsResponse

Type: object

Seaman Book Details

Show Source

• seamanBookExpiredDate(optional): string(ISO 8601)
  Seaman Book Expired Date

  Example: 2009-10-31
• seamanBookIssuedCountry(optional): object seamanBookIssuedCountry
  Passport Issued Country
• seamanBookIssuedDate(optional): string(ISO 8601)
  Seaman Book Issued Date

  Example: 2009-10-31
• seamanBookIssuedPlace(optional): string
  Passport Issued Place

  Example: Kuala Lumpur
• seamanBookNumber(optional): string
  Seaman Book Number

  Example: ABC12345678

{
    "description":"Seaman Book Details",
    "type":"object",
    "properties":{
        "seamanBookNumber":{
            "$ref":"#/definitions/seamanBookNumber"
        },
        "seamanBookIssuedDate":{
            "$ref":"#/definitions/seamanBookIssuedDate"
        },
        "seamanBookExpiredDate":{
            "$ref":"#/definitions/seamanBookExpiredDate"
        },
        "seamanBookIssuedPlace":{
            "$ref":"#/definitions/seamanBookIssuedPlace"
        },
        "seamanBookIssuedCountry":{
            "$ref":"#/definitions/seamanBookIssuedCountry"
        }
    }
}

Nested Schema : linksProfile

Type: object

links detail

Show Source

• method(optional): string
  Example: get
• rel(optional): string
  Example: self

{
    "description":"links detail",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"self"
        },
        "method":{
            "type":"string",
            "example":"get"
        }
    }
}

Nested Schema : maritalStatusCode

Type: object

maritalStatusCode

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

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

  Marital Status Code

  Example: D
• comments(optional): string
  Maximum Value: 4000

  Account Category Comments

  Example: The term profit and loss (P&L) statement refers to a financial statement that summarizes the revenues, costs, and expenses incurred during a specified period, usually a quarter or fiscal year. These records provide information about a companys ability or inability to generate profit by increasing revenue, reducing costs, or both. These statements are often presented on a cash or accrual basis.
• description(optional): string
  Minimum Value: 1

  Maximum Value: 1000

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

  Account Category Description

  Example: Profit and Loss Account
• id(optional): string
  Minimum Length: 1

  Maximum Length: 10

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Currency Exchange Id

  Example: 12345
• isEnabled(optional): boolean
  This is to indicate switch to enable / disable account category (default value: true) * `true` - Enable account category * `false` - Disable account category

  Example: true

{
    "description":"maritalStatusCode",
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/definitions/id"
        },
        "code":{
            "$ref":"#/definitions/code"
        },
        "description":{
            "$ref":"#/definitions/description"
        },
        "comments":{
            "$ref":"#/definitions/comments"
        },
        "isEnabled":{
            "$ref":"#/definitions/isEnabled"
        }
    }
}

Nested Schema : passportIssuedCountry

Type: object

Passport Issued Country

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

  Example: US
• description(optional): string
  Country Name

  Example: Malaysia

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

Nested Schema : seamanBookIssuedCountry

Type: object

Passport Issued Country

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

  Example: US
• description(optional): string
  Country Name

  Example: Malaysia

{
    "description":"Passport Issued Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/countryCode"
        },
        "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/crewProfileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Malformed JSON request"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Malformed JSON request"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

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

Example:

{
    "type":"http://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(optional): string
• title(optional): string
• type(optional): 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/crewProfileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Profile ID - 1002 is invalid"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Profile ID - 1002 is invalid"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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/crewProfileErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/crewProfileErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): string

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

410 Response

Gone

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/crewProfileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
        "title":"Gone",
        "detail":"Requested Resource no longer exists"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11",
    "title":"Gone",
    "detail":"Requested Resource no longer exists"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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/crewProfileErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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/crewProfileErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): string

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

501 Response

Not Implemented

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/crewProfileErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
        "title":"Not implemented",
        "detail":"Resource is not implemented in this version of the API"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2",
    "title":"Not implemented",
    "detail":"Resource is not implemented in this version of the API"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
• title(optional): string
• type(optional): 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/crewProfileErrorResponse"
        }
    ],
    "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(optional): string
• title(optional): string
• type(optional): 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