Configuration and Content API Guide

Get Payment Drivers

post

/content/sim/v2/setup/getPaymentDrivers

Gets all the payment drivers

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Payment Drivers

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Payment Drivers objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Payment Drivers objects of the organization.",
            "items":{
                "$ref":"#/definitions/PaymentDriverv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Payment Drivers objects of the organization.

Show Source

Array of: object PaymentDriverv2

{
    "type":"array",
    "description":"Array of Payment Drivers objects of the organization.",
    "items":{
        "$ref":"#/definitions/PaymentDriverv2"
    }
}

Nested Schema : PaymentDriverv2

Type: object

Show Source

filename: string

The name of the image file with extension.

Example: OPIPayment.dll
filenameOrigin: string

the content file origin.

Example: C:\Program Files\Oracle Hospitality\EMCClient\OPIPayment.dll
hierUnitId: integer

Unique hierarchy unit value

Example: 1
hierUnitObjNum: integer

Hierarchy unit object number

Example: 1
name: object name

A group of string objects representing the name of the payment driver in configured languages
objectNum: integer

Object number of the workstation

Example: 1
type: integer

the type of the file.

Example: 26
url: object url

The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        },
        "hierUnitObjNum":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy unit object number"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the workstation"
        },
        "name":{
            "description":"A group of string objects representing the name of the payment driver in configured languages",
            "type":"object",
            "example":{
                "1":"Payment Driver",
                "2":"Zahlungstreiber",
                "3":"Conductor de pago"
            }
        },
        "type":{
            "type":"integer",
            "example":26,
            "description":"the type of the file."
        },
        "filenameOrigin":{
            "type":"string",
            "example":"C:\\Program Files\\Oracle Hospitality\\EMCClient\\OPIPayment.dll",
            "description":"the content file origin."
        },
        "filename":{
            "type":"string",
            "example":"OPIPayment.dll",
            "description":"The name of the image file with extension."
        },
        "url":{
            "type":"object",
            "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.",
            "properties":{
                "params":{
                    "type":"object",
                    "properties":{
                        "hierUnitId":{
                            "description":"Unique reference of the hierarchy unit",
                            "type":"integer",
                            "example":2
                        },
                        "objectNum":{
                            "description":"Object Number of the payment driver",
                            "type":"integer",
                            "example":1
                        }
                    }
                },
                "endpoint":{
                    "type":"string",
                    "example":"https://abc.com/content/sim/v1/setup/downloadpaymentdrivers"
                }
            }
        }
    }
}

Nested Schema : name

Type: object

A group of string objects representing the name of the payment driver in configured languages

Example:

{
    "1":"Payment Driver",
    "2":"Zahlungstreiber",
    "3":"Conductor de pago"
}

Nested Schema : url

Type: object

The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.

Show Source

endpoint: string

Example: https://abc.com/content/sim/v1/setup/downloadpaymentdrivers
params: object params

{
    "type":"object",
    "description":"The URL of the download API which needs to be used to download the actual content file. This is auto-generated and does not need to be provided during add/update calls.",
    "properties":{
        "params":{
            "type":"object",
            "properties":{
                "hierUnitId":{
                    "description":"Unique reference of the hierarchy unit",
                    "type":"integer",
                    "example":2
                },
                "objectNum":{
                    "description":"Object Number of the payment driver",
                    "type":"integer",
                    "example":1
                }
            }
        },
        "endpoint":{
            "type":"string",
            "example":"https://abc.com/content/sim/v1/setup/downloadpaymentdrivers"
        }
    }
}

Nested Schema : params

Type: object

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit

Example: 2
objectNum: integer

Object Number of the payment driver

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the payment driver",
            "type":"integer",
            "example":1
        }
    }
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details