Oracle Hospitality Cruise Property Management REST API 23.2.2

Retrieve configured sub department record.

get

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

This is to retrieve the configured sub department codes.

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number

ship Id
subDepartmentCode(required): string

Sub Department Code

Response

Supported Media Types

application/json

200 Response

Root Schema : Configured sub department

Type: object

Title: Configured sub department

Configured sub department record

Show Source

allowCasinoDepartmentPosting: boolean

Posting allow in casino department

Example: true
casinoDepartment: object casinoDepartment

Department in Casino
departmentDiscount: object departmentDiscount

Department Discounts
departmentGrouping: object Department Grouping

Title: Department Grouping

Department Grouping
departmentSecurityLevel: object Department Security Level

Title: Department Security Level

Department Security Level
departmentType: string

Title: Department Type

Default Value: Debit

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Department type. Always equal to Debit

Example: Debit
excludeRevenueOverview: boolean

Exclude from revenue overview

Example: true
glSystemOrigin: object GL System Origin

Title: GL System Origin

GL System Origin
isActive: boolean

Activation status of the sub department: * `true` - sub department is active * `false` - sub department is inactive

Example: true
lastModifiedDate: string

Last modified date

Example: 2022-09-21 17:00:00
mainDepartmentCode: string

Title: Main Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Code

Example: 1001
mainDepartmentDescription: string

Title: Main Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Description

Example: Food and Beverage
nonRefundableCredit: object Non-Refundable Credit

Title: Non-Refundable Credit

Non-Refundable Credit
payrollPayoutTagSignature: string

Tag Signature Capture required during payroll payout * Yes * No * Not Specified

Example: Yes
pbxDepartmentSubsystem: object pbxDepartmentSubsystem

Department in PBX Subsystem
posDepartmentSubsystem: object Department in POS Subsystem

Title: Department in POS Subsystem

Department in POS Subsystem
postingType: string

Title: Posting Type

Posting Type

Example: D Posting Department
subDepartmentCode: string

Title: Sub Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 1001
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Cash Currency Exchange
subDepartmentOtherDescription: string

Title: Sub Department Other Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Other Description

Example: Kad Visa
vatTaxClass: object vatTaxClass

VAT Tax Class

{
    "title":"Configured sub department",
    "description":"Configured sub department record",
    "type":"object",
    "properties":{
        "departmentType":{
            "$ref":"#/definitions/departmentTypeDR"
        },
        "mainDepartmentCode":{
            "$ref":"#/definitions/mainDepartmentCode"
        },
        "mainDepartmentDescription":{
            "$ref":"#/definitions/mainDepartmentDescription"
        },
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        },
        "subDepartmentOtherDescription":{
            "$ref":"#/definitions/subDepartmentOtherDescription"
        },
        "departmentGrouping":{
            "$ref":"#/definitions/departmentGrouping"
        },
        "payrollPayoutTagSignature":{
            "$ref":"#/definitions/payrollPayoutTagSignature"
        },
        "departmentSecurityLevel":{
            "$ref":"#/definitions/departmentSecurityLevel"
        },
        "nonRefundableCredit":{
            "$ref":"#/definitions/nonRefundableCredit"
        },
        "glSystemOrigin":{
            "$ref":"#/definitions/glSystemOrigin"
        },
        "lastModifiedDate":{
            "$ref":"#/definitions/lastModifiedDate"
        },
        "isActive":{
            "$ref":"#/definitions/subDepartmentIsActive"
        },
        "postingType":{
            "$ref":"#/definitions/postingType"
        },
        "posDepartmentSubsystem":{
            "$ref":"#/definitions/posDepartmentSubsystem"
        },
        "pbxDepartmentSubsystem":{
            "$ref":"#/definitions/pbxDepartmentSubsystem"
        },
        "casinoDepartment":{
            "$ref":"#/definitions/casinoDepartment"
        },
        "departmentDiscount":{
            "$ref":"#/definitions/departmentDiscount"
        },
        "vatTaxClass":{
            "$ref":"#/definitions/vatTaxClass"
        },
        "allowCasinoDepartmentPosting":{
            "$ref":"#/definitions/allowCasinoDepartmentPosting"
        },
        "excludeRevenueOverview":{
            "$ref":"#/definitions/excludeRevenueOverview"
        }
    }
}

Nested Schema : casinoDepartment

Type: object

Department in Casino

Show Source

maximumCruiseLimit: integer

Pattern: ^[0-9]*$

Maximum cruise limit

Example: 100
maximumDailyLimit: integer

Pattern: ^[0-9]*$

Maximum daily limit

Example: 10
serviceCharge: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Service charge

Example: 10
serviceChargeDepartment: object subDepartment

Sub Department

{
    "description":"Department in Casino",
    "type":"object",
    "properties":{
        "maximumDailyLimit":{
            "$ref":"#/definitions/maximumDailyLimit"
        },
        "serviceChargeDepartment":{
            "$ref":"#/definitions/subDepartment"
        },
        "serviceCharge":{
            "$ref":"#/definitions/serviceCharge"
        },
        "maximumCruiseLimit":{
            "$ref":"#/definitions/maximumCruiseLimit"
        }
    }
}

Nested Schema : departmentDiscount

Type: object

Department Discounts

Show Source

crewDiscountsDepartment: object subDepartment

Sub Department
guestDiscountsDepartment: object subDepartment

Sub Department

{
    "description":"Department Discounts",
    "type":"object",
    "properties":{
        "guestDiscountsDepartment":{
            "$ref":"#/definitions/subDepartment"
        },
        "crewDiscountsDepartment":{
            "$ref":"#/definitions/subDepartment"
        }
    }
}

Nested Schema : Department Grouping

Type: object

Title: Department Grouping

Department Grouping

Show Source

departmentGroupingCode: string

Title: Department Grouping Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Department Grouping Code

Example: PYT01
departmentGroupingDescription: string

Title: Department Grouping Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Department Grouping Description

Example: Payment Group 1

{
    "title":"Department Grouping",
    "description":"Department Grouping",
    "type":"object",
    "properties":{
        "departmentGroupingCode":{
            "$ref":"#/definitions/departmentGroupingCode"
        },
        "departmentGroupingDescription":{
            "$ref":"#/definitions/departmentGroupingDescription"
        }
    }
}

Nested Schema : Department Security Level

Type: object

Title: Department Security Level

Department Security Level

Show Source

securityLevel: string

Title: Security Level

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Security Level

Example: Credit Department Level 1

{
    "title":"Department Security Level",
    "description":"Department Security Level",
    "type":"object",
    "properties":{
        "securityLevel":{
            "$ref":"#/definitions/securityLevel"
        }
    }
}

Nested Schema : GL System Origin

Type: object

Title: GL System Origin

GL System Origin

Show Source

glControlAccount: string

Title: General Ledger Control Account

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Control Account

Example: abc1234
glDepartment: string

Title: General Ledger Department

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Department

Example: abc1234
glMaterial: string

Title: General Ledger Material

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Material

Example: abc1234
glMpmissue: string

Title: General Ledger Mpmissue

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Mpmissue

Example: abc1234
glOrigin: string

Title: General Ledger Origin

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Origin

Example: abc1234
glSpare: string

Title: General Ledger Spare

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Spare

Example: abc1234
glSubAccount: string

Title: General Ledger Sub Account

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Sub Account

Example: abc1234
glVoyage: string

Title: General Ledger Voyage

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Voyage

Example: abc1234

{
    "title":"GL System Origin",
    "description":"GL System Origin",
    "type":"object",
    "properties":{
        "glOrigin":{
            "$ref":"#/definitions/glOrigin"
        },
        "glDepartment":{
            "$ref":"#/definitions/glDepartment"
        },
        "glControlAccount":{
            "$ref":"#/definitions/glControlAccount"
        },
        "glSubAccount":{
            "$ref":"#/definitions/glSubAccount"
        },
        "glMaterial":{
            "$ref":"#/definitions/glMaterial"
        },
        "glMpmissue":{
            "$ref":"#/definitions/glMpmissue"
        },
        "glVoyage":{
            "$ref":"#/definitions/glVoyage"
        },
        "glSpare":{
            "$ref":"#/definitions/glSpare"
        }
    }
}

Nested Schema : Non-Refundable Credit

Type: object

Title: Non-Refundable Credit

Non-Refundable Credit

Show Source

applyCount: integer

Title: Apply Count

Pattern: ^[0-9]*$

Apply Count

Example: 1
applyValue: integer

Title: Apply Value

Pattern: ^[0-9]*$

Apply Value

Example: 1
collectorDepartment: object Collector Department

Title: Collector Department

Collector Department. Note: only credit department code will be displayed
eligibleDepartments: array eligibleDepartments

Eligible Departments
redirectionAccount: object Redirection Account

Title: Redirection Account

Redirection Account
resetCountPeriod: string

Title: Reset Count Period

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Reset Count Period

Example: Day

{
    "title":"Non-Refundable Credit",
    "description":"Non-Refundable Credit",
    "type":"object",
    "properties":{
        "eligibleDepartments":{
            "$ref":"#/definitions/eligibleDepartments"
        },
        "collectorDepartment":{
            "$ref":"#/definitions/collectorDepartment"
        },
        "resetCountPeriod":{
            "$ref":"#/definitions/resetCountPeriod"
        },
        "redirectionAccount":{
            "$ref":"#/definitions/redirectionAccount"
        },
        "applyCount":{
            "$ref":"#/definitions/applyCount"
        },
        "applyValue":{
            "$ref":"#/definitions/applyValue"
        }
    }
}

Nested Schema : pbxDepartmentSubsystem

Type: object

Department in PBX Subsystem

Show Source

pbxCallType: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

PBX call type

Example: VC: Voice Cell

{
    "description":"Department in PBX Subsystem",
    "type":"object",
    "properties":{
        "pbxCallType":{
            "$ref":"#/definitions/pbxCallType"
        }
    }
}

Nested Schema : Department in POS Subsystem

Type: object

Title: Department in POS Subsystem

Department in POS Subsystem

Show Source

allowDeclineAuthPosting: boolean

Allow posting with declined authorization

Example: true
debitCodeGratuitiesAuto: object subDepartment

Sub Department
debitCodeGratuitiesManual: object subDepartment

Sub Department
debitCodeTaxes: object subDepartment

Sub Department
gratuityServiceTaxDepartment: boolean

Gratuity service/tax department

Example: true
gratuityTip: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Gratuity tip

Example: Tips Waiters
posRevenueCenter: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

POS revenue center

Example: 10
posRevenueCenterDescription: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

POS revenue center description

Example: Sports Bar
posSalesItemizerNo: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

POS sales itemizer number

Example: 1
posSalesPeriod: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

POS sales period

Example: 11

{
    "title":"Department in POS Subsystem",
    "description":"Department in POS Subsystem",
    "type":"object",
    "properties":{
        "posRevenueCenter":{
            "$ref":"#/definitions/posRevenueCenter"
        },
        "posSalesItemizerNo":{
            "$ref":"#/definitions/posSalesItemizerNo"
        },
        "posSalesPeriod":{
            "$ref":"#/definitions/posSalesPeriod"
        },
        "posRevenueCenterDescription":{
            "$ref":"#/definitions/posRevenueCenterDescription"
        },
        "debitCodeGratuitiesManual":{
            "$ref":"#/definitions/subDepartment"
        },
        "debitCodeGratuitiesAuto":{
            "$ref":"#/definitions/subDepartment"
        },
        "debitCodeTaxes":{
            "$ref":"#/definitions/subDepartment"
        },
        "gratuityTip":{
            "$ref":"#/definitions/gratuityTip"
        },
        "gratuityServiceTaxDepartment":{
            "$ref":"#/definitions/gratuityServiceTaxDepartment"
        },
        "allowDeclineAuthPosting":{
            "$ref":"#/definitions/allowDeclineAuthPosting"
        }
    }
}

Nested Schema : vatTaxClass

Type: object

VAT Tax Class

Show Source

vatTaxClassCode: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

VAT tax class code

Example: US-VAT7
vatTaxClassDescription: string

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

VAT tax class description

Example: US VAT

{
    "description":"VAT Tax Class",
    "type":"object",
    "properties":{
        "vatTaxClassCode":{
            "$ref":"#/definitions/vatTaxClassCode"
        },
        "vatTaxClassDescription":{
            "$ref":"#/definitions/vatTaxClassDescription"
        }
    }
}

Nested Schema : subDepartment

Type: object

Sub Department

Show Source

subDepartmentCode: string

Title: Sub Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 1001
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Cash Currency Exchange

{
    "description":"Sub Department",
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        }
    }
}

Nested Schema : Collector Department

Type: object

Title: Collector Department

Collector Department. Note: only credit department code will be displayed

Show Source

subDepartmentCode: string

Title: Sub Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 1001
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Cash Currency Exchange

{
    "title":"Collector Department",
    "description":"Collector Department. Note: only credit department code will be displayed",
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        }
    }
}

Nested Schema : eligibleDepartments

Type: array

Eligible Departments

Show Source

Array of: object items

{
    "description":"Eligible Departments",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "mainDepartmentCode":{
                "$ref":"#/definitions/mainDepartmentCode"
            },
            "mainDepartmentDescription":{
                "$ref":"#/definitions/mainDepartmentDescription"
            },
            "subDepartments":{
                "$ref":"#/definitions/subDepartments"
            }
        }
    }
}

Nested Schema : Redirection Account

Type: object

Title: Redirection Account

Redirection Account

Show Source

systemAccountDescription: string

Title: System Account Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

System Account Description

Example: Wedding Dinner Package
systemAccountNumber: integer

Title: System Account Number

Pattern: ^[0-9]*$

System Account Number

Example: 20310

{
    "title":"Redirection Account",
    "description":"Redirection Account",
    "type":"object",
    "properties":{
        "systemAccountNumber":{
            "$ref":"#/definitions/systemAccountNumber"
        },
        "systemAccountDescription":{
            "$ref":"#/definitions/systemAccountDescription"
        }
    }
}

Nested Schema : items

Type: object

Show Source

mainDepartmentCode: string

Title: Main Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Code

Example: 1001
mainDepartmentDescription: string

Title: Main Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Description

Example: Food and Beverage
subDepartments: array subDepartments

Eligible Sub Departments

{
    "type":"object",
    "properties":{
        "mainDepartmentCode":{
            "$ref":"#/definitions/mainDepartmentCode"
        },
        "mainDepartmentDescription":{
            "$ref":"#/definitions/mainDepartmentDescription"
        },
        "subDepartments":{
            "$ref":"#/definitions/subDepartments"
        }
    }
}

Nested Schema : subDepartments

Type: array

Eligible Sub Departments

Show Source

Array of: object items

{
    "description":"Eligible Sub Departments",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "subDepartmentCode":{
                "$ref":"#/definitions/subDepartmentCode"
            },
            "subDepartmentDescription":{
                "$ref":"#/definitions/subDepartmentDescription"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

subDepartmentCode: string

Title: Sub Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 1001
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Cash Currency Exchange

{
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Limit must not be less than one!"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Limit must not be less than one!"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "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: string
title: string
type: 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

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentDebitCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://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

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}