Jump to

• Request
• Response

Update sales for the bookable tour

put

/spms/v2/ships/{shipId}/configurations/excursions/bookableTours/{bookableTourId}/setup/sales

This is to update sales for the bookable tour

Request

Supported Media Types

• application/json

Path Parameters

• bookableTourId: integer
  bookable tour Id
• shipId: integer
  ship Id

Body ()

Root Schema : Update sales for bookable tours

Type: object

Title: Update sales for bookable tours

Show Source

• salesPosting(optional): object salesPosting
• salesTaxAndFees(optional): object salesTaxAndFees
• vatPostingSplit(optional): array vatPostingSplit
• vatReportingSplit(optional): object vatReportingSplit

{
    "title":"Update sales for bookable tours",
    "type":"object",
    "properties":{
        "salesPosting":{
            "type":"object",
            "properties":{
                "regularSalesPostingDepartmentId":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8001",
                    "description":"Bookable Tour Regular Sales Posting Department Id"
                },
                "prepaidSalesPostingDepartment":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8001",
                    "description":"Bookable Tour Prepaid Sales Posting Department"
                },
                "kioskSalesPostingDepartment":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8001",
                    "description":"Bookable Tour Kiosk Sales Posting Department"
                },
                "fcuiSalesPostingDepartment":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8001",
                    "description":"Bookable Tour Fcui Sales Posting Department Id"
                },
                "voidPrepaidSalesPostingDepartment":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8001",
                    "description":"Bookable Tour Void Prepaid Sales Posting Department"
                },
                "cancellationFeeSalesPostingDepartmentId":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8001",
                    "description":"Bookable Tour Cancellation Fee Sales Posting Department Id"
                },
                "cancellationFeeSalesPostingDepartmentValue":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":1,
                    "description":"Bookable Tour Cancellation Fee Sales Posting Department Value"
                },
                "cancellationFeeSalesPostingDepartmentType":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":1,
                    "pattern":"^[P|V]*$",
                    "example":"P",
                    "description":"Bookable Tour Cancellation Fee Sales Posting  Department Type"
                }
            }
        },
        "salesTaxAndFees":{
            "type":"object",
            "properties":{
                "salesTaxDepartment1Id":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8006",
                    "description":"Bookable Tour Sales Tax Department 1 Id"
                },
                "salesTaxDepartment1Value":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":10,
                    "description":"Bookable Tour Sales Tax Department 1 Value"
                },
                "salesTaxDepartment1Type":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":1,
                    "pattern":"^[P|V]$",
                    "example":"P",
                    "description":"Bookable Tour Sales Tax Department 1 Type"
                },
                "salesTaxDepartment2Id":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8007",
                    "description":"Bookable Tour Sales Tax Department 2 Id"
                },
                "salesTaxDepartment2Value":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":1,
                    "description":"Bookable Tour Sales Tax Department 2 Value"
                },
                "salesTaxDepartment2Type":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":1,
                    "pattern":"^[P|V]$",
                    "example":"P",
                    "description":"Bookable Tour Sales Tax Department 2 Type"
                },
                "salesFeesPostingDepartmentId":{
                    "type":"string",
                    "minLength":0,
                    "maxLength":10,
                    "pattern":"^[a-zA-Z0-9 ]*$",
                    "example":"8009",
                    "description":"Bookable Tour Sales Fees Posting Department Id"
                },
                "salesFeesPostingDepartmentValue":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":5,
                    "description":"Bookable Tour Sales Fees Posting Department Value"
                },
                "salesFeesPostingDepartmentType":{
                    "type":"string",
                    "minLength":1,
                    "maxLength":1,
                    "pattern":"^[P|V]$",
                    "example":"P",
                    "description":"Bookable Tour Sales Fees Posting Department Type"
                }
            }
        },
        "vatReportingSplit":{
            "type":"object",
            "properties":{
                "vatReportingSplit1Rate":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":116.12,
                    "description":"Bookable Tour Vat Reporting Split 1 Rate"
                },
                "vatReportingSplit1Price":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1.0E20,
                    "example":1,
                    "description":"Bookable Tour Vat Reporting Split 1 Price"
                },
                "vatReportingSplit2Rate":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":117.23,
                    "description":"Bookable Tour Vat Reporting Split 2 Rate"
                },
                "vatReportingSplit2Price":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1.0E20,
                    "example":0.5,
                    "description":"Bookable Tour Vat Reporting Split 2 Price"
                },
                "vatReportingSplit3Rate":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":118.2,
                    "description":"Bookable Tour Vat Reporting Split 3 Rate"
                },
                "vatReportingSplit3Price":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1.0E20,
                    "example":1,
                    "description":"Bookable Tour Vat Reporting Split 3 Price"
                },
                "vatReportingSplit4Rate":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1000000,
                    "example":50,
                    "description":"Bookable Tour Vat Reporting Split 4 Rate"
                },
                "vatReportingSplit4Price":{
                    "type":"number",
                    "minimum":0,
                    "maximum":1.0E20,
                    "example":3,
                    "description":"Bookable Tour Vat Reporting Split 4 Price"
                }
            }
        },
        "vatPostingSplit":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "vatPostingSplitId":{
                        "type":"number",
                        "format":"int64",
                        "minimum":1,
                        "maximum":999999999,
                        "example":12345678,
                        "description":"VAT posting split id"
                    },
                    "vatPostingDepartmentCode":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":10,
                        "pattern":"^[a-zA-Z0-9 ]*$",
                        "example":"8007",
                        "description":"VAT Posting Department Code (must be debit department and cannot be disabled)"
                    },
                    "vatAmountAdult":{
                        "type":"number",
                        "minimum":1.0E-4,
                        "maximum":1.0E18,
                        "example":20.5,
                        "description":"VAT Amount for adult"
                    },
                    "vatAmountChild":{
                        "type":"number",
                        "minimum":1.0E-4,
                        "maximum":1.0E18,
                        "example":10.5,
                        "description":"VAT Amount for child"
                    },
                    "bookingType":{
                        "type":"string",
                        "minLength":0,
                        "maxLength":10,
                        "pattern":"^[a-zA-Z0-9 ]*$",
                        "example":"Regular",
                        "description":"Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive"
                    }
                },
                "required":[
                    "vatPostingSplitId",
                    "vatPostingDepartmentCode",
                    "vatAmountAdult",
                    "vatAmountChild",
                    "bookingType"
                ]
            }
        }
    }
}

Nested Schema : salesPosting

Type: object

Show Source

• cancellationFeeSalesPostingDepartmentId(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Cancellation Fee Sales Posting Department Id

  Example: 8001
• cancellationFeeSalesPostingDepartmentType(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[P|V]*$

  Bookable Tour Cancellation Fee Sales Posting Department Type

  Example: P
• cancellationFeeSalesPostingDepartmentValue(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Cancellation Fee Sales Posting Department Value

  Example: 1
• fcuiSalesPostingDepartment(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Fcui Sales Posting Department Id

  Example: 8001
• kioskSalesPostingDepartment(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Kiosk Sales Posting Department

  Example: 8001
• prepaidSalesPostingDepartment(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Prepaid Sales Posting Department

  Example: 8001
• regularSalesPostingDepartmentId(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Regular Sales Posting Department Id

  Example: 8001
• voidPrepaidSalesPostingDepartment(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Void Prepaid Sales Posting Department

  Example: 8001

{
    "type":"object",
    "properties":{
        "regularSalesPostingDepartmentId":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8001",
            "description":"Bookable Tour Regular Sales Posting Department Id"
        },
        "prepaidSalesPostingDepartment":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8001",
            "description":"Bookable Tour Prepaid Sales Posting Department"
        },
        "kioskSalesPostingDepartment":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8001",
            "description":"Bookable Tour Kiosk Sales Posting Department"
        },
        "fcuiSalesPostingDepartment":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8001",
            "description":"Bookable Tour Fcui Sales Posting Department Id"
        },
        "voidPrepaidSalesPostingDepartment":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8001",
            "description":"Bookable Tour Void Prepaid Sales Posting Department"
        },
        "cancellationFeeSalesPostingDepartmentId":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8001",
            "description":"Bookable Tour Cancellation Fee Sales Posting Department Id"
        },
        "cancellationFeeSalesPostingDepartmentValue":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":1,
            "description":"Bookable Tour Cancellation Fee Sales Posting Department Value"
        },
        "cancellationFeeSalesPostingDepartmentType":{
            "type":"string",
            "minLength":1,
            "maxLength":1,
            "pattern":"^[P|V]*$",
            "example":"P",
            "description":"Bookable Tour Cancellation Fee Sales Posting  Department Type"
        }
    }
}

Nested Schema : salesTaxAndFees

Type: object

Show Source

• salesFeesPostingDepartmentId(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Sales Fees Posting Department Id

  Example: 8009
• salesFeesPostingDepartmentType(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[P|V]$

  Bookable Tour Sales Fees Posting Department Type

  Example: P
• salesFeesPostingDepartmentValue(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Sales Fees Posting Department Value

  Example: 5
• salesTaxDepartment1Id(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Sales Tax Department 1 Id

  Example: 8006
• salesTaxDepartment1Type(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[P|V]$

  Bookable Tour Sales Tax Department 1 Type

  Example: P
• salesTaxDepartment1Value(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Sales Tax Department 1 Value

  Example: 10
• salesTaxDepartment2Id(optional): string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Bookable Tour Sales Tax Department 2 Id

  Example: 8007
• salesTaxDepartment2Type(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Pattern: ^[P|V]$

  Bookable Tour Sales Tax Department 2 Type

  Example: P
• salesTaxDepartment2Value(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Sales Tax Department 2 Value

  Example: 1

{
    "type":"object",
    "properties":{
        "salesTaxDepartment1Id":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8006",
            "description":"Bookable Tour Sales Tax Department 1 Id"
        },
        "salesTaxDepartment1Value":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":10,
            "description":"Bookable Tour Sales Tax Department 1 Value"
        },
        "salesTaxDepartment1Type":{
            "type":"string",
            "minLength":1,
            "maxLength":1,
            "pattern":"^[P|V]$",
            "example":"P",
            "description":"Bookable Tour Sales Tax Department 1 Type"
        },
        "salesTaxDepartment2Id":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8007",
            "description":"Bookable Tour Sales Tax Department 2 Id"
        },
        "salesTaxDepartment2Value":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":1,
            "description":"Bookable Tour Sales Tax Department 2 Value"
        },
        "salesTaxDepartment2Type":{
            "type":"string",
            "minLength":1,
            "maxLength":1,
            "pattern":"^[P|V]$",
            "example":"P",
            "description":"Bookable Tour Sales Tax Department 2 Type"
        },
        "salesFeesPostingDepartmentId":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8009",
            "description":"Bookable Tour Sales Fees Posting Department Id"
        },
        "salesFeesPostingDepartmentValue":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":5,
            "description":"Bookable Tour Sales Fees Posting Department Value"
        },
        "salesFeesPostingDepartmentType":{
            "type":"string",
            "minLength":1,
            "maxLength":1,
            "pattern":"^[P|V]$",
            "example":"P",
            "description":"Bookable Tour Sales Fees Posting Department Type"
        }
    }
}

Nested Schema : vatPostingSplit

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "vatPostingSplitId":{
                "type":"number",
                "format":"int64",
                "minimum":1,
                "maximum":999999999,
                "example":12345678,
                "description":"VAT posting split id"
            },
            "vatPostingDepartmentCode":{
                "type":"string",
                "minLength":0,
                "maxLength":10,
                "pattern":"^[a-zA-Z0-9 ]*$",
                "example":"8007",
                "description":"VAT Posting Department Code (must be debit department and cannot be disabled)"
            },
            "vatAmountAdult":{
                "type":"number",
                "minimum":1.0E-4,
                "maximum":1.0E18,
                "example":20.5,
                "description":"VAT Amount for adult"
            },
            "vatAmountChild":{
                "type":"number",
                "minimum":1.0E-4,
                "maximum":1.0E18,
                "example":10.5,
                "description":"VAT Amount for child"
            },
            "bookingType":{
                "type":"string",
                "minLength":0,
                "maxLength":10,
                "pattern":"^[a-zA-Z0-9 ]*$",
                "example":"Regular",
                "description":"Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive"
            }
        },
        "required":[
            "vatPostingSplitId",
            "vatPostingDepartmentCode",
            "vatAmountAdult",
            "vatAmountChild",
            "bookingType"
        ]
    }
}

Nested Schema : vatReportingSplit

Type: object

Show Source

• vatReportingSplit1Price(optional): number
  Minimum Value: 0

  Maximum Value: 1.0E20

  Bookable Tour Vat Reporting Split 1 Price

  Example: 1
• vatReportingSplit1Rate(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Vat Reporting Split 1 Rate

  Example: 116.12
• vatReportingSplit2Price(optional): number
  Minimum Value: 0

  Maximum Value: 1.0E20

  Bookable Tour Vat Reporting Split 2 Price

  Example: 0.5
• vatReportingSplit2Rate(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Vat Reporting Split 2 Rate

  Example: 117.23
• vatReportingSplit3Price(optional): number
  Minimum Value: 0

  Maximum Value: 1.0E20

  Bookable Tour Vat Reporting Split 3 Price

  Example: 1
• vatReportingSplit3Rate(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Vat Reporting Split 3 Rate

  Example: 118.2
• vatReportingSplit4Price(optional): number
  Minimum Value: 0

  Maximum Value: 1.0E20

  Bookable Tour Vat Reporting Split 4 Price

  Example: 3
• vatReportingSplit4Rate(optional): number
  Minimum Value: 0

  Maximum Value: 1000000

  Bookable Tour Vat Reporting Split 4 Rate

  Example: 50

{
    "type":"object",
    "properties":{
        "vatReportingSplit1Rate":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":116.12,
            "description":"Bookable Tour Vat Reporting Split 1 Rate"
        },
        "vatReportingSplit1Price":{
            "type":"number",
            "minimum":0,
            "maximum":1.0E20,
            "example":1,
            "description":"Bookable Tour Vat Reporting Split 1 Price"
        },
        "vatReportingSplit2Rate":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":117.23,
            "description":"Bookable Tour Vat Reporting Split 2 Rate"
        },
        "vatReportingSplit2Price":{
            "type":"number",
            "minimum":0,
            "maximum":1.0E20,
            "example":0.5,
            "description":"Bookable Tour Vat Reporting Split 2 Price"
        },
        "vatReportingSplit3Rate":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":118.2,
            "description":"Bookable Tour Vat Reporting Split 3 Rate"
        },
        "vatReportingSplit3Price":{
            "type":"number",
            "minimum":0,
            "maximum":1.0E20,
            "example":1,
            "description":"Bookable Tour Vat Reporting Split 3 Price"
        },
        "vatReportingSplit4Rate":{
            "type":"number",
            "minimum":0,
            "maximum":1000000,
            "example":50,
            "description":"Bookable Tour Vat Reporting Split 4 Rate"
        },
        "vatReportingSplit4Price":{
            "type":"number",
            "minimum":0,
            "maximum":1.0E20,
            "example":3,
            "description":"Bookable Tour Vat Reporting Split 4 Price"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• bookingType: string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive

  Example: Regular
• vatAmountAdult: number
  Minimum Value: 1.0E-4

  Maximum Value: 1.0E18

  VAT Amount for adult

  Example: 20.5
• vatAmountChild: number
  Minimum Value: 1.0E-4

  Maximum Value: 1.0E18

  VAT Amount for child

  Example: 10.5
• vatPostingDepartmentCode: string
  Minimum Length: 0

  Maximum Length: 10

  Pattern: ^[a-zA-Z0-9 ]*$

  VAT Posting Department Code (must be debit department and cannot be disabled)

  Example: 8007
• vatPostingSplitId: number(int64)
  Minimum Value: 1

  Maximum Value: 999999999

  VAT posting split id

  Example: 12345678

{
    "type":"object",
    "properties":{
        "vatPostingSplitId":{
            "type":"number",
            "format":"int64",
            "minimum":1,
            "maximum":999999999,
            "example":12345678,
            "description":"VAT posting split id"
        },
        "vatPostingDepartmentCode":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"8007",
            "description":"VAT Posting Department Code (must be debit department and cannot be disabled)"
        },
        "vatAmountAdult":{
            "type":"number",
            "minimum":1.0E-4,
            "maximum":1.0E18,
            "example":20.5,
            "description":"VAT Amount for adult"
        },
        "vatAmountChild":{
            "type":"number",
            "minimum":1.0E-4,
            "maximum":1.0E18,
            "example":10.5,
            "description":"VAT Amount for child"
        },
        "bookingType":{
            "type":"string",
            "minLength":0,
            "maxLength":10,
            "pattern":"^[a-zA-Z0-9 ]*$",
            "example":"Regular",
            "description":"Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive"
        }
    },
    "required":[
        "vatPostingSplitId",
        "vatPostingDepartmentCode",
        "vatAmountAdult",
        "vatAmountChild",
        "bookingType"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Bookable Tour Sales

Type: object

Title: Bookable Tour Sales

Bookable Tour Sales

Show Source

• salesPosting(optional): object salesPosting
• salesTaxAndFees(optional): object salesTaxAndFees
• vatPostingSplit(optional): array vatPostingSplit
• vatReportingSplit(optional): object vatReportingSplit

{
    "title":"Bookable Tour Sales",
    "description":"Bookable Tour Sales",
    "type":"object",
    "properties":{
        "salesPosting":{
            "type":"object",
            "properties":{
                "regularSalesPostingDepartmentId":{
                    "type":"string",
                    "example":"8001",
                    "description":"Bookable Tour Regular Sales Posting Department Id"
                },
                "prepaidSalesPostingDepartment":{
                    "type":"string",
                    "example":"8001",
                    "description":"Bookable Tour Prepaid Sales Posting Department"
                },
                "kioskSalesPostingDepartment":{
                    "type":"string",
                    "example":"8001",
                    "description":"Bookable Tour Kiosk Sales Posting Department"
                },
                "fcuiSalesPostingDepartment":{
                    "type":"string",
                    "example":"8001",
                    "description":"Bookable Tour Fcui Sales Posting Department Id"
                },
                "voidPrepaidSalesPostingDepartment":{
                    "type":"string",
                    "example":"8001",
                    "description":"Bookable Tour Void Prepaid Sales Posting Department"
                },
                "cancellationFeeSalesPostingDepartmentId":{
                    "type":"string",
                    "example":"8001",
                    "description":"Bookable Tour Cancellation Fee Sales Posting Department Id"
                },
                "cancellationFeeSalesPostingDepartmentValue":{
                    "type":"integer",
                    "example":1,
                    "description":"Bookable Tour Cancellation Fee Sales Posting Department Value"
                },
                "cancellationFeeSalesPostingDepartmentType":{
                    "type":"string",
                    "example":"P",
                    "description":"Bookable Tour Cancellation Fee Sales Posting Department Type"
                }
            }
        },
        "salesTaxAndFees":{
            "type":"object",
            "properties":{
                "salesTaxDepartment1Id":{
                    "type":"string",
                    "example":"8006",
                    "description":"Bookable Tour Sales Tax Department 1 Id"
                },
                "salesTaxDepartment1Value":{
                    "type":"number",
                    "example":10,
                    "description":"Bookable Tour Sales Tax Department 1 Value"
                },
                "salesTaxDepartment1Type":{
                    "type":"string",
                    "example":"P",
                    "description":"Bookable Tour Sales Tax Department 1 Type"
                },
                "salesTaxDepartment2Id":{
                    "type":"string",
                    "example":"8007",
                    "description":"Bookable Tour Sales Tax Department 2 Id"
                },
                "salesTaxDepartment2Value":{
                    "type":"number",
                    "example":1,
                    "description":"Bookable Tour Sales Tax Department 2 Value"
                },
                "salesTaxDepartment2Type":{
                    "type":"string",
                    "example":"P",
                    "description":"Bookable Tour Sales Tax Department 2 Type"
                },
                "salesFeesPostingDepartmentId":{
                    "type":"string",
                    "example":"8009",
                    "description":"Bookable Tour Sales Fees Posting Department Id"
                },
                "salesFeesPostingDepartmentValue":{
                    "type":"number",
                    "example":5,
                    "description":"Bookable Tour Sales Fees Posting Department Value"
                },
                "salesFeesPostingDepartmentType":{
                    "type":"string",
                    "example":"P",
                    "description":"Bookable Tour Sales Fees Posting Department Type"
                }
            }
        },
        "vatReportingSplit":{
            "type":"object",
            "properties":{
                "vatReportingSplit1Rate":{
                    "type":"number",
                    "example":116.12,
                    "description":"Bookable Tour Vat Reporting Split 1 Rate"
                },
                "vatReportingSplit1Price":{
                    "type":"number",
                    "example":1,
                    "description":"Bookable Tour Vat Reporting Split 1 Price"
                },
                "vatReportingSplit2Rate":{
                    "type":"number",
                    "example":117.23,
                    "description":"Bookable Tour Vat Reporting Split 2 Rate"
                },
                "vatReportingSplit2Price":{
                    "type":"number",
                    "example":0.5,
                    "description":"Bookable Tour Vat Reporting Split 2 Price"
                },
                "vatReportingSplit3Rate":{
                    "type":"number",
                    "example":118.2,
                    "description":"Bookable Tour Vat Reporting Split 3 Rate"
                },
                "vatReportingSplit3Price":{
                    "type":"number",
                    "example":1,
                    "description":"Bookable Tour Vat Reporting Split 3 Price"
                },
                "vatReportingSplit4Rate":{
                    "type":"number",
                    "example":50,
                    "description":"Bookable Tour Vat Reporting Split 4 Rate"
                },
                "vatReportingSplit4Price":{
                    "type":"number",
                    "example":3,
                    "description":"Bookable Tour Vat Reporting Split 4 Price"
                }
            }
        },
        "vatPostingSplit":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "vatPostingSplitId":{
                        "type":"number",
                        "example":12345678,
                        "description":"VAT posting split id"
                    },
                    "vatPostingDepartmentCode":{
                        "type":"string",
                        "example":"8007",
                        "description":"VAT Posting Department Code"
                    },
                    "vatPostingDepartmentName":{
                        "type":"string",
                        "example":"American Express",
                        "description":"VAT Posting Department Name"
                    },
                    "vatTaxRate":{
                        "type":"number",
                        "example":3,
                        "description":"VAT percentage"
                    },
                    "vatAmountAdult":{
                        "type":"number",
                        "example":20.5,
                        "description":"VAT Amount for adult"
                    },
                    "vatAmountChild":{
                        "type":"number",
                        "example":10.5,
                        "description":"VAT Amount for child"
                    },
                    "bookingType":{
                        "type":"string",
                        "example":"Regular",
                        "description":"Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive"
                    }
                }
            }
        }
    }
}

Nested Schema : salesPosting

Type: object

Show Source

• cancellationFeeSalesPostingDepartmentId(optional): string
  Bookable Tour Cancellation Fee Sales Posting Department Id

  Example: 8001
• cancellationFeeSalesPostingDepartmentType(optional): string
  Bookable Tour Cancellation Fee Sales Posting Department Type

  Example: P
• cancellationFeeSalesPostingDepartmentValue(optional): integer
  Bookable Tour Cancellation Fee Sales Posting Department Value

  Example: 1
• fcuiSalesPostingDepartment(optional): string
  Bookable Tour Fcui Sales Posting Department Id

  Example: 8001
• kioskSalesPostingDepartment(optional): string
  Bookable Tour Kiosk Sales Posting Department

  Example: 8001
• prepaidSalesPostingDepartment(optional): string
  Bookable Tour Prepaid Sales Posting Department

  Example: 8001
• regularSalesPostingDepartmentId(optional): string
  Bookable Tour Regular Sales Posting Department Id

  Example: 8001
• voidPrepaidSalesPostingDepartment(optional): string
  Bookable Tour Void Prepaid Sales Posting Department

  Example: 8001

{
    "type":"object",
    "properties":{
        "regularSalesPostingDepartmentId":{
            "type":"string",
            "example":"8001",
            "description":"Bookable Tour Regular Sales Posting Department Id"
        },
        "prepaidSalesPostingDepartment":{
            "type":"string",
            "example":"8001",
            "description":"Bookable Tour Prepaid Sales Posting Department"
        },
        "kioskSalesPostingDepartment":{
            "type":"string",
            "example":"8001",
            "description":"Bookable Tour Kiosk Sales Posting Department"
        },
        "fcuiSalesPostingDepartment":{
            "type":"string",
            "example":"8001",
            "description":"Bookable Tour Fcui Sales Posting Department Id"
        },
        "voidPrepaidSalesPostingDepartment":{
            "type":"string",
            "example":"8001",
            "description":"Bookable Tour Void Prepaid Sales Posting Department"
        },
        "cancellationFeeSalesPostingDepartmentId":{
            "type":"string",
            "example":"8001",
            "description":"Bookable Tour Cancellation Fee Sales Posting Department Id"
        },
        "cancellationFeeSalesPostingDepartmentValue":{
            "type":"integer",
            "example":1,
            "description":"Bookable Tour Cancellation Fee Sales Posting Department Value"
        },
        "cancellationFeeSalesPostingDepartmentType":{
            "type":"string",
            "example":"P",
            "description":"Bookable Tour Cancellation Fee Sales Posting Department Type"
        }
    }
}

Nested Schema : salesTaxAndFees

Type: object

Show Source

• salesFeesPostingDepartmentId(optional): string
  Bookable Tour Sales Fees Posting Department Id

  Example: 8009
• salesFeesPostingDepartmentType(optional): string
  Bookable Tour Sales Fees Posting Department Type

  Example: P
• salesFeesPostingDepartmentValue(optional): number
  Bookable Tour Sales Fees Posting Department Value

  Example: 5
• salesTaxDepartment1Id(optional): string
  Bookable Tour Sales Tax Department 1 Id

  Example: 8006
• salesTaxDepartment1Type(optional): string
  Bookable Tour Sales Tax Department 1 Type

  Example: P
• salesTaxDepartment1Value(optional): number
  Bookable Tour Sales Tax Department 1 Value

  Example: 10
• salesTaxDepartment2Id(optional): string
  Bookable Tour Sales Tax Department 2 Id

  Example: 8007
• salesTaxDepartment2Type(optional): string
  Bookable Tour Sales Tax Department 2 Type

  Example: P
• salesTaxDepartment2Value(optional): number
  Bookable Tour Sales Tax Department 2 Value

  Example: 1

{
    "type":"object",
    "properties":{
        "salesTaxDepartment1Id":{
            "type":"string",
            "example":"8006",
            "description":"Bookable Tour Sales Tax Department 1 Id"
        },
        "salesTaxDepartment1Value":{
            "type":"number",
            "example":10,
            "description":"Bookable Tour Sales Tax Department 1 Value"
        },
        "salesTaxDepartment1Type":{
            "type":"string",
            "example":"P",
            "description":"Bookable Tour Sales Tax Department 1 Type"
        },
        "salesTaxDepartment2Id":{
            "type":"string",
            "example":"8007",
            "description":"Bookable Tour Sales Tax Department 2 Id"
        },
        "salesTaxDepartment2Value":{
            "type":"number",
            "example":1,
            "description":"Bookable Tour Sales Tax Department 2 Value"
        },
        "salesTaxDepartment2Type":{
            "type":"string",
            "example":"P",
            "description":"Bookable Tour Sales Tax Department 2 Type"
        },
        "salesFeesPostingDepartmentId":{
            "type":"string",
            "example":"8009",
            "description":"Bookable Tour Sales Fees Posting Department Id"
        },
        "salesFeesPostingDepartmentValue":{
            "type":"number",
            "example":5,
            "description":"Bookable Tour Sales Fees Posting Department Value"
        },
        "salesFeesPostingDepartmentType":{
            "type":"string",
            "example":"P",
            "description":"Bookable Tour Sales Fees Posting Department Type"
        }
    }
}

Nested Schema : vatPostingSplit

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "vatPostingSplitId":{
                "type":"number",
                "example":12345678,
                "description":"VAT posting split id"
            },
            "vatPostingDepartmentCode":{
                "type":"string",
                "example":"8007",
                "description":"VAT Posting Department Code"
            },
            "vatPostingDepartmentName":{
                "type":"string",
                "example":"American Express",
                "description":"VAT Posting Department Name"
            },
            "vatTaxRate":{
                "type":"number",
                "example":3,
                "description":"VAT percentage"
            },
            "vatAmountAdult":{
                "type":"number",
                "example":20.5,
                "description":"VAT Amount for adult"
            },
            "vatAmountChild":{
                "type":"number",
                "example":10.5,
                "description":"VAT Amount for child"
            },
            "bookingType":{
                "type":"string",
                "example":"Regular",
                "description":"Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive"
            }
        }
    }
}

Nested Schema : vatReportingSplit

Type: object

Show Source

• vatReportingSplit1Price(optional): number
  Bookable Tour Vat Reporting Split 1 Price

  Example: 1
• vatReportingSplit1Rate(optional): number
  Bookable Tour Vat Reporting Split 1 Rate

  Example: 116.12
• vatReportingSplit2Price(optional): number
  Bookable Tour Vat Reporting Split 2 Price

  Example: 0.5
• vatReportingSplit2Rate(optional): number
  Bookable Tour Vat Reporting Split 2 Rate

  Example: 117.23
• vatReportingSplit3Price(optional): number
  Bookable Tour Vat Reporting Split 3 Price

  Example: 1
• vatReportingSplit3Rate(optional): number
  Bookable Tour Vat Reporting Split 3 Rate

  Example: 118.2
• vatReportingSplit4Price(optional): number
  Bookable Tour Vat Reporting Split 4 Price

  Example: 3
• vatReportingSplit4Rate(optional): number
  Bookable Tour Vat Reporting Split 4 Rate

  Example: 50

{
    "type":"object",
    "properties":{
        "vatReportingSplit1Rate":{
            "type":"number",
            "example":116.12,
            "description":"Bookable Tour Vat Reporting Split 1 Rate"
        },
        "vatReportingSplit1Price":{
            "type":"number",
            "example":1,
            "description":"Bookable Tour Vat Reporting Split 1 Price"
        },
        "vatReportingSplit2Rate":{
            "type":"number",
            "example":117.23,
            "description":"Bookable Tour Vat Reporting Split 2 Rate"
        },
        "vatReportingSplit2Price":{
            "type":"number",
            "example":0.5,
            "description":"Bookable Tour Vat Reporting Split 2 Price"
        },
        "vatReportingSplit3Rate":{
            "type":"number",
            "example":118.2,
            "description":"Bookable Tour Vat Reporting Split 3 Rate"
        },
        "vatReportingSplit3Price":{
            "type":"number",
            "example":1,
            "description":"Bookable Tour Vat Reporting Split 3 Price"
        },
        "vatReportingSplit4Rate":{
            "type":"number",
            "example":50,
            "description":"Bookable Tour Vat Reporting Split 4 Rate"
        },
        "vatReportingSplit4Price":{
            "type":"number",
            "example":3,
            "description":"Bookable Tour Vat Reporting Split 4 Price"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• bookingType(optional): string
  Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive

  Example: Regular
• vatAmountAdult(optional): number
  VAT Amount for adult

  Example: 20.5
• vatAmountChild(optional): number
  VAT Amount for child

  Example: 10.5
• vatPostingDepartmentCode(optional): string
  VAT Posting Department Code

  Example: 8007
• vatPostingDepartmentName(optional): string
  VAT Posting Department Name

  Example: American Express
• vatPostingSplitId(optional): number
  VAT posting split id

  Example: 12345678
• vatTaxRate(optional): number
  VAT percentage

  Example: 3

{
    "type":"object",
    "properties":{
        "vatPostingSplitId":{
            "type":"number",
            "example":12345678,
            "description":"VAT posting split id"
        },
        "vatPostingDepartmentCode":{
            "type":"string",
            "example":"8007",
            "description":"VAT Posting Department Code"
        },
        "vatPostingDepartmentName":{
            "type":"string",
            "example":"American Express",
            "description":"VAT Posting Department Name"
        },
        "vatTaxRate":{
            "type":"number",
            "example":3,
            "description":"VAT percentage"
        },
        "vatAmountAdult":{
            "type":"number",
            "example":20.5,
            "description":"VAT Amount for adult"
        },
        "vatAmountChild":{
            "type":"number",
            "example":10.5,
            "description":"VAT Amount for child"
        },
        "bookingType":{
            "type":"string",
            "example":"Regular",
            "description":"Booking type: Regular, Prepaid, Refund Prepaid. This is not case sensitive"
        }
    }
}

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/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":[
            {
                "errorPath":"regularSalesPostingDepartmentId",
                "message":"is invalid."
            }
        ]
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":[
        {
            "errorPath":"regularSalesPostingDepartmentId",
            "message":"is invalid."
        }
    ]
}

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/ExcursionBookableTourErrorResponse"
        }
    ],
    "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/ExcursionBookableTourErrorResponse"
        }
    ],
    "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/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"Bookable tour 123 not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"Bookable tour 123 not found"
}

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/ExcursionBookableTourErrorResponse"
        }
    ],
    "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/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"System not allows officers to schedule a tour before the current date"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"System not allows officers to schedule a tour before the current date"
}

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"
        }
    }
}

415 Response

Unsupported Media Type

Body ()

Root Schema : schema

Match All

Show Source

• object Error Response
  Title: Error Response

  Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/ExcursionBookableTourErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

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

• 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/ExcursionBookableTourErrorResponse"
        }
    ],
    "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/ExcursionBookableTourErrorResponse"
        }
    ],
    "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