Get Headers/Trailers
post
/config/sim/v2/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:
Show Source
object-
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 returnedExample:
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 supportedExample:
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)
Response
Supported Media Types
- application/json
200 Response
A collection of Headers/Trailers
Root Schema : schema
Type:
Show Source
object-
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 Headers/Trailers objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Headers/Trailers objects of the organization.
Show Source
-
Array of:
object HeadersTrailersv2
Model for Headers Trailers Object
Nested Schema : HeadersTrailersv2
Type:
objectModel for Headers Trailers Object
Show Source
-
desciptorTypeName:
string
Descriptor Type Name assigned to the Header/TrailerExample:
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 referenceExample:
6384 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
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 -
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
Nested Schema : text
Type:
objectA string that contains the text of a line in multiple languages.
Example:
{
"1":"Please visit again!",
"2":"Bitte schauen Sie noch einmal vorbei!",
"3":"Por favor visite de nuevo!"
}