Add Headers/Trailers
post
/config/sim/v1/setup/headerstrailers
Add the header/trailer object of a specific type to a specified hierarchy unit of specified organization.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Headers Trailers Request Body
Root Schema : HeadersTrailersCURequestBody
Type:
Show Source
object
-
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
-
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
-
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 lineNum. Automatically set to false if value is not specified.Example:
true
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!"
}
Response
Supported Media Types
- application/json
200 Response
Header/Trailer Added.
Root Schema : HeadersTrailersResponse
Type:
Show Source
object
-
descriptorTypeNum:
integer
Example:
2
-
hierUnitId:
integer
Unique hierarchy unit valueExample:
1
-
lineNum:
integer
line number addedExample:
1