Jump to

• Request
• Response
• Examples

Get latest business date

post

/bi/v1/{orgIdentifier}/getLatestBusDt

Gets the latest business date for a specified location.

Request

Path Parameters

• orgIdentifier: string
  Unique identifier of the organization name

Body ()

The request body defines the details of the API request.

Root Schema : locRequestPayload

Type: object

Request payload with location reference

Show Source

• applicationName(optional): string
  Title: Application Name

  Maximum Length: 128

  The name of the application which is accessing the API.

  First Available Version: 20.1.10

• include(optional): string
  Title: Include

  List of objects to include in response
• locRef: string
  Title: Location Reference

  The location reference, this may be a store number or name depending on the organization
• searchCriteria(optional): string
  Title: Search Criteria

  Search criteria to filter results based on field value

{
    "description":"Request payload with location reference",
    "properties":{
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference"
        },
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value",
            "title":"Search Criteria"
        },
        "include":{
            "type":"string",
            "description":"List of objects to include in response",
            "title":"Include"
        },
        "applicationName":{
            "type":"string",
            "description":"The name of the application which is accessing the API. <p>First Available Version: 20.1.10</p>",
            "title":"Application Name",
            "maxLength":128
        }
    },
    "required":[
        "locRef"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : latestBusinessDate

Type: object

The response body contains information about the latest business date for the specified location.

Show Source

• curUTC: string(date-time)
  Title: Current date and time in UTC format

  The current UTC date and time.
• latestBusDt: string(date)
  Title: Latest Business Date

  The latest business date
• locRef: string
  Title: Location Reference

  Maximum Length: 99

  The location reference, this may be a store number or name depending on the organization
• softwareVersion: string
  Title: Software Version

  Maximum Length: 99

  The version number of the Reporting and Analytics module being used for the API calls.

  First Available Version: 20.1.8.3

{
    "description":"The response body contains information about the latest business date for the specified location.",
    "properties":{
        "curUTC":{
            "type":"string",
            "description":"The current UTC date and time.",
            "title":"Current date and time in UTC format",
            "format":"date-time"
        },
        "locRef":{
            "type":"string",
            "description":"The location reference, this may be a store number or name depending on the organization",
            "title":"Location Reference",
            "maxLength":99
        },
        "latestBusDt":{
            "type":"string",
            "description":"The latest business date",
            "title":"Latest Business Date",
            "format":"date"
        },
        "softwareVersion":{
            "type":"string",
            "description":"The version number of the Reporting and Analytics module being used for the API calls.<p>First Available Version: 20.1.8.3</p>",
            "title":"Software Version",
            "maxLength":99
        }
    },
    "required":[
        "curUTC",
        "locRef",
        "latestBusDt",
        "softwareVersion"
    ]
}

400 Response

Bad Request

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

401 Response

Unauthorized

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

403 Response

Service Unavailable

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

404 Response

Resource Not Found

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Default Response

Unexpected Error

Body ()

Root Schema : exceptionDetailType

Type: object

Error details

Show Source

• detail(optional): string
  Title: Error description

  The description of the error
• o:errorCode: integer
  Title: Oracle error code

  Oracle error code
• status(optional): integer
  Title: Status

  HTTP response code
• title: string
  Title: Title

  High level description of the error
• type: string
  Title: Type

  The description of the type of HTTP error

{
    "description":"Error details",
    "properties":{
        "o:errorCode":{
            "type":"integer",
            "description":"Oracle error code",
            "title":"Oracle error code"
        },
        "detail":{
            "type":"string",
            "description":"The description of the error",
            "title":"Error description"
        },
        "status":{
            "type":"integer",
            "description":"HTTP response code",
            "title":"Status"
        },
        "type":{
            "type":"string",
            "description":"The description of the type of HTTP error",
            "title":"Type"
        },
        "title":{
            "type":"string",
            "description":"High level description of the error",
            "title":"Title"
        }
    },
    "required":[
        "o:errorCode",
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to get the latest business date 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/getLatestBusinessDate 
  

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:

{
 "curUTC": "2019-07-20T17:59:59",
 "locRef": "1234",
 "latestBusDt": "2019-07-20"
 "softwareVersion": "20.1.8.1",
}

Back to Top