Get Headers/Trailers
post
/config/sim/v1/setup/getheaderstrailers
Gets Headers and Trailers.
Request
Supported Media Types
- application/json
- multipart/form-data
Get Request Body
Root Schema : HeadersTrailersGetRequestBody
Type:
Show Source
object-
include:
string
Example:
logoObjectNum -
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 translated strings returned.Example:
en-US, de-DE, es-MX -
limit:
integer
Number of results returned in this page. Not required if paging parameters are not supported.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
2 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
name:asc -
searchCriteria:
string
Search criteria to filter results based on field valueExample:
where equals(descriptorTypeNum, 2)
Response
Supported Media Types
- application/json
200 Response
A collection of Header/Trailer objects of the organization
Root Schema : HeadersTrailersGetResponse
Type:
Show Source
object-
count(required):
integer
Current response recount count.Example:
9 -
hasMore(required):
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items(required):
array items
Array of language objects of the organization.
-
limit(required):
integer
Server page sizeExample:
10 -
offset(required):
integer
Starting resource record indexExample:
0 -
totalResults(required):
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of language objects of the organization.
Show Source
-
Array of:
object HeadersTrailersResourceObject
Model for Headers Trailers Object
Nested Schema : HeadersTrailersResourceObject
Type:
objectModel for Headers Trailers Object
Show Source
-
desciptorTypeName(required):
string
Descriptor Type Name assigned to the Header/TrailerExample:
Check Trailer -
descriptorTypeNum(required):
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(required):
integer
Unique hierarchy unit referenceExample:
6384 -
hierUnitName(required):
object hierUnitName
A group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
lineNum(required):
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(required):
object logoName
A group of string objects representing the name of the corresponding logo in multiple languages
-
logoObjectNum(required):
integer
Object Number of the logo.Example:
1 -
text(required):
object text
A string that contains the text of a line in multiple languages.
-
useLogo(required):
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
Nested Schema : hierUnitName
Type:
objectA 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:
objectA 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:
objectA 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!"
}400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found