Get tender media
/bi/v1/{orgIdentifier}/getTenderMediaDimensions
Request
-
orgIdentifier(required): string
Unique identifier of the organization name
object
-
applicationName:
string
Title:
Application Name
Maximum Length:128
The name of the application which is accessing the API.First Available Version: 20.1.10
-
include:
string
Title:
Include
List of objects to include in response -
locRef(required):
string
Title:
Location Reference
The location reference, this may be a store number or name depending on the organization -
searchCriteria:
string
Title:
Search Criteria
Search criteria to filter results based on field value
Response
- application/json
200 Response
object
-
locRef(required):
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
tenderMedias(required):
array Tender Medias
Title:
Tender Medias
An array of tender media dimensions
array
Tender Medias
-
Array of:
object tenderMedia
The response body contains information about the tender media for the specified location.
object
-
autoClsdTnd:
boolean
Title:
Flag indicating if this tender is used to auto close checks after 7 days
Flag 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.
-
catGrpHierName1(required):
string
Title:
Category Group Hierarchy #1 assigned to the master item
Maximum Length:40
Category 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 item
Maximum Length:40
Category 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 item
Maximum Length:40
Category 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 item
Maximum Length:40
Category 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 item
Maximum Length:20
Category 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 item
Maximum Length:20
Category 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 item
Maximum Length:20
Category 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 item
Maximum Length:20
Category 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 system
Maximum Length:32
External 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 system
Maximum Length:32
External 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 Name
Maximum Length:99
The master tender media name -
mstrNum:
integer
Title:
Master Number
Maximum Length:16
The master tender media number -
name(required):
string
Title:
Name
Maximum Length:99
Tender media Name -
num(required):
integer
Title:
Number
Maximum Length:16
Tender media number -
type(required):
integer
Title:
Type
The 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
object
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
401 Response
object
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
403 Response
object
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
404 Response
object
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The description of the type of HTTP error
Default Response
object
-
detail:
string
Title:
Error Description
The description of the error -
o:errorCode(required):
integer
Title:
Oracle Error Code
Oracle error code -
status:
integer
Title:
Status
HTTP Response Code -
title(required):
string
Title:
Title
High level description of the error -
type(required):
string
Title:
Type
The 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 "autoClsdTnd": true "extRef1": "567abc", "extRef2": "789def01" }] }