Update Headers/Trailers
post
/config/sim/v2/setup/updateHeadersTrailers
Updates the header/trailer for the specified organization. If header/trailer is not found, it creates a new header/trailer.
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string(string)
Detail that identifies that 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:
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!"
}Response
Supported Media Types
- application/json
200 Response
response object
Root Schema : HeadersTrailersResponse
Type:
Show Source
object-
descriptorTypeNum(required):
integer
Example:
2 -
hierUnitId(required):
integer
Unique hierarchy unit valueExample:
1 -
lineNum(required):
integer
line number addedExample:
1
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