Get tender media daily totals
post
/bi/v1/{orgIdentifier}/getTenderMediaDailyTotals
Get the tender media daily totals for a specified location and business date.
Request
Path Parameters
-
orgIdentifier: string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : requestPayload
Type:
objectRequest payload
Show Source
-
applicationName(optional):
string
Title:
Application NameMaximum Length:128The name of the application which is accessing the API.First Available Version: 20.1.10
-
busDt:
string(date)
Title:
Business DateThe business date associated with the cash management detail -
include(optional):
string
Title:
IncludeMaximum Length:2000List of objects to include in response -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
searchCriteria(optional):
string
Title:
Search CriteriaMaximum Length:2000Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : tmedDailyTotals
Type:
objectThe response body contains information about the daily totals of tender media for the specified location and business date.
Show Source
-
busDt:
string(date)
Title:
Business DateBusiness date -
locRef:
string
Title:
Location ReferenceMaximum Length:99The location reference, this may be a store number or name depending on the organization -
revenueCenters:
array revenueCenters
An array of tender media daily totals by revenue centers
Nested Schema : revenueCenters
Type:
arrayAn array of tender media daily totals by revenue centers
Show Source
-
Array of:
object tmedDailyTotalsByRVC
The response body contains daily totals of tender media at a revenue center for the specified location and business date.
Nested Schema : tmedDailyTotalsByRVC
Type:
objectThe response body contains daily totals of tender media at a revenue center for the specified location and business date.
Show Source
-
rvcNum:
integer
Title:
Revenue Center NumberMaximum Length:16Revenue Center number. This attribute will not be returned in the response if tenderMedias is null -
tenderMedias:
array tenderMedias
An array of daily totals of tender media for a revenue center/ This attribute will not be returned in the response if value is null
Nested Schema : tenderMedias
Type:
arrayAn array of daily totals of tender media for a revenue center/ This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object tmedDailyTotal
The response body contains daily totals of tender media for a revenue center for the specified location and business date.
Nested Schema : tmedDailyTotal
Type:
objectThe response body contains daily totals of tender media for a revenue center for the specified location and business date.
Show Source
-
cnt:
integer
Title:
Tender Media CountMaximum Length:16Total number of times the tender media was used -
tmedNum:
integer
Title:
Tender Media NumberMaximum Length:16Unique identifier of the tender media -
ttl:
number
Title:
Tender Media TotalTotal value tendered via the tender media
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
401 Response
Unauthorized
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
403 Response
Service Unavailable
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
404 Response
Resource Not Found
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Default Response
Unexpected Error
Root Schema : exceptionDetailType
Type:
objectError details
Show Source
-
detail(optional):
string
Title:
Error descriptionThe description of the error -
o:errorCode:
integer
Title:
Oracle error codeOracle error code -
status(optional):
integer
Title:
StatusHTTP response code -
title:
string
Title:
TitleHigh level description of the error -
type:
string
Title:
TypeThe description of the type of HTTP error
Examples
The following example shows how to view all the tender media daily totals for a specified location & business date 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","busDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getTenderMediaDailyTotals
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",
"busDt": "2020-07-20",
"revenueCenters":[{
"rvcNum": 1372,
"tenderMedias":[{
"tmedNum": 12345,
"ttl": 1234.56,
"cnt": 123
}]
}]
}