1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Configurations
  4. Vendor

Retrieve configured vendor record

get

/spms/v2/ships/{shipId}/configurations/vendor

This is to retrieve the configured vendor.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

Ok
Body ()
Root Schema : Vendor success Oracle Responses list
Type: object
Title: Vendor success Oracle Responses list
The wrapper object when returning successful values in Oracle standard
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "id":"281",
        "lastName":"watt",
        "firstName":"Elma",
        "salutation":"Miss",
        "companyName":null,
        "contactDetails":{
            "address":"Firestone Boulevard, La Mirada",
            "street":"Street number 13",
            "zipCode":"123456",
            "state":"Victoria",
            "city":"Melbourne",
            "country":{
                "code":"AUS",
                "description":"Australia"
            },
            "comment":"Shore Excursion sold on board.",
            "vendorType":"E",
            "currency":{
                "code":"9503",
                "description":"Australian DOLLAR",
                "paymentType":"CF",
                "exchangeRate":"1.24"
            }
        },
        "isActive":true
    },
    {
        "id":"308",
        "lastName":null,
        "firstName":"Carlos",
        "salutation":null,
        "companyName":"Blue Line Tours",
        "contactDetails":{
            "address":"Suite no 12, Knowledge city",
            "street":"Street number 14",
            "zipCode":"563124",
            "state":"Berlin",
            "city":"Berlin",
            "country":{
                "code":"DE",
                "description":"Germany"
            },
            "comment":"Blue Line Tours does not have any branch",
            "vendorType":"C",
            "currency":{
                "code":"9520",
                "description":"EURO",
                "paymentType":"CF",
                "exchangeRate":"0.8302"
            }
        },
        "isActive":true
    }
]
Nested Schema : configurationVendor
Type: object
configurationVendor
Show Source
  • Minimum Length: 1
    Maximum Length: 200
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    "Vendor comment" * `null` if empty
    Example: Vendor comments 1
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor company name" * `null` if empty
    Example: Antigua Vacation
  • contactDetails
    Vendor contact details
  • currency
    vendor currency details
  • Minimum Length: 1
    Maximum Length: 40
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor firstName" * `null` if empty
    Example: Elma
  • Minimum Value: 1
    Pattern: ^[0-9]*$
    "Vendor ID"
    Example: 12345678
  • This is to indicate switch to Active / InActive Vendor (default value: true) * `true` - Active Vendor * `false` - InActive Vendor
    Example: true
  • Minimum Length: 1
    Maximum Length: 40
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor lastName" * `null` if empty
    Example: Pigott
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor salutation" * `null` if empty
    Example: Mr
  • Minimum Length: 1
    Maximum Length: 1
    Pattern: ^[E|C|e|c]$
    "Vendor type" * `null` if empty
    Example: E
Nested Schema : contactDetails
Type: object
Vendor contact details
Show Source
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    "Vendor address" * `null` if empty
    Example: Vendor address 2
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    "Vendor city" * `null` if empty
    Example: Melbourne
  • country
    Country
  • Minimum Length: 1
    Maximum Length: 49
    Pattern: ^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$
    "Vendor Email address" * `null` if empty
    Example: email@example.com
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[0-9+-]*$
    "Vendor Fax number" * `null` if empty
    Example: 4413563590
  • Minimum Length: 1
    Maximum Length: 20
    Pattern: ^[0-9+-]*$
    "Vendor Phone number" * `null` if empty
    Example: 4413563590
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    "Vendor state" * `null` if empty
    Example: Victoria
  • Minimum Length: 1
    Maximum Length: 30
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    "Vendor street" * `null` if empty
    Example: Vendor street
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    "Vendor zip code" * `null` if empty
    Example: Vendor zip code
Nested Schema : currency
Type: object
vendor currency details
Show Source
  • Vendor currency exchangeRate
    Example: 1.2753
  • Minimum Length: 2
    Maximum Length: 2
    Pattern: ^[a-zA-Z]+$
    "Payment type" * `null` if empty
    Example: CF
  • Minimum Length: 1
    Maximum Length: 10
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor currency department code" * `null` if empty
    Example: 9520
  • Minimum Length: 1
    Maximum Length: 50
    Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor currency department description" * `null` if empty
    Example: AUSTRALIAN DOLLAR
Nested Schema : country
Type: object
Country
Show Source
  • Minimum Length: 1
    Maximum Length: 6
    Pattern: ^[ A-Za-z0-9,'_@./#&+-]*$
    "Vendor country code"
    Example: MY
  • Pattern: ^[a-zA-Z0-9 _,\\?/\\.\\-\\\\+\\*\n~!@#$%&{}\\[\\]()=<>\\|\\^\\'\\\":;@`]*$
    "Vendor country description"
    Example: Malaysia

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":"The parameter 'shipId' has incorrect format"
}
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":"You are forbidden to use this API"
}
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:
{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Ship Id could not be found"
}
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