Configuration and Content API Guide

Update Headers Trailers By Channel Type

post

/config/sim/v2/setup/updateHeadersTrailersByChannelType

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Headers Trailers by Channel Type insert and update request body

Root Schema : schema

Type: object

Model for Headers Trailers by Channel Type Object Insert and Update Request

Show Source

descriptorLines: array descriptorLines

An array of descriptor lines
descriptorTypeNum(required): 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(required): integer

Unique reference of the hierarchy unit where the descriptor is configured.

Example: 3599
name(required): object name

Descriptor Name
objectNum(required): integer

Object number of the descriptor.

Example: 1

{
    "description":"Model for Headers Trailers by Channel Type Object Insert and Update Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name",
        "descriptorTypeNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the descriptor is configured.",
            "type":"integer",
            "example":3599
        },
        "objectNum":{
            "description":"Object number of the descriptor.",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"Descriptor Name",
            "type":"object",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "descriptorTypeNum":{
            "description":"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.",
            "type":"integer",
            "example":55
        },
        "descriptorLines":{
            "description":"An array of descriptor lines",
            "type":"array",
            "items":{
                "properties":{
                    "lineNum":{
                        "description":"Line Number of the Header/Trailer. The valid range for lineNum for headers is 1-6 and for trailers is 1-12.",
                        "type":"integer",
                        "example":55
                    },
                    "useLogo":{
                        "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified.",
                        "type":"boolean",
                        "example":false
                    },
                    "text":{
                        "description":"A string that contains the text of a line in multiple languages.",
                        "type":"object",
                        "example":{
                            "1":"Please visit again!",
                            "2":"Bitte schauen Sie noch einmal vorbei!",
                            "3":"Por favor visite de nuevo!"
                        }
                    },
                    "logoObjectNum":{
                        "description":"Object Number of the logo.",
                        "type":"integer",
                        "example":0
                    }
                }
            }
        }
    }
}

Nested Schema : descriptorLines

Type: array

An array of descriptor lines

Show Source

Array of: object items

{
    "description":"An array of descriptor lines",
    "type":"array",
    "items":{
        "properties":{
            "lineNum":{
                "description":"Line Number of the Header/Trailer. The valid range for lineNum for headers is 1-6 and for trailers is 1-12.",
                "type":"integer",
                "example":55
            },
            "useLogo":{
                "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified.",
                "type":"boolean",
                "example":false
            },
            "text":{
                "description":"A string that contains the text of a line in multiple languages.",
                "type":"object",
                "example":{
                    "1":"Please visit again!",
                    "2":"Bitte schauen Sie noch einmal vorbei!",
                    "3":"Por favor visite de nuevo!"
                }
            },
            "logoObjectNum":{
                "description":"Object Number of the logo.",
                "type":"integer",
                "example":0
            }
        }
    }
}

Nested Schema : name

Type: object

Descriptor Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : items

Type: object

Show Source

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

{
    "properties":{
        "lineNum":{
            "description":"Line Number of the Header/Trailer. The valid range for lineNum for headers is 1-6 and for trailers is 1-12.",
            "type":"integer",
            "example":55
        },
        "useLogo":{
            "description":"Boolean flag for using either logoObjectNum(true) or text(false) for the specified lineNum. Automatically set to false if value is not specified.",
            "type":"boolean",
            "example":false
        },
        "text":{
            "description":"A string that contains the text of a line in multiple languages.",
            "type":"object",
            "example":{
                "1":"Please visit again!",
                "2":"Bitte schauen Sie noch einmal vorbei!",
                "3":"Por favor visite de nuevo!"
            }
        },
        "logoObjectNum":{
            "description":"Object Number of the logo.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : text

Type: object

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

Response

Supported Media Types

application/json

200 Response

Update operation executed successfully.

Root Schema : schema

Type: object

Show Source

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 hierarchy unit value.

Example: 1
objectNum: integer

Object number of the descriptor

Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value.",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the descriptor",
            "type":"integer",
            "example":1
        },
        "descriptorTypeNum":{
            "description":"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.",
            "type":"integer",
            "example":55
        }
    }
}