Simphony Transaction Services Gen2 API Guide

Get the tender collection

get

{basePath}/tenders/collection

{basePath}/tenders/collection?orgShortName=tfoinc&locRef=fdmnh144&rvcRef=42

The tender collection is a list of tenders that can be used for payment when interacting with the checks endpoint. The API returns a collection of tenders for the specified revenue center.

Request

Supported Media Types

application/json

Query Parameters

locRef: string

The location identifier.
orgShortName: string

The organization identifier.
rvcRef: integer

The revenue center identifier.

Header Parameters

If-Modified-Since(optional): string

If-Modified-Since HTTP header
If-None-Match(optional): string

If-None-Match HTTP header

Response

Supported Media Types

application/json

200 Response

A collection of tenders

Headers

ETag: string

The current entity-tag for the selected representation. See RFC 7232 Section 2.3
Last-Modified: string

A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2

Root Schema : TenderCollection

Type: object

Definition of a tenders that can be applied to a transaction.

Show Source

items(optional): array items
OrgLocRvcProperties(optional): object OrgLocRvcProperties

A collection of properties for orgShortName, locRef and rvcRef

{
    "description":"Definition of a tenders that can be applied to a transaction.\n",
    "type":"object",
    "properties":{
        "OrgLocRvcProperties":{
            "$ref":"#/definitions/OrgLocRvcProperties"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TenderItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object TenderItem

Definition of a tender that can be applied to a transaction. A tender can be either a 'service total' or a 'payment'. A 'service total' is used to submit an order without payment.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TenderItem"
    }
}

Nested Schema : OrgLocRvcProperties

Type: object

A collection of properties for orgShortName, locRef and rvcRef

Show Source

locRef: string

Location identifier

Example: store66
orgShortName: string

Organization identifier

Example: mymeal
rvcRef: integer

Revenue Center identifier

Example: 2

{
    "description":"A collection of properties for orgShortName, locRef and rvcRef\n",
    "type":"object",
    "required":[
        "orgShortName",
        "locRef",
        "rvcRef"
    ],
    "properties":{
        "orgShortName":{
            "description":"Organization identifier",
            "type":"string",
            "example":"mymeal"
        },
        "locRef":{
            "description":"Location identifier",
            "type":"string",
            "example":"store66"
        },
        "rvcRef":{
            "description":"Revenue Center identifier",
            "type":"integer",
            "example":2
        }
    }
}

Nested Schema : TenderItem

Type: object

Definition of a tender that can be applied to a transaction. A tender can be either a 'service total' or a 'payment'. A 'service total' is used to submit an order without payment.

Show Source

ConsumerContentProperties(optional): object ConsumerContentProperties

A collection of consumer based content
extensions(optional): object ExtensionData

Additional Properties Allowed: additionalProperties

Container for extension data
name(optional): string

Tender Name
tenderId: integer

Tender Identifier
type: string

Allowed Values: [ "serviceTotal", "payment" ]

Tender Type

Example: serviceTotal

{
    "description":"Definition of a tender that can be applied to a transaction. A tender can be either a 'service total' or a 'payment'. A 'service total' is used to submit an order without payment.\n",
    "type":"object",
    "required":[
        "tenderId",
        "type"
    ],
    "properties":{
        "tenderId":{
            "description":"Tender Identifier",
            "type":"integer"
        },
        "name":{
            "description":"Tender Name",
            "type":"string"
        },
        "type":{
            "description":"Tender Type",
            "type":"string",
            "enum":[
                "serviceTotal",
                "payment"
            ],
            "example":"serviceTotal"
        },
        "ConsumerContentProperties":{
            "$ref":"#/definitions/ConsumerContentProperties"
        },
        "extensions":{
            "$ref":"#/definitions/ExtensionData"
        }
    }
}

Nested Schema : ConsumerContentProperties

Type: object

A collection of consumer based content

Show Source

consumerDescription(optional): object TranslatedString

Additional Properties Allowed: additionalProperties

A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
consumerName(optional): object TranslatedString

Additional Properties Allowed: additionalProperties

A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
images(optional): array images

Array of images.

{
    "description":"A collection of consumer based content\n",
    "type":"object",
    "properties":{
        "consumerName":{
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerDescription":{
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "description":"Array of images.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImageLink"
            }
        }
    }
}

Nested Schema : ExtensionData

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

{
    "description":"Container for extension data",
    "additionalProperties":{
        "type":"object"
    }
}

Container for extension data

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"A string that contains translations into multiple languages\nExample:n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\"}`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee"
}

Nested Schema : images

Type: array

Array of images.

Show Source

Array of: object ImageLink

Represents a link to an image

{
    "description":"Array of images.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImageLink"
    }
}

Nested Schema : ImageLink

Type: object

Represents a link to an image

Show Source

altText(optional): string

Alt text for the image

Example: pizza
description(optional): string

Description text for the image
index(optional): string

Unique identifier for the image
isCloudImage(optional): boolean
size(optional): string

Image size
url: string

URL for the image.

Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "description":"Represents a link to an image",
    "type":"object",
    "required":[
        "url",
        "tags"
    ],
    "properties":{
        "index":{
            "description":"Unique identifier for the image",
            "type":"string"
        },
        "url":{
            "description":"URL for the image.\n",
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg"
        },
        "altText":{
            "description":"Alt text for the image",
            "type":"string",
            "example":"pizza"
        },
        "description":{
            "description":"Description text for the image",
            "type":"string"
        },
        "isCloudImage":{
            "type":"boolean"
        },
        "size":{
            "description":"Image size",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

304 Response

304 Not Modified

400 Response

400 Bad Request

Root Schema : ConfigurationApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). The content type for this response is `application/problem+json`

Show Source

details(optional): string

A human-readable explanation specific to this occurrence of the problem.

Example: The OrgShortName value is required.
instance(optional): string

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example: required_value_missing
title(optional): string

A short, human-readable summary of the problem type.

Example: Required value not specified.
type(optional): string

A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).\n\nThe content type for this response is `application/problem+json`\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.\n",
            "type":"string",
            "example":"Required value not specified.\n"
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.\n",
            "type":"string",
            "example":"The OrgShortName value is required.\n"
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n",
            "type":"string",
            "example":"required_value_missing"
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:


{
  "orgShortName": "mymeal",
  "locRef": "store66",
  "rvcRef": 2,
  "items": [
    {
      "tenderId": 0,
      "name": "string",
      "type": "serviceTotal",
      "consumerName": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "????????"
      },
      "consumerDescription": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "????????"
      },
      "images": [
        {
          "index": "string",
          "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
          "altText": "pizza",
          "description": "string",
          "isCloudImage": true,
          "size": "string"
        }
      ],
      "extensions": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ]
}