Get tender media

post

/bi/v1/{orgIdentifier}/getTenderMediaDimensions

Gets the tender media for a specified location.

Request

Path Parameters
Body ()
The request body defines the details of the API request.
Root Schema : locRequestPayload
Type: object
Request payload with location reference
Show Source
  • Title: Application Name
    Maximum Length: 128
    The name of the application which is accessing the API.

    First Available Version: 20.1.10

  • Title: Include
    List of objects to include in response
  • Title: Location Reference
    The location reference, this may be a store number or name depending on the organization
  • Title: Search Criteria
    Search criteria to filter results based on field value
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : tenderMediaDimensions
Type: object
The response body contains information about the tender media dimensions for the specified locatio
Show Source
Nested Schema : Tender Medias
Type: array
Title: Tender Medias
An array of tender media dimensions
Show Source
Nested Schema : tenderMedia
Type: object
The response body contains information about the tender media for the specified location.
Show Source
  • 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.

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • Title: Master Name
    Maximum Length: 99
    The master tender media name
  • Title: Master Number
    Maximum Length: 16
    The master tender media number
  • Title: Name
    Maximum Length: 99
    Tender media Name
  • Title: Number
    Maximum Length: 16
    Tender media number
  • 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

Bad Request
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

401 Response

Unauthorized
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

403 Response

Service Unavailable
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

404 Response

Resource Not Found
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source

Default Response

Unexpected Error
Body ()
Root Schema : exceptionDetailType
Type: object
Exception details
Show Source
Back to Top

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"
 }]
}
Back to Top