Oracle Hospitality Cruise Property Management REST API 23.3.0

Create new posting transaction from Simphony/POS

post

/spms/v2/ships/{shipId}/financials/folios

Create new posting transaction from Simphony/POS

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number(12345678)

Ship ID

Required to create posting

Root Schema : CreatePOSPostingRequest

Match All

Show Source

object CreatePOSPosting

Title: CreatePOSPosting

{
    "allOf":[
        {
            "$ref":"#/definitions/CreatePOSPosting"
        }
    ]
}

Nested Schema : CreatePOSPosting

Type: object

Title: CreatePOSPosting

Show Source

itemDetails: object ItemDetails

Title: ItemDetails
postingType(required): string

Posting type. POS- for pos type

Example: POS

{
    "title":"CreatePOSPosting",
    "type":"object",
    "properties":{
        "postingType":{
            "type":"string",
            "description":"Posting type. POS- for pos type",
            "example":"POS"
        },
        "itemDetails":{
            "type":"object",
            "$ref":"#/definitions/ItemDetailsPOS"
        }
    },
    "required":[
        "postingType"
    ]
}

Nested Schema : ItemDetails

Type: object

Title: ItemDetails

Show Source

buyerId: integer

Buyer Id - required if post to credit card tender media

Example: 3118243
cardExpiryDate: integer

card expiry date in format yyyyMM

Example: 202411
checkServer1: string

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

Check server #1

Example: server 1
checkServer2: string

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

Check server #2

Example: server 2
exchangeRate: object exchangeRate
isBufferPosting: boolean

is buffer posting

Example: false
isCardSwipe: boolean

is card swipe

Example: false
isQuantityPackage: boolean

is quantity package

Example: false
items: array items
manualServiceChargeAmount: number

manual service charge amount

Example: 100
numberOfGuest: integer

Number of guest

Example: 2
posCheckNumber: string

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

Posting check number

Example: A123
posEmployeeNamePerCheck: string

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

Posting employee name per check

Example: A123
posEmployeeNumberPerCheck: integer

Posting employee number per check

Example: 123
posEmployeeNumberPerTransaction: integer

Posting employee number per transaction

Example: 123
posRevenueCenterId(required): integer

posting revenue center

Example: 1
posSimphonyId: integer

Posting simphony id

Example: 1234567
posUniqueKey: string

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

Posting unique key

Example: af21d12c6e2b44a3a6ed6de6aeccf506
roundingAmount: number

rounding amount

Example: 0.1
salesContext(required): array salesContext
searchValue(required): string

search value - reservationId

Example: 1039034
servingPeriod: integer

Serving period

Example: 20
tenderMediaNumber(required): integer

tender media number

Example: 20
workstationId: integer

workstation id

Example: 1
workstationNumber: integer

workstation number

Example: 1

{
    "title":"ItemDetails",
    "type":"object",
    "properties":{
        "servingPeriod":{
            "type":"integer",
            "description":"Serving period",
            "example":20
        },
        "posCheckNumber":{
            "type":"string",
            "description":"Posting check number",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"A123"
        },
        "posEmployeeNumberPerCheck":{
            "type":"integer",
            "description":"Posting employee number per check",
            "example":123
        },
        "numberOfGuest":{
            "type":"integer",
            "description":"Number of guest",
            "example":2
        },
        "posEmployeeNumberPerTransaction":{
            "type":"integer",
            "description":"Posting employee number per transaction",
            "example":123
        },
        "posEmployeeNamePerCheck":{
            "type":"string",
            "description":"Posting employee name per check",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"A123"
        },
        "posUniqueKey":{
            "type":"string",
            "description":"Posting unique key",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"af21d12c6e2b44a3a6ed6de6aeccf506"
        },
        "posSimphonyId":{
            "type":"integer",
            "description":"Posting simphony id",
            "example":1234567
        },
        "cardExpiryDate":{
            "type":"integer",
            "description":"card expiry date in format yyyyMM",
            "example":202411
        },
        "isCardSwipe":{
            "type":"boolean",
            "description":"is card swipe",
            "example":false
        },
        "workstationNumber":{
            "type":"integer",
            "description":"workstation number",
            "example":1
        },
        "workstationId":{
            "type":"integer",
            "description":"workstation id",
            "example":1
        },
        "isBufferPosting":{
            "type":"boolean",
            "description":"is buffer posting",
            "example":false
        },
        "isQuantityPackage":{
            "type":"boolean",
            "description":"is quantity package",
            "example":false
        },
        "tenderMediaNumber":{
            "type":"integer",
            "description":"tender media number",
            "example":20
        },
        "posRevenueCenterId":{
            "type":"integer",
            "description":"posting revenue center",
            "example":1
        },
        "searchValue":{
            "type":"string",
            "description":"search value - reservationId",
            "example":"1039034"
        },
        "checkServer1":{
            "type":"string",
            "description":"Check server #1",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"server 1"
        },
        "checkServer2":{
            "type":"string",
            "description":"Check server #2",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=|^'\":;@`]*$",
            "example":"server 2"
        },
        "manualServiceChargeAmount":{
            "type":"number",
            "description":"manual service charge amount",
            "example":100
        },
        "roundingAmount":{
            "type":"number",
            "description":"rounding amount",
            "example":0.1
        },
        "buyerId":{
            "type":"integer",
            "description":"Buyer Id - required if post to credit card tender media",
            "example":3118243
        },
        "salesContext":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SalesContext"
            },
            "example":[
                {
                    "salesItemizerNumber":1,
                    "salesItemizerAmount":100,
                    "autoServiceChargeAmount":0,
                    "discountAmount":0,
                    "tipAmount":10,
                    "taxAmount":10
                },
                {
                    "salesItemizerNumber":2,
                    "salesItemizerAmount":20,
                    "autoServiceChargeAmount":0,
                    "discountAmount":0,
                    "tipAmount":0,
                    "taxAmount":5
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ItemsPOS"
            },
            "example":[
                {
                    "itemNumber":558950185,
                    "itemName":"BLUE ORB",
                    "quantity":1,
                    "totalAmount":100,
                    "isVoided":false,
                    "isReturn":false,
                    "itemType":"MENUITEM",
                    "remark":"test",
                    "majorGroup":101,
                    "familyGroup":1001,
                    "saleItemizer":1,
                    "isItemPostedToMicros":false,
                    "isItemDiscount":false,
                    "itemIndex":0,
                    "discountItemizer":3,
                    "voidLink":0,
                    "itemPosSimphonyLink":0,
                    "typeDefinition":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000",
                    "taxType":"0000000000000000",
                    "taxTotal":10,
                    "detailLink":1
                },
                {
                    "itemNumber":558950186,
                    "itemName":"Cabin Charge",
                    "quantity":1,
                    "totalAmount":100,
                    "isVoided":false,
                    "isReturn":false,
                    "itemType":"TENDERMEDIA",
                    "remark":"test",
                    "majorGroup":0,
                    "familyGroup":0,
                    "saleItemizer":0,
                    "isItemPostedToMicros":false,
                    "isItemDiscount":false,
                    "itemIndex":0,
                    "discountItemizer":3,
                    "voidLink":0,
                    "itemPosSimphonyLink":1234567,
                    "typeDefinition":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000",
                    "taxType":"0000000000000000",
                    "taxTotal":0,
                    "detailLink":6
                }
            ]
        },
        "exchangeRate":{
            "type":"object",
            "properties":{
                "foreignCurrencyCode":{
                    "type":"integer",
                    "description":"foreign currency code",
                    "example":1
                },
                "exchangeForeignAmount":{
                    "type":"number",
                    "description":"exchange foreign amount",
                    "example":100
                },
                "exchangeBaseAmount":{
                    "type":"number",
                    "description":"exchange base amount",
                    "example":100
                },
                "exchangeChangeDue":{
                    "type":"number",
                    "description":"exchange change due",
                    "example":1
                }
            }
        }
    },
    "required":[
        "searchValue",
        "posRevenueCenterId",
        "tenderMediaNumber",
        "salesContext"
    ]
}

Nested Schema : exchangeRate

Type: object

Show Source

exchangeBaseAmount: number

exchange base amount

Example: 100
exchangeChangeDue: number

exchange change due

Example: 1
exchangeForeignAmount: number

exchange foreign amount

Example: 100
foreignCurrencyCode: integer

foreign currency code

Example: 1

{
    "type":"object",
    "properties":{
        "foreignCurrencyCode":{
            "type":"integer",
            "description":"foreign currency code",
            "example":1
        },
        "exchangeForeignAmount":{
            "type":"number",
            "description":"exchange foreign amount",
            "example":100
        },
        "exchangeBaseAmount":{
            "type":"number",
            "description":"exchange base amount",
            "example":100
        },
        "exchangeChangeDue":{
            "type":"number",
            "description":"exchange change due",
            "example":1
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object ItemsPOS

Title: ItemsPOS

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ItemsPOS"
    },
    "example":[
        {
            "itemNumber":558950185,
            "itemName":"BLUE ORB",
            "quantity":1,
            "totalAmount":100,
            "isVoided":false,
            "isReturn":false,
            "itemType":"MENUITEM",
            "remark":"test",
            "majorGroup":101,
            "familyGroup":1001,
            "saleItemizer":1,
            "isItemPostedToMicros":false,
            "isItemDiscount":false,
            "itemIndex":0,
            "discountItemizer":3,
            "voidLink":0,
            "itemPosSimphonyLink":0,
            "typeDefinition":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000",
            "taxType":"0000000000000000",
            "taxTotal":10,
            "detailLink":1
        },
        {
            "itemNumber":558950186,
            "itemName":"Cabin Charge",
            "quantity":1,
            "totalAmount":100,
            "isVoided":false,
            "isReturn":false,
            "itemType":"TENDERMEDIA",
            "remark":"test",
            "majorGroup":0,
            "familyGroup":0,
            "saleItemizer":0,
            "isItemPostedToMicros":false,
            "isItemDiscount":false,
            "itemIndex":0,
            "discountItemizer":3,
            "voidLink":0,
            "itemPosSimphonyLink":1234567,
            "typeDefinition":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000",
            "taxType":"0000000000000000",
            "taxTotal":0,
            "detailLink":6
        }
    ]
}

Example:

[
    {
        "itemNumber":558950185,
        "itemName":"BLUE ORB",
        "quantity":1,
        "totalAmount":100,
        "isVoided":false,
        "isReturn":false,
        "itemType":"MENUITEM",
        "remark":"test",
        "majorGroup":101,
        "familyGroup":1001,
        "saleItemizer":1,
        "isItemPostedToMicros":false,
        "isItemDiscount":false,
        "itemIndex":0,
        "discountItemizer":3,
        "voidLink":0,
        "itemPosSimphonyLink":0,
        "typeDefinition":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000",
        "taxType":"0000000000000000",
        "taxTotal":10,
        "detailLink":1
    },
    {
        "itemNumber":558950186,
        "itemName":"Cabin Charge",
        "quantity":1,
        "totalAmount":100,
        "isVoided":false,
        "isReturn":false,
        "itemType":"TENDERMEDIA",
        "remark":"test",
        "majorGroup":0,
        "familyGroup":0,
        "saleItemizer":0,
        "isItemPostedToMicros":false,
        "isItemDiscount":false,
        "itemIndex":0,
        "discountItemizer":3,
        "voidLink":0,
        "itemPosSimphonyLink":1234567,
        "typeDefinition":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000",
        "taxType":"0000000000000000",
        "taxTotal":0,
        "detailLink":6
    }
]

Nested Schema : salesContext

Type: array

Show Source

Array of: object SalesContext

Title: SalesContext

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SalesContext"
    },
    "example":[
        {
            "salesItemizerNumber":1,
            "salesItemizerAmount":100,
            "autoServiceChargeAmount":0,
            "discountAmount":0,
            "tipAmount":10,
            "taxAmount":10
        },
        {
            "salesItemizerNumber":2,
            "salesItemizerAmount":20,
            "autoServiceChargeAmount":0,
            "discountAmount":0,
            "tipAmount":0,
            "taxAmount":5
        }
    ]
}

Example:

[
    {
        "salesItemizerNumber":1,
        "salesItemizerAmount":100,
        "autoServiceChargeAmount":0,
        "discountAmount":0,
        "tipAmount":10,
        "taxAmount":10
    },
    {
        "salesItemizerNumber":2,
        "salesItemizerAmount":20,
        "autoServiceChargeAmount":0,
        "discountAmount":0,
        "tipAmount":0,
        "taxAmount":5
    }
]

Nested Schema : ItemsPOS

Type: object

Title: ItemsPOS

Show Source

detailLink: integer

detail link

Example: 1
discountItemizer: integer

discount itemizer

Example: 3
familyGroup: integer

family group

Example: 42
isItemDiscount: boolean

is item discount

Example: false
isItemPostedToMicros: boolean

is item posted to micros

Example: false
isReturn: boolean

is return

Example: false
isVoided: boolean

is voided

Example: false
itemIndex: integer

item index

Example: 0
itemName: string

item name

Example: Blue orb
itemNumber: integer

item number

Example: 558
itemPosSimphonyLink: integer

item posting simphony link

Example: 0
itemType: string

Allowed Values: [ "MENUITEM", "DISCOUNT", "SERVICECHARGE", "TENDERMEDIA" ]

item Type

Example: MENUITEM
majorGroup: integer

major group

Example: 4
quantity: integer

quantity

Example: 1
remark: string

remark

Example: test
saleItemizer: integer

sale itemizer

Example: 1
taxTotal: number

tax total

Example: 0
taxType: string

tax type

Example: 0000000000
totalAmount: number

total amount

Example: 100
typeDefinition: string

type definition

Example: 000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000
voidLink: integer

void link

Example: 0

{
    "title":"ItemsPOS",
    "type":"object",
    "properties":{
        "itemNumber":{
            "type":"integer",
            "description":"item number",
            "example":558
        },
        "totalAmount":{
            "type":"number",
            "description":"total amount",
            "example":100
        },
        "itemName":{
            "type":"string",
            "description":"item name",
            "example":"Blue orb"
        },
        "quantity":{
            "type":"integer",
            "description":"quantity",
            "example":1
        },
        "isVoided":{
            "type":"boolean",
            "description":"is voided",
            "example":false
        },
        "isReturn":{
            "type":"boolean",
            "description":"is return",
            "example":false
        },
        "itemType":{
            "type":"string",
            "description":"item Type",
            "enum":[
                "MENUITEM",
                "DISCOUNT",
                "SERVICECHARGE",
                "TENDERMEDIA"
            ],
            "example":"MENUITEM"
        },
        "remark":{
            "type":"string",
            "description":"remark",
            "example":"test"
        },
        "majorGroup":{
            "type":"integer",
            "description":"major group",
            "example":4
        },
        "familyGroup":{
            "type":"integer",
            "description":"family group",
            "example":42
        },
        "saleItemizer":{
            "type":"integer",
            "description":"sale itemizer",
            "example":1
        },
        "isItemPostedToMicros":{
            "type":"boolean",
            "description":"is item posted to micros",
            "example":false
        },
        "isItemDiscount":{
            "type":"boolean",
            "description":"is item discount",
            "example":false
        },
        "itemIndex":{
            "type":"integer",
            "description":"item index",
            "example":0
        },
        "discountItemizer":{
            "type":"integer",
            "description":"discount itemizer",
            "example":3
        },
        "voidLink":{
            "type":"integer",
            "description":"void link",
            "example":0
        },
        "itemPosSimphonyLink":{
            "type":"integer",
            "description":"item posting simphony link",
            "example":0
        },
        "typeDefinition":{
            "type":"string",
            "description":"type definition",
            "example":"000000110001100000000010000000000100010000000000000000000000000000000000000000000000000000000000"
        },
        "taxType":{
            "type":"string",
            "description":"tax type",
            "example":"0000000000"
        },
        "taxTotal":{
            "type":"number",
            "description":"tax total",
            "example":0
        },
        "detailLink":{
            "type":"integer",
            "description":"detail link",
            "example":1
        }
    }
}

Nested Schema : SalesContext

Type: object

Title: SalesContext

Show Source

autoServiceChargeAmount: number

auto service charge amount

Example: 25
discountAmount: number

discount amount

Example: -20
salesItemizerAmount: number

sales itemizer amount

Example: 100
salesItemizerNumber: integer

sales iteizer number

Example: 1
taxAmount: number

tax amount

Example: 6
tipAmount: number

tip amount

Example: 10

{
    "title":"SalesContext",
    "type":"object",
    "properties":{
        "salesItemizerNumber":{
            "type":"integer",
            "description":"sales iteizer number",
            "example":1
        },
        "salesItemizerAmount":{
            "type":"number",
            "description":"sales itemizer amount",
            "example":100
        },
        "autoServiceChargeAmount":{
            "type":"number",
            "description":"auto service charge amount",
            "example":25
        },
        "discountAmount":{
            "type":"number",
            "description":"discount amount",
            "example":-20
        },
        "tipAmount":{
            "type":"number",
            "description":"tip amount",
            "example":10
        },
        "taxAmount":{
            "type":"number",
            "description":"tax amount",
            "example":6
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Created

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/FinancialPostingPOSErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":"Department ID 1 is not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Bad Request",
    "detail":"Department ID 1 is not found"
}

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/FinancialPostingPOSErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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/FinancialPostingPOSErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was 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"
        }
    }
}

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/FinancialPostingPOSErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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/FinancialPostingPOSErrorResponse"
        }
    ],
    "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"
        }
    }
}

415 Response

Unsupported Media Type

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPostingPOSErrorResponse"
        }
    ],
    "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: 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/FinancialPostingPOSErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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/FinancialPostingPOSErrorResponse"
        }
    ],
    "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"
        }
    }
}