Jump to

• Request
• Response

Update guest emergency contact address by Profile ID

put

/spms/v2/ships/{shipId}/profile/{profileId}/addresses/emergencyContact

This is to update the existing guest emergency contact address

Request

Supported Media Types

• application/json

Path Parameters

• profileId(required): integer
  Profile Id
• shipId(required): number
  Ship Id

Body ()

Emergency Address Object

Root Schema : Profile Emergency Address

Type: object

Title: Profile Emergency Address

Profile Emergency Address Contact Details

Show Source

• address: string
  Minimum Length: 1

  Maximum Length: 100

  Address * `null` if empty

  Example: 123, The Great Area
• businessPhone: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Business Phone * `null` if empty

  Example: 1259629630
• city: string
  Minimum Length: 1

  Maximum Length: 30

  City * `null` if empty

  Example: Denver
• country: object pecaCountry
  Country
• email: string
  Minimum Length: 1

  Maximum Length: 50

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

  Email Address * `null` if empty

  Example: [e-mail]
• emergencyContactName: string
  Minimum Length: 1

  Maximum Length: 40

  Emergency Contact Name * `null` if empty

  Example: Lanaya
• mobileNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Mobile Number * `null` if empty

  Example: 4413563590
• phoneNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Phone Number * `null` if empty

  Example: 6239629630
• relationship: string
  Minimum Length: 1

  Maximum Length: 30

  Relationship between the emergency contact with the guest * `null` if empty

  Example: Sister
• state: string
  Minimum Length: 1

  Maximum Length: 50

  State

  Example: Perak
• street: string
  Minimum Length: 1

  Maximum Length: 100

  Street * `null` if empty

  Example: Kind Street
• zipCode: string
  Minimum Length: 1

  Maximum Length: 10

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

  Zip Code * `null` if empty

  Example: 80014

{
    "title":"Profile Emergency Address",
    "description":"Profile Emergency Address Contact Details",
    "type":"object",
    "properties":{
        "emergencyContactName":{
            "$ref":"#/definitions/emergencyContactName"
        },
        "relationship":{
            "$ref":"#/definitions/relationship"
        },
        "address":{
            "$ref":"#/definitions/address"
        },
        "street":{
            "$ref":"#/definitions/pecaStreet"
        },
        "zipCode":{
            "$ref":"#/definitions/pecaZipCode"
        },
        "city":{
            "$ref":"#/definitions/pecaCity"
        },
        "state":{
            "$ref":"#/definitions/pecaStateName"
        },
        "country":{
            "$ref":"#/definitions/pecaCountry"
        },
        "phoneNumber":{
            "$ref":"#/definitions/pecaPhoneNumber"
        },
        "mobileNumber":{
            "$ref":"#/definitions/pecaMobileNumber"
        },
        "businessPhone":{
            "$ref":"#/definitions/businessPhone"
        },
        "email":{
            "$ref":"#/definitions/pecaEmail"
        }
    }
}

Nested Schema : pecaCountry

Type: object

Country

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Country Code * `null` if empty

  Example: US
• description: string
  Country Name * `null` if empty 'Country Name'

  Example: United States

{
    "description":"Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/pecaCountryCode"
        },
        "description":{
            "$ref":"#/definitions/pecaCountryDescription"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Profile Emergency Address With ID

Type: object

Title: Profile Emergency Address With ID

Profile Emergency Address Contact Details

Show Source

• address: string
  Minimum Length: 1

  Maximum Length: 100

  Address * `null` if empty

  Example: 123, The Great Area
• businessPhone: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Business Phone * `null` if empty

  Example: 1259629630
• city: string
  Minimum Length: 1

  Maximum Length: 30

  City * `null` if empty

  Example: Denver
• country: object pecaCountry
  Country
• email: string
  Minimum Length: 1

  Maximum Length: 50

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

  Email Address * `null` if empty

  Example: [e-mail]
• emergencyContactName: string
  Minimum Length: 1

  Maximum Length: 40

  Emergency Contact Name * `null` if empty

  Example: Lanaya
• mobileNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Mobile Number * `null` if empty

  Example: 4413563590
• phoneNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Phone Number * `null` if empty

  Example: 6239629630
• profileId: integer
  Profile ID. This field value must match with the parameter profileId value

  Example: 1001
• relationship: string
  Minimum Length: 1

  Maximum Length: 30

  Relationship between the emergency contact with the guest * `null` if empty

  Example: Sister
• state: string
  Minimum Length: 1

  Maximum Length: 50

  State

  Example: Perak
• street: string
  Minimum Length: 1

  Maximum Length: 100

  Street * `null` if empty

  Example: Kind Street
• zipCode: string
  Minimum Length: 1

  Maximum Length: 10

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

  Zip Code * `null` if empty

  Example: 80014

{
    "title":"Profile Emergency Address With ID",
    "description":"Profile Emergency Address Contact Details",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/pecaProfileId"
        },
        "emergencyContactName":{
            "$ref":"#/definitions/emergencyContactName"
        },
        "relationship":{
            "$ref":"#/definitions/relationship"
        },
        "address":{
            "$ref":"#/definitions/address"
        },
        "street":{
            "$ref":"#/definitions/pecaStreet"
        },
        "zipCode":{
            "$ref":"#/definitions/pecaZipCode"
        },
        "city":{
            "$ref":"#/definitions/pecaCity"
        },
        "state":{
            "$ref":"#/definitions/pecaStateName"
        },
        "country":{
            "$ref":"#/definitions/pecaCountry"
        },
        "phoneNumber":{
            "$ref":"#/definitions/pecaPhoneNumber"
        },
        "mobileNumber":{
            "$ref":"#/definitions/pecaMobileNumber"
        },
        "businessPhone":{
            "$ref":"#/definitions/businessPhone"
        },
        "email":{
            "$ref":"#/definitions/pecaEmail"
        }
    }
}

Nested Schema : pecaCountry

Type: object

Country

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Country Code * `null` if empty

  Example: US
• description: string
  Country Name * `null` if empty 'Country Name'

  Example: United States

{
    "description":"Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/pecaCountryCode"
        },
        "description":{
            "$ref":"#/definitions/pecaCountryDescription"
        }
    }
}

201 Response

Created

Body ()

Root Schema : Profile Emergency Address With ID

Type: object

Title: Profile Emergency Address With ID

Profile Emergency Address Contact Details

Show Source

• address: string
  Minimum Length: 1

  Maximum Length: 100

  Address * `null` if empty

  Example: 123, The Great Area
• businessPhone: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Business Phone * `null` if empty

  Example: 1259629630
• city: string
  Minimum Length: 1

  Maximum Length: 30

  City * `null` if empty

  Example: Denver
• country: object pecaCountry
  Country
• email: string
  Minimum Length: 1

  Maximum Length: 50

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

  Email Address * `null` if empty

  Example: [e-mail]
• emergencyContactName: string
  Minimum Length: 1

  Maximum Length: 40

  Emergency Contact Name * `null` if empty

  Example: Lanaya
• mobileNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Mobile Number * `null` if empty

  Example: 4413563590
• phoneNumber: string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9 \+\-\(\)]*$

  Phone Number * `null` if empty

  Example: 6239629630
• profileId: integer
  Profile ID. This field value must match with the parameter profileId value

  Example: 1001
• relationship: string
  Minimum Length: 1

  Maximum Length: 30

  Relationship between the emergency contact with the guest * `null` if empty

  Example: Sister
• state: string
  Minimum Length: 1

  Maximum Length: 50

  State

  Example: Perak
• street: string
  Minimum Length: 1

  Maximum Length: 100

  Street * `null` if empty

  Example: Kind Street
• zipCode: string
  Minimum Length: 1

  Maximum Length: 10

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

  Zip Code * `null` if empty

  Example: 80014

{
    "title":"Profile Emergency Address With ID",
    "description":"Profile Emergency Address Contact Details",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/pecaProfileId"
        },
        "emergencyContactName":{
            "$ref":"#/definitions/emergencyContactName"
        },
        "relationship":{
            "$ref":"#/definitions/relationship"
        },
        "address":{
            "$ref":"#/definitions/address"
        },
        "street":{
            "$ref":"#/definitions/pecaStreet"
        },
        "zipCode":{
            "$ref":"#/definitions/pecaZipCode"
        },
        "city":{
            "$ref":"#/definitions/pecaCity"
        },
        "state":{
            "$ref":"#/definitions/pecaStateName"
        },
        "country":{
            "$ref":"#/definitions/pecaCountry"
        },
        "phoneNumber":{
            "$ref":"#/definitions/pecaPhoneNumber"
        },
        "mobileNumber":{
            "$ref":"#/definitions/pecaMobileNumber"
        },
        "businessPhone":{
            "$ref":"#/definitions/businessPhone"
        },
        "email":{
            "$ref":"#/definitions/pecaEmail"
        }
    }
}

Nested Schema : pecaCountry

Type: object

Country

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 6

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

  Country Code * `null` if empty

  Example: US
• description: string
  Country Name * `null` if empty 'Country Name'

  Example: United States

{
    "description":"Country",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/pecaCountryCode"
        },
        "description":{
            "$ref":"#/definitions/pecaCountryDescription"
        }
    }
}

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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
        "title":"Conflict",
        "detail":"Duplicate Marital Status Code"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10",
    "title":"Conflict",
    "detail":"Duplicate Marital Status Code"
}

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/emergencyAddressErrorResponse"
        }
    ],
    "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/emergencyAddressErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Error occurred while processing this request"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Error occurred while processing this 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"
        }
    }
}

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