Get guest check extensibility details
post
/bi/v1/{orgIdentifier}/getGuestCheckExtensibilityDetails
Get all the Guest Check Extensibility details for a specified location and business date.
Request
Path Parameters
-
orgIdentifier(required): string
Unique identifier of the organization name
The request body defines the details of the API request.
Root Schema : gstChkExtRequestPayload
Type:
object
Request payload for guest check extensibility
Show Source
-
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
Maximum Length:2000
List of objects to include in response -
locRef(required):
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
opnBusDt(required):
string(date)
Title:
Open Business Date
The date the guest check was opened / re-opened -
searchCriteria:
string
Title:
Search Criteria
Maximum Length:2000
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : guestCheckExtDetails
Type:
object
The response body contains information about the guest check extensiblity transactions for the specified location and business date.
Show Source
-
locRef(required):
string
Title:
Location Reference
Maximum Length:99
The location reference, this may be a store number or name depending on the organization -
opnBusDt(required):
string(date)
Title:
Open Business Date
The business date when the guest check was opened -
revenueCenters(required):
array revenueCenters
An array of guest check extensibility details by reveneue centers
Nested Schema : revenueCenters
Type:
array
An array of guest check extensibility details by reveneue centers
Show Source
-
Array of:
object guestCheckExtDetailsByRVC
The response body contains guest checks extensiblity transactions associated with a revenue center.
Nested Schema : guestCheckExtDetailsByRVC
Type:
object
The response body contains guest checks extensiblity transactions associated with a revenue center.
Show Source
-
guestChecks(required):
array guestChecks
An array of guest checks with extensibility data. This attribute will not be returned in the response if value is null
-
rvcNum(required):
integer
Title:
Revenue center number
Maximum Length:10
Revenue Center number. This attribute will not be returned in the response if guestChecks is null
Nested Schema : guestChecks
Type:
array
An array of guest checks with extensibility data. This attribute will not be returned in the response if value is null
Show Source
-
Array of:
object guestCheckExtDetail
The response body contains guest check extensiblity information associated with a revenue center.
Nested Schema : guestCheckExtDetail
Type:
object
The response body contains guest check extensiblity information associated with a revenue center.
Show Source
-
dspName(required):
string
Title:
Display Name
Maximum Length:99
Display name. This attribute will not be returned in the response if value is null -
extAppId(required):
integer
Title:
Extension Appllication ID
Maximum Length:16
Unique identifier extension application -
extDataName(required):
string
Title:
Extension Data name
Maximum Length:99
Name of the extension data. This attribute will not be returned in the response if value is null -
guestCheckId(required):
integer
Title:
Guest Check ID
Maximum Length:16
The unique identifier of the guest check -
strData(required):
string
Title:
String Data
Maximum Length:99
String data associated with the extension. This attribute will not be returned in the response if value is null
400 Response
Bad Request
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
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
Unauthorized
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
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
Service Unavailable
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
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
Resource Not Found
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
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
Unexpected Error
Root Schema : exceptionDetailType
Type:
object
Error details
Show Source
-
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 guest check extensibility details for a specified location and 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","opnBusDt":"2020-10-20"} https://baseurl/bi/v1/orgidentifier/getGuestCheckExtensibilityDetails
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", "opnBusDt": "2020-07-20", "revenueCenters":[{ "rvcNum": 1372, "guestChecks": [{ "guestCheckId": 124354, "extAppId": 123, "extDataName": "Extensibility Data" "strData": "Extension string", "dspName": "Name" }] }] }