1. Oracle Hospitality Cruise Property Management REST API 23.1.4
  2. Tasks
  3. Profiles
  4. Temporary Addresses

Create a new guest temporary address by profile ID

post

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

This is to create a new guest's temporary address

Request

Supported Media Types
Path Parameters
Body ()
Temporary Address Object
Root Schema : Profile Temporary Address Request Body
Type: object
Title: Profile Temporary Address Request Body
Profile Temporary Address and Other Contact Details
Show Source
  • Minimum Length: 1
    Maximum Length: 100
    Address Line 1 * `null` if empty
    Example: 2066 Duncan Avenue
  • Minimum Length: 1
    Maximum Length: 100
    Address Line 2 * `null` if empty
    Example: Mount Pleasant
  • Minimum Length: 1
    Maximum Length: 30
    City * `null` if empty
    Example: Denver
  • Email
    Example: maya_walters@mail.com
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[0-9]*$
    Phone Number * `null` if empty
    Example: 3238325152
  • state
    State
  • Minimum Length: 1
    Maximum Length: 30
    Street * `null` if empty
    Example: High Street
  • Minimum Length: 1
    Maximum Length: 10
    Zip Code * `null` if empty
    Example: 80014
Nested Schema : state
Type: object
State
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Profile Temporary Address Response Body
Type: object
Title: Profile Temporary Address Response Body
Profile Temporary Address and Other Contact Details
Show Source
  • Minimum Length: 1
    Maximum Length: 100
    Address Line 1 * `null` if empty
    Example: 2066 Duncan Avenue
  • Minimum Length: 1
    Maximum Length: 100
    Address Line 2 * `null` if empty
    Example: Mount Pleasant
  • Minimum Length: 1
    Maximum Length: 30
    City * `null` if empty
    Example: Denver
  • Email
    Example: maya_walters@mail.com
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[0-9]*$
    Phone Number * `null` if empty
    Example: 3238325152
  • Minimum Length: 1
    Pattern: ^[0-9]*$
    Profile Id
    Example: 12345
  • state
    State
  • Minimum Length: 1
    Maximum Length: 30
    Street * `null` if empty
    Example: High Street
  • Minimum Length: 1
    Maximum Length: 10
    Zip Code * `null` if empty
    Example: 80014
Nested Schema : state
Type: object
State
Show Source

400 Response

Bad Request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Invalid parameter(s) passed in"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

401 Response

Unauthorized
Body ()
Root Schema : schema
Match All
Show Source
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

403 Response

Forbidden
Body ()
Root Schema : schema
Match All
Show Source
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

405 Response

Method Not Allowed
Body ()
Root Schema : schema
Match All
Show Source
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

406 Response

Not Acceptable
Body ()
Root Schema : schema
Match All
Show Source
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

410 Response

Gone
Body ()
Root Schema : schema
Match All
Show Source
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

415 Response

Unsupported Media Type
Body ()
Root Schema : schema
Match All
Show Source
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

500 Response

Internal Server Error
Body ()
Root Schema : schema
Match All
Show Source
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

501 Response

Not Implemented
Body ()
Root Schema : schema
Match All
Show Source
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

503 Response

Service Unavailable
Body ()
Root Schema : schema
Match All
Show Source
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
Back to Top