Get tender media
post
/bi/v1/{orgIdentifier}/getTenderMediaDimensions
Gets the tender media for a specified location.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type:
objectRequest payload with location reference
Show Source
-
applicationName:
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
IncludeList of objects to include in response -
locRef(required):
string
Title:
Location ReferenceThe location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search CriteriaSearch criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : tenderMediaDimensions
Type:
objectThe response body contains information about the tender media dimensions for the specified locatio
Show Source
-
locRef(required):
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
tenderMedias(required):
array Tender Medias
Title:
Tender MediasAn array of tender media dimensions
Nested Schema : Tender Medias
Type:
arrayTitle:
Tender MediasAn array of tender media dimensions
Show Source
-
Array of:
object tenderMedia
The response body contains information about the tender media for the specified location.
Nested Schema : tenderMedia
Type:
objectThe response body contains information about the tender media for the specified location.
Show Source
-
autoClsdTnd:
boolean
Title:
Flag indicating if this tender is used to auto close checks after 7 daysFlag indicating if this tender is used to auto close checks after 7 days. This field i dependent on feature availability in Simphony. This is optional. This attribute will not be returned in the response if value is false.First available version 20.2.
-
cat:
number
Title:
CategoryMaximum Length:3The category assigned to the master item of this tender media.
Possible values are:
1 = Coupon
2 = Cash
3 = Bank Check
4 = Credit Card
5 = Debit Card
6 = Gift Card Redeem
7 = Gift Certificate Redeem
8 = Gift Card Cash
9 = Gift Certificate Cash
10 = Corporate Charge
11 = Other Category 1
12 = Other Category 2
13 = Other Category 3
14 = Other Category 4
15 = Employee Meal
NULL = UndefinedFirst Available Version 20.3
-
catGrpHierName1(required):
string
Title:
Category Group Hierarchy #1 assigned to the master itemMaximum Length:40Category Group Hierarchy #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName2(required):
string
Title:
Category Group Hierarchy #2 assigned to the master itemMaximum Length:40Category Group Hierarchy #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName3(required):
string
Title:
Category Group Hierarchy #3 assigned to the master itemMaximum Length:40Category Group Hierarchy #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpHierName4(required):
string
Title:
Category Group Hierarchy #4 assigned to the master itemMaximum Length:40Category Group Hierarchy #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName1(required):
string
Title:
Category Group #1 assigned to the master itemMaximum Length:20Category Group #1 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName2(required):
string
Title:
Category Group #2 assigned to the master itemMaximum Length:20Category Group #2 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName3(required):
string
Title:
Category Group #3 assigned to the master itemMaximum Length:20Category Group #3 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
catGrpName4(required):
string
Title:
Category Group #4 assigned to the master itemMaximum Length:20Category Group #4 assigned to the master item. This attribute will not be returned in the response if value is null.First Available Version 20.1.14.13
-
extRef1:
string
Title:
External reference 1 that corresponds to an identifier in a third party systemMaximum Length:32External reference 1 that corresponds to an identifier in a third party system. This attribute is optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
-
extRef2:
string
Title:
External reference 2 that corresponds to an identifier in a third party systemMaximum Length:32External reference 2 that corresponds to an identifier in a third party system. This attribute is Optional optional. This attribute will not be returned in the response if value is null.First Available Version 20.2
-
mstrName:
string
Title:
Master NameMaximum Length:99The master tender media name -
mstrNum:
integer
Title:
Master NumberMaximum Length:16The master tender media number -
name(required):
string
Title:
NameMaximum Length:99Tender media Name -
num(required):
integer
Title:
NumberMaximum Length:16Tender media number -
subType:
number
Title:
Sub typeMaximum Length:3The subtype assigned to the master item of this tender media.
Possible values are:
0 = Other
1 = Cash
2 = Comps
3 = Coupon
4 = Credit Card
5 = Direct Bill
6 = Gift Cert/Card
7 = Room Charges
8 = Manager Comps
9 = Casino Comps
20 = Deposit
21 = Tips Paid
NULL = UndefinedFirst Available Version 20.3
-
type(required):
integer
Title:
TypeThe Tender Media Type as defined in the POS and the tender media master.
Possible values are:
1 = Payment
2 = Pickup (Paid Out)
3 = Loan (Paid In)
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectException details
Show Source
-
detail:
string
Title:
Error DescriptionThe description of the error -
o:errorCode(required):
integer
Title:
Oracle Error CodeOracle error code -
status:
integer
Title:
StatusHTTP Response Code -
title(required):
string
Title:
TitleHigh level description of the error -
type(required):
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to get the tender media dimensions for a specified location by submitting a POST request on the REST resource using cURL. For more information, see Use cURL
curl -i -X POST -H "Authorization: Bearer" -H "Content-Type:application/json" -d {"locRef":"1234"} https://baseurl/bi/v1/orgidentifier/getTenderMediaDimensions
Example of Response Header
The following shows an example of the response header.
HTTP/1.1 200 OK Date: Tue, 20 Oct 2020 21:24:33 GMT Transfer-Encoding: chunked Content-Type: application/json
Example of Response Body
The following example shows the contents of the response body in JSON format:
{
"locRef": "1234",
"tenderMedias":[{
"num":15253,
"name": "Cash",
"mstrNum":15253,
"mstrName": "Cash",
"catGrpHierName1": "Category Hierarchy 1",
"catGrpName1": "Category Group 1",
"catGrpHierName2": "Category Hierarchy 2",
"catGrpName2": "Category Group 2",
"catGrpHierName3": "Category Hierarchy 3",
"catGrpName3": "Category Group 3",
"catGrpHierName4": "Category Hierarchy 4",
"catGrpName4": "Category Group 4",
"type": 1,
"subType": 1,
"cat": 2,
"autoClsdTnd": true,
"extRef1": "567abc",
"extRef2": "789def01"
}]
}