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(required): integer
  Profile Id
• shipId(required): 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: integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Age

  Example: 25
• birthNation: string
  Minimum Length: 1

  Maximum Length: 6

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

  Birth Nation Code * `null` if empty

  Example: US
• birthPlace: string
  Maximum Length: 50

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

  Birth Place

  Example: Kajang
• dateOfBirth: string(date)
  Birth Date

  Example: 2018-11-11
• eyeColour: string
  Eye Colour

  Example: Blue
• finNumber: string
  Maximum Length: 20

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

  FIN Number * `null` if empty

  Example: a1234
• firstName: string
  Minimum Length: 1

  Maximum Length: 40

  The first name of the guest

  Example: Kobe
• gender: object gender
  Gender
• hairColour: string
  Hair Colour

  Example: Blonde
• height: string
  Height

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

  Example: false
• lastName: 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 _,?/.\-+* ~!@#$%&{}[]()=<>|^'":;@`]*$

  Marital Status Code

  Example: S
• middleName: string
  Minimum Length: 1

  Maximum Length: 20

  The middle name of the guest

  Example: Bean
• nationalId: string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9 ]*$

  National Id

  Example: 22
• nationality: string
  Country Code

  Example: US
• nationalityFlag: string
  Nationality Flag

  Example: China
• otherFirstName: string
  Minimum Length: 1

  Maximum Length: 80

  Pattern: ^[ a-zA-Z0-9_.À-῿Ⰰ-퟿]*$

  Other First Name * `null` if empty

  Example: Frost
• otherLastName: string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: ^[ a-zA-Z0-9_.À-῿Ⰰ-퟿]*$

  Other Last Name * `null` if empty

  Example: Francis
• passportDetails: object passportDetailsRequest
  Passport Details
• photo: string
  Photo

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==
• preferredLanguage1: string
  Minimum Length: 1

  Maximum Length: 6

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

  Preferred Language Code

  Example: EN
• preferredLanguage2: string
  Minimum Length: 1

  Maximum Length: 6

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

  Preferred Language Code

  Example: EN
• preferredLanguage3: string
  Minimum Length: 1

  Maximum Length: 6

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

  Preferred Language Code

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

  Example: platinum
• salutation: string
  Minimum Length: 1

  Maximum Length: 20

  The salutation of the guest

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

  Example: true
• weight: 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: string
  Minimum Length: 1

  Maximum Length: 6

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

  Gender Code

  Example: M
• description: string
  Gender Code Description

  Example: Male

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

Nested Schema : passportDetailsRequest

Type: object

Passport Details

Show Source

• passportExpiryDate: string(ISO 8601)
  Passport Expiry Date

  Example: 2009-10-31
• passportIssuedCountry: string
  Country Code

  Example: US
• passportIssuedDate: string(date)
  Passport Issued Date

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

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

  Passport Issued Place

  Example: Shah Alam
• passportNumber: string
  Minimum Length: 1

  Maximum Length: 20

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

  Passport Number

  Example: A145611

{
    "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: string(ISO 8601)
  Seaman Book Expired Date

  Example: 2009-10-31
• seamanBookIssuedCountry: string
  Country Code

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

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

  Example: Kuala Lumpur
• seamanBookNumber: 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: string
  Allowed Values: [ "PAX" ]

  accountCategory

  Example: PAX
• age: integer(int32)
  Minimum Value: 1

  Maximum Value: 150

  Age

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

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

  Birth Place

  Example: Kajang
• dateOfBirth: string(date)
  Birth Date

  Example: 2018-11-11
• eyeColour: string
  Eye Colour

  Example: Blue
• finNumber: string
  Maximum Length: 20

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

  FIN Number * `null` if empty

  Example: a1234
• firstName: string
  Minimum Length: 1

  Maximum Length: 40

  The first name of the guest

  Example: Kobe
• gender: object gender
  Gender
• hairColour: string
  Hair Colour

  Example: Blonde
• height: string
  Height

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

  Example: false
• lastName: string
  Minimum Length: 1

  Maximum Length: 40

  The last name of the guest

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

  Maximum Length: 20

  The middle name of the guest

  Example: Bean
• nationalId: string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[a-zA-Z0-9 ]*$

  National Id

  Example: 22
• nationality: object nationalityStruct
  Nationality
• nationalityFlag: string
  Nationality Flag

  Example: China
• otherFirstName: string
  Minimum Length: 1

  Maximum Length: 80

  Pattern: ^[ a-zA-Z0-9_.À-῿Ⰰ-퟿]*$

  Other First Name * `null` if empty

  Example: Frost
• otherLastName: string
  Minimum Length: 1

  Maximum Length: 100

  Pattern: ^[ a-zA-Z0-9_.À-῿Ⰰ-퟿]*$

  Other Last Name * `null` if empty

  Example: Francis
• passportDetails: object passportDetailsResponse
  Passport Details
• photo: string
  Photo

  Example: /9j/4AAQSkZJRgABAQEASABIAAD==
• preferredLanguage1: object preferredLanguage
  Preferred Language
• preferredLanguage2: object preferredLanguage
  Preferred Language
• preferredLanguage3: object preferredLanguage
  Preferred Language
• privilegeLevel: string
  Award Level * `null` if empty

  Example: platinum
• profileId: number
  Minimum Length: 1

  Pattern: ^[0-9]*$

  Profile Id

  Example: 12345
• profileType: string
  Profile Type

  Example: Crew
• salutation: string
  Minimum Length: 1

  Maximum Length: 20

  The salutation of the guest

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

  Example: true
• weight: 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/nationalityStruct"
        },
        "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 : birthNation

Type: object

Birth Nation

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Birth Nation Code * `null` if empty

  Example: US
• description: 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: string
  Minimum Length: 1

  Maximum Length: 6

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

  Gender Code

  Example: M
• description: string
  Gender Code Description

  Example: Male

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

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: string
  Minimum Length: 1

  Maximum Length: 6

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

  Marital Status Code

  Example: S
• description: string
  Marital Status Description

  Example: Single

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

Nested Schema : nationalityStruct

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 : passportDetailsResponse

Type: object

Passport Details

Show Source

• passportExpiryDate: string(ISO 8601)
  Passport Expiry Date

  Example: 2009-10-31
• passportIssuedCountry: object passportIssuedCountry
  Passport Issued Country
• passportIssuedDate: string(date)
  Passport Issued Date

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

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

  Passport Issued Place

  Example: Shah Alam
• passportNumber: string
  Minimum Length: 1

  Maximum Length: 20

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

  Passport Number

  Example: A145611

{
    "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: string
  Minimum Length: 1

  Maximum Length: 6

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

  Preferred Language Code

  Example: EN
• description: 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: string(ISO 8601)
  Seaman Book Expired Date

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

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

  Example: Kuala Lumpur
• seamanBookNumber: 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: string
  Example: get
• rel: string
  Example: self

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

Nested Schema : passportIssuedCountry

Type: object

Passport Issued Country

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Passport Issued Country Code

  Example: MY
• description: string
  Passport Issued Country Code Description

  Example: Malaysia

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

Nested Schema : seamanBookIssuedCountry

Type: object

Passport Issued Country

Show Source

• code: string
  Country Code

  Example: US
• description: 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: 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/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: 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/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: 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/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: 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/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: 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/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: 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"
        }
    }
}

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: 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/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: 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/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: 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"
        }
    }
}

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: 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/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: 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