Get Headers Trailers By Channel Type
post
/config/sim/v2/setup/getHeadersTrailersByChannelType
Request
Supported Media Types
- application/json
- multipart/form-data
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, 1792)
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : schema
Type:
Show Source
object-
count:
integer
Number of records returned on this pageExample:
10 -
hasMore:
boolean
Indicates whether there are additional pages of recordsExample:
true -
items:
array items
Headers Trailers By Channel Type records
-
limit:
integer
The maximum number of records returned on a pageExample:
10 -
offset:
integer
The page number of this data. Starts at 0.Example:
0 -
totalResults:
integer
Total number of records in the data setExample:
100
Nested Schema : items
Type:
arrayHeaders Trailers By Channel Type records
Show Source
-
Array of:
object HeadersTrailersByChannelType
Headers Trailers by Channel Type record
Nested Schema : HeadersTrailersByChannelType
Type:
objectHeaders Trailers by Channel Type record
Show Source
-
descriptorLines:
array descriptorLines
An array of descriptor lines
-
descriptorTypeNum:
integer
Descriptor type number. The valid values are - 55 => Check Header - Order Type/Order Channel, 56 => Check Trailer - Order Type/Order Channel, 57 => Receipt Header - Order Type/Order Channel.Example:
55 -
hierUnitId:
integer
Unique reference of the hierarchy unit where the descriptor is configured.Example:
3599 -
name:
object name
Descriptor name
-
objectNum:
integer
Object number of the descriptor.Example:
1
Nested Schema : name
Type:
objectDescriptor name
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : items
Type:
Show Source
object-
lineNum:
integer
Line Number of the Header/Trailer. The valid range for lineNum for headers is 1-6 and for trailers is 1-12.Example:
55 -
logoObjectNum:
integer
Object Number of the logo.Example:
0 -
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 lineNum. Automatically set to false if value is not specified.Example:
false
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!"
}