Jump to

• Request
• Response

Create new guest home address by Profile ID

post

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

This is to create a new guest home address

Request

Supported Media Types

• application/json

Path Parameters

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

Body ()

Home Address Object

Root Schema : Profile Home Address Request

Type: object

Title: Profile Home Address Request

Profile Home Address & Other Contact Details Request Body

Show Source

• address1(optional): string
  Minimum Length: 1

  Maximum Length: 99

  Address Line 1 * `null` if empty

  Example: 123, The Great Area
• address2(optional): string
  Minimum Length: 1

  Maximum Length: 99

  Address Line 2 * `null` if empty

  Example: Goodwill Neighbourhood
• city(optional): string
  Minimum Length: 1

  Maximum Length: 30

  City * `null` if empty

  Example: Denver
• countryCode(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

  Example: US
• email1(optional): string
  Minimum Length: 1

  Maximum Length: 49

  Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

  Primary Email Address * `null` if empty

  Example: [e-mail]
• email2(optional): string
  Minimum Length: 1

  Maximum Length: 49

  Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

  Secondary Email Address * `null` if empty

  Example: [e-mail]
• mobileNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[0-9]*$

  Mobile Number * `null` if empty

  Example: 4413563590
• phoneNumber(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9]*$

  Phone Number * `null` if empty

  Example: 6239629630
• state(optional): object stateRequest
  State
• street(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Street * `null` if empty

  Example: Kind Street
• zipCode(optional): string
  Minimum Length: 1

  Maximum Length: 10

  Zip Code * `null` if empty

  Example: 80014

{
    "title":"Profile Home Address Request",
    "description":"Profile Home Address & Other Contact Details Request Body",
    "type":"object",
    "properties":{
        "address1":{
            "$ref":"#/definitions/address1"
        },
        "address2":{
            "$ref":"#/definitions/address2"
        },
        "street":{
            "$ref":"#/definitions/street"
        },
        "zipCode":{
            "$ref":"#/definitions/zipCode"
        },
        "city":{
            "$ref":"#/definitions/city"
        },
        "state":{
            "$ref":"#/definitions/stateRequest"
        },
        "countryCode":{
            "$ref":"#/definitions/countryCode"
        },
        "phoneNumber":{
            "$ref":"#/definitions/phoneNumber"
        },
        "mobileNumber":{
            "$ref":"#/definitions/mobileNumber"
        },
        "email1":{
            "$ref":"#/definitions/email1"
        },
        "email2":{
            "$ref":"#/definitions/email2"
        }
    }
}

Nested Schema : stateRequest

Type: object

State

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 3

  State Code * `null` if empty State or `Free Text`

  Example: CO
• description(optional): string
  Minimum Length: 1

  Maximum Length: 49

  State Name * `null` if empty `Free Text` * `null` or `Corresponding State Name` if given State Code

  Example: Colorado

{
    "description":"State",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/stateCode"
        },
        "description":{
            "$ref":"#/definitions/stateDescriptionRequest"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Created

Body ()

Root Schema : Profile Home Address

Type: object

Title: Profile Home Address

Profile Home Address and Other Contact Details

Show Source

• address1(optional): string
  Minimum Length: 1

  Maximum Length: 99

  Address Line 1 * `null` if empty

  Example: 123, The Great Area
• address2(optional): string
  Minimum Length: 1

  Maximum Length: 99

  Address Line 2 * `null` if empty

  Example: Goodwill Neighbourhood
• city(optional): string
  Minimum Length: 1

  Maximum Length: 30

  City * `null` if empty

  Example: Denver
• country(optional): object country
  Country
• email1(optional): string
  Minimum Length: 1

  Maximum Length: 49

  Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

  Primary Email Address * `null` if empty

  Example: [e-mail]
• email2(optional): string
  Minimum Length: 1

  Maximum Length: 49

  Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$

  Secondary Email Address * `null` if empty

  Example: [e-mail]
• mobileNumber(optional): string
  Minimum Length: 1

  Maximum Length: 20

  Pattern: ^[0-9]*$

  Mobile Number * `null` if empty

  Example: 4413563590
• phoneNumber(optional): string
  Minimum Length: 1

  Maximum Length: 30

  Pattern: ^[0-9]*$

  Phone Number * `null` if empty

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

  Example: 456789
• state(optional): object stateResponse
  State
• street(optional): string
  Minimum Length: 1

  Maximum Length: 100

  Street * `null` if empty

  Example: Kind Street
• zipCode(optional): string
  Minimum Length: 1

  Maximum Length: 10

  Zip Code * `null` if empty

  Example: 80014

{
    "title":"Profile Home Address",
    "description":"Profile Home Address and Other Contact Details",
    "type":"object",
    "properties":{
        "profileId":{
            "$ref":"#/definitions/profileId"
        },
        "address1":{
            "$ref":"#/definitions/address1"
        },
        "address2":{
            "$ref":"#/definitions/address2"
        },
        "street":{
            "$ref":"#/definitions/street"
        },
        "zipCode":{
            "$ref":"#/definitions/zipCode"
        },
        "city":{
            "$ref":"#/definitions/city"
        },
        "state":{
            "$ref":"#/definitions/stateResponse"
        },
        "country":{
            "$ref":"#/definitions/country"
        },
        "phoneNumber":{
            "$ref":"#/definitions/phoneNumber"
        },
        "mobileNumber":{
            "$ref":"#/definitions/mobileNumber"
        },
        "email1":{
            "$ref":"#/definitions/email1"
        },
        "email2":{
            "$ref":"#/definitions/email2"
        }
    }
}

Nested Schema : country

Type: object

Country

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 6

  Country Code * `null` if empty

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

  Example: United States

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

Nested Schema : stateResponse

Type: object

State

Show Source

• code(optional): string
  Minimum Length: 1

  Maximum Length: 3

  State Code * `null` if empty State or `Free Text`

  Example: CO
• description(optional): string
  Minimum Length: 1

  Maximum Length: 49

  State Name * `null` if empty `Free Text` * `Corresponding State Name` if has State Code

  Example: Colorado

{
    "description":"State",
    "type":"object",
    "properties":{
        "code":{
            "$ref":"#/definitions/stateCode"
        },
        "description":{
            "$ref":"#/definitions/stateDescriptionResponse"
        }
    }
}

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