Configuration and Content API Guide

Delete Header/Trailer

post

/config/sim/v2/setup/deleteHeadersTrailers

Deletes the header/trailer object for the specified organization.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string(string)

Detail that identifies that who made the change

Order Type Delete Request Body

Root Schema : HeadersTrailersDeleteRequestBody

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

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

{
    "type":"object",
    "required":[
        "hierUnitId",
        "lineNum",
        "descriptorTypeNum"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":"1"
        },
        "lineNum":{
            "type":"integer",
            "example":"2",
            "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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A message depicting the number of records deleted

Root Schema : HeadersTrailersDeleteResponse

Type: object

Show Source

msg(required): string

Example: 1 record deleted

{
    "type":"object",
    "required":[
        "msg"
    ],
    "properties":{
        "msg":{
            "type":"string",
            "example":"1 record deleted"
        }
    }
}

400 Response

400 Bad Request

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