Jump to

• Request
• Response

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: number
  ship Id
• subDepartmentCode: string
  Sub Department Code

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Configured sub department

Type: object

Title: Configured sub department

Configured sub department record

Show Source

• allowCasinoDepartmentPosting(optional): boolean
  Posting allow in casino department

  Example: true
• casinoDepartment(optional): object casinoDepartment
  Department in Casino
• departmentDiscount(optional): object departmentDiscount
  Department Discounts
• departmentGrouping(optional): object Department Grouping
  Title: Department Grouping

  Department Grouping
• departmentSecurityLevel(optional): object Department Security Level
  Title: Department Security Level

  Department Security Level
• departmentType(optional): string
  Title: Department Type

  Default Value: Debit

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

  Department type. Always equal to Debit

  Example: Debit
• excludeRevenueOverview(optional): boolean
  Exclude from revenue overview

  Example: true
• glSystemOrigin(optional): object GL System Origin
  Title: GL System Origin

  GL System Origin
• isActive(optional): boolean
  Activation status of the user group: * `true` - User group is active * `false` - User group is inactive

  Example: true
• lastModifiedDate(optional): string
  Last modified date

  Example: 2022-09-21 17:00:00
• mainDepartmentCode(optional): string
  Maximum Length: 10

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

  Main Department Code

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

  Main Department Description

  Example: Food and Beverage
• nonRefundableCredit(optional): object Non-Refundable Credit
  Title: Non-Refundable Credit

  Non-Refundable Credit
• payrollPayoutTagSignature(optional): string
  Tag Signature Capture required during payroll payout * Yes * No * Not Specified

  Example: Yes
• pbxDepartmentSubsystem(optional): object pbxDepartmentSubsystem
  Department in PBX Subsystem
• posDepartmentSubsystem(optional): object Department in POS Subsystem
  Title: Department in POS Subsystem

  Department in POS Subsystem
• postingType(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Posting Type

  Example: D Posting Department
• subDepartmentCode(optional): string
  Maximum Length: 10

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

  Sub Department Code

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

  Sub Department Description

  Example: Sports Bar - Food
• subDepartmentOtherDescription(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Sub department other description

  Example: Tiket Perlayaran
• vatTaxClass(optional): object vatTaxClass
  VAT Tax Class

{
    "title":"Configured sub department",
    "description":"Configured sub department record",
    "type":"object",
    "properties":{
        "departmentType":{
            "$ref":"#/definitions/departmentType"
        },
        "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/isActive"
        },
        "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(optional): integer
  Pattern: ^[0-9]*$

  Maximum cruise limit

  Example: 100
• maximumDailyLimit(optional): integer
  Pattern: ^[0-9]*$

  Maximum daily limit

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

  Service charge

  Example: 10
• serviceChargeDepartment(optional): 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(optional): object subDepartment
  Sub Department
• guestDiscountsDepartment(optional): 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(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Department grouping code

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

  Department grouping description

  Example: Group One

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

  Security Level

  Example: Debit 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(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  GL control account

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

  GL department

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

  GL material

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

  GL mpmissue

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

  GL origin

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

  GL spare

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

  GL sub account

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

  GL 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(optional): integer
  Pattern: ^[0-9]*$

  Apply count

  Example: 1
• applyValue(optional): integer
  Pattern: ^[0-9]*$

  Apply value

  Example: 1
• eligibleDepartments(optional): array eligibleDepartments
  Eligible Departments
• redirectionAccount(optional): object redirectionAccount
  Redirection Account
• resetCountPeriod(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Reset count period

  Example: Day

{
    "title":"Non-Refundable Credit",
    "description":"Non-Refundable Credit",
    "type":"object",
    "properties":{
        "eligibleDepartments":{
            "$ref":"#/definitions/eligibleDepartments"
        },
        "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(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-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(optional): boolean
  Allow posting with declined authorization

  Example: true
• debitCodeGratuitiesAuto(optional): object subDepartment
  Sub Department
• debitCodeGratuitiesManual(optional): object subDepartment
  Sub Department
• debitCodeTaxes(optional): object subDepartment
  Sub Department
• gratuityServiceTaxDepartment(optional): boolean
  Gratuity service/tax department

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

  Gratuity tip

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

  POS revenue center

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

  POS revenue center description

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

  POS sales itemizer number

  Example: 1
• posSalesPeriod(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-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(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  VAT tax class code

  Example: US-VAT7
• vatTaxClassDescription(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-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(optional): string
  Maximum Length: 10

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

  Sub Department Code

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

  Sub Department Description

  Example: Sports Bar - Food

{
    "description":"Sub Department",
    "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 : redirectionAccount

Type: object

Redirection Account

Show Source

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

  System account description

  Example: Prepaid Wedding Package
• systemAccountNumber(optional): integer
  Pattern: ^[0-9]*$

  System account number

  Example: 20312

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

Nested Schema : items

Type: object

Show Source

• mainDepartmentCode(optional): string
  Maximum Length: 10

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

  Main Department Code

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

  Main Department Description

  Example: Food and Beverage
• subDepartments(optional): 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(optional): string
  Maximum Length: 10

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

  Sub Department Code

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

  Sub Department Description

  Example: Sports Bar - Food

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

400 Response

Bad Request

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): string

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

Back to Top