Jump to

• Request
• Response

Update Headers/Trailers

post

/config/sim/v1/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

Body ()

Headers Trailers Request Body

Root Schema : HeadersTrailersCURequestBody

Type: object

Show Source

• 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 reference

  Example: 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

{
    "type":"object",
    "required":[
        "hierUnitId",
        "lineNum",
        "descriptorTypeNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":6384,
            "description":"Unique hierarchy unit reference"
        },
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"Line Number of the Header/Trailer\n\n| descriptorTypeNum | Max Number of Lines Allowed         |\n|-------------------|---------------------------------|\n|       1           |  6           |\n|       2           | 6            |\n|       3            | 3                |                  \n|       5            |  12                 |\n|        7           |  6            |\n|         8          |  12          |\n|          37         |  6          |\n|           46        |  3    |\n|           47        | 12                 |\n|           52        | 12                 |\n|           53        | 12                |\n"
        },
        "descriptorTypeNum":{
            "type":"integer",
            "example":2,
            "description":"Descriptor Type Number assigned to the Header/Trailer \n\n| descriptorTypeNum | descriptorTypeName              |\n|-------------------|---------------------------------|\n|       1           | Customer Receipt Header         |\n|       2           | Check Header              |\n|       3            | Training Header                |                  \n|       5            |  Check Trailer                 |\n|        7           |  Credit Card Header            |\n|         8          |  Credit Card Trailer           |\n|          37         |  Autofire Check Offline Header|\n|           46        |  Waste Header                 |\n|           47        | Waste Trailer                 |\n|           52        | Report Header                 |\n|           53        | Report Trailer                |\n"
        },
        "useLogo":{
            "type":"boolean",
            "example":true,
            "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified."
        },
        "text":{
            "type":"object",
            "description":"A string that contains the text of a line in multiple languages.\n",
            "example":{
                "en-US":"Please visit again!",
                "de-DE":"Bitte schauen Sie noch einmal vorbei!",
                "es-MX":"Por favor visite de nuevo!"
            }
        },
        "logoObjectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the logo."
        }
    }
}

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!"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

response object

Body ()

Root Schema : HeadersTrailersResponse

Type: object

Show Source

• descriptorTypeNum(required): integer
  Example: 2
• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1
• lineNum(required): integer
  line number added

  Example: 1

{
    "type":"object",
    "required":[
        "lineNum",
        "descriptorTypeNum",
        "hierUnitId"
    ],
    "properties":{
        "lineNum":{
            "type":"integer",
            "example":1,
            "description":"line number added"
        },
        "descriptorTypeNum":{
            "type":"integer",
            "example":2
        },
        "hierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Unique hierarchy unit value"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

  Example: 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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top