Configuration and Content API Guide

Get Headers/Trailers

post

/config/sim/v1/setup/getheaderstrailers

Gets Headers and Trailers.

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

Objects included in the response.

Example: hierUnitId
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 10
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: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Headers/Trailers

Root Schema : HeadersTrailersGetResponsev1

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 language 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 language objects of the organization.",
            "items":{
                "$ref":"#/definitions/HeadersTrailersResourceObject"
            }
        },
        "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 language objects of the organization.

Show Source

Array of: object HeadersTrailersResourceObject

Model for Headers Trailers Object

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

Nested Schema : HeadersTrailersResourceObject

Type: object

Model for Headers Trailers Object

Show Source

desciptorTypeName: string

Descriptor Type Name assigned to the Header/Trailer

Example: Check Trailer
descriptorTypeNum: integer

Descriptor Type Number assigned to the Header/Trailer | descriptorTypeNum | descriptorTypeName | |-------------------|---------------------------------| | 1 | Customer Receipt Header | | 2 | Check Header | | 3 | Training Header | | 5 | Check Trailer | | 7 | Credit Card Header | | 8 | Credit Card Trailer | | 37 | Autofire Check Offline Header| | 46 | Waste Header | | 47 | Waste Trailer | | 52 | Report Header | | 53 | Report Trailer |

Example: 2
hierUnitId: integer

Unique hierarchy unit reference

Example: 6384
hierUnitName: object hierUnitName

A group of string objects representing the name of the hierarchy unit configured languages
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
lineNum: integer

Line Number of the Header/Trailer | descriptorTypeNum | Max Number of Lines Allowed | |-------------------|---------------------------------| | 1 | 6 | | 2 | 6 | | 3 | 3 | | 5 | 12 | | 7 | 6 | | 8 | 12 | | 37 | 6 | | 46 | 3 | | 47 | 12 | | 52 | 12 | | 53 | 12 |

Example: 1
logoName: object logoName

A group of string objects representing the name of the corresponding logo in multiple languages
logoObjectNum: integer

Object Number of the logo.

Example: 1
text: object text

A string that contains the text of a line in multiple languages.
useLogo: boolean

Boolean flag for using either logoObjectNum(true) or text(false) for the specified line. Automatically set to false if value is not specified.

Example: true

{
    "description":"Model for Headers Trailers Object",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":6384,
            "description":"Unique hierarchy unit reference"
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed         |\n|-------------------|---------------------------------|\n|       1           |  6           |\n|       2           | 6            |\n|       3            | 3                |                  \n|       5            |  12                 |\n|        7           |  6            |\n|         8          |  12          |\n|          37         |  6          |\n|           46        |  3    |\n|           47        | 12                 |\n|           52        | 12                 |\n|           53        | 12                |\n"
        },
        "descriptorTypeNum":{
            "type":"integer",
            "example":2,
            "description":"Descriptor Type Number assigned to the Header/Trailer \n\n| descriptorTypeNum | descriptorTypeName              |\n|-------------------|---------------------------------|\n|       1           | Customer Receipt Header         |\n|       2           | Check Header              |\n|       3            | Training Header                |                  \n|       5            |  Check Trailer                 |\n|        7           |  Credit Card Header            |\n|         8          |  Credit Card Trailer           |\n|          37         |  Autofire Check Offline Header|\n|           46        |  Waste Header                 |\n|           47        | Waste Trailer                 |\n|           52        | Report Header                 |\n|           53        | Report Trailer                |\n"
        },
        "desciptorTypeName":{
            "type":"string",
            "example":"Check Trailer",
            "description":"Descriptor Type Name assigned to the Header/Trailer"
        },
        "useLogo":{
            "type":"boolean",
            "example":true,
            "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified line. Automatically set to false if value is not specified."
        },
        "text":{
            "type":"object",
            "description":"A string that contains the text of a line in multiple languages.\n",
            "example":{
                "en-US":"Please visit again!",
                "de-DE":"Bitte schauen Sie noch einmal vorbei!",
                "es-MX":"Por favor visite de nuevo!"
            }
        },
        "logoObjectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the logo."
        },
        "logoName":{
            "type":"object",
            "description":"A group of string objects representing the name of the corresponding logo in multiple languages",
            "example":{
                "en-US":"Circle logo",
                "de-DE":"Kreis-Logo",
                "es-MX":"logotipo del c??rculo"
            }
        }
    }
}

Nested Schema : hierUnitName

Type: object

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : logoName

Type: object

A group of string objects representing the name of the corresponding logo in multiple languages

Example:

{
    "en-US":"Circle logo",
    "de-DE":"Kreis-Logo",
    "es-MX":"logotipo del c??rculo"
}

Nested Schema : text

Type: object

A string that contains the text of a line in multiple languages.

Example:

{
    "en-US":"Please visit again!",
    "de-DE":"Bitte schauen Sie noch einmal vorbei!",
    "es-MX":"Por favor visite de nuevo!"
}