1. Oracle Hospitality Cruise Property Management REST API 23.2.2
  2. Tasks
  3. Financials
  4. Configuration
  5. Sub Departments

Retrieve configured Sub Department record.

get

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

This is to retrieve the configured Sub Department Codes.

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : List of Sub Departments
Type: object
Title: List of Sub Departments
List of Sub Departments
Show Source
Nested Schema : items
Type: array
Show Source
Example:
[
    {
        "subDepartmentCode":"1001",
        "subDepartmentDescription":"Cash Currency Exchange",
        "mainDepartmentCode":"1002",
        "mainDepartmentDescription":"Cash",
        "departmentType":"C",
        "posting Type":"",
        "paymentType":"CB Cash Payment",
        "isActive":true
    },
    {
        "subDepartmentCode":"1003",
        "subDepartmentDescription":"Casino Bar - Beverage",
        "mainDepartmentCode":"1004",
        "mainDepartmentDescription":"Casino Bar",
        "departmentType":"D",
        "posting Type":"D Posting Department",
        "paymentType":"",
        "isActive":true
    }
]
Nested Schema : Sub Departments
Type: object
Title: Sub Departments
Sub Departments
Show Source
  • Title: Department Type
    Department Type: * `D` - Debit * `C` - Credit
    Example: D
  • Activation status of the sub department: * `true` - sub department is active * `false` - sub department is inactive
    Example: true
  • Title: Main Department Code
    Maximum Length: 10
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Main Department Code
    Example: 1001
  • Title: Main Department Description
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Main Department Description
    Example: Food and Beverage
  • Title: Payment Type
    Payment Type
    Example: CB Cash Payment
  • Title: Posting Type
    Posting Type
    Example: D Posting Department
  • Title: Sub Department Code
    Maximum Length: 10
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Sub Department Code
    Example: 1001
  • Title: Sub Department Description
    Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$
    Sub Department Description
    Example: Cash Currency Exchange

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 status"
}
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":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Step does not exist"
}
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

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 Unavailable.  Try again later"
}
Nested Schema : Error Response
Type: object
Title: Error Response
Error Response returned when encountered error
Show Source
Back to Top