1. Oracle Hospitality Cruise REST API
  2. Tasks
  3. Configurations
  4. Address State Code

Retrieve configured Address State code records

get

/spms/v2/ships/{shipId}/configurations/profiles/addressStateCodes

This is to retrieve the configured Address State codes.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : Oracle Response
Type: object
Title: Oracle Response
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "countryCode":"US",
        "countryName":"United States",
        "stateCodeId":17008,
        "stateCode":"IA",
        "stateCodeDescription":"Iowa",
        "cityShortName":"GWX",
        "cityName":"Glenwood"
    }
]
Nested Schema : addressStateCodes
Type: array
Address State Codes details
Show Source
Example:
[
    {
        "countryCode":"US",
        "countryName":"United States",
        "stateCodeId":17008,
        "stateCode":"IA",
        "stateCodeDescription":"Iowa",
        "cityShortName":"GWX",
        "cityName":"Glenwood"
    }
]
Nested Schema : AddressStateCodesDetails
Type: object
Address State Codes Details
Show Source

204 Response

No Content

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

Valid token is required to access this resource
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

403 Response

You are forbidden to use this API
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

404 Response

Not Found
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Not Found",
    "detail":"Reservation not found",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

405 Response

This method is not available
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6"
}
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:
{
    "title":"Not Acceptable",
    "detail":"HTTP not acceptable for this resource",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7"
}
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:
{
    "title":"Gone",
    "detail":"HTTP gone for this resource",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11"
}
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:
{
    "title":"Unsupported Media Type",
    "detail":"HTTP unsupported media type for this resource",
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source

500 Response

Error occured while processing this request
Body ()
Root Schema : schema
Match All
Show Source
Example:
{
    "title":"Internal Server Error",
    "details":"Issue fulfilling request. Please retry or contact support",
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1"
}
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