Jump to

• Request
• Response

Deletes/Closes a new division code

patch

/service/v1/divisioncode/division

This endpoint is used to deletes/closes a new division code.

Request

Supported Media Types

• application/json
• application/xml

Body ()

Request Body that contains data required for creating a new divisioncode

Root Schema : DivCodeDeleteDTO

Type: object

Show Source

• authRequire(optional): string
  Post Authorization is required or Not.
• corporateId(optional): string
  Corporate Id
• deleteClose(optional): string
  Delete or Close
• divisionCode(optional): string
  Division Code to be deleted or closed.

{
    "type":"object",
    "properties":{
        "corporateId":{
            "description":"Corporate Id",
            "type":"string"
        },
        "divisionCode":{
            "description":"Division Code to be deleted or closed.",
            "type":"string"
        },
        "deleteClose":{
            "type":"string",
            "description":"Delete or Close"
        },
        "authRequire":{
            "type":"string",
            "description":"Post Authorization is required or Not."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created divisioncode

Body ()

Root Schema : DeleteDivCode

Type: object

Show Source

• authStatus(optional): string
  Authorization Status
• corporateId(optional): string
  Corporate id
• divisionCodes(optional): array divisionCodes
  div code
• errors(optional): array errors
  Error List
• modNo(optional): string
  Latest Modification No.
• recordStatus(optional): string
  recordStatus
• responseCode(optional): string
  Response - SUCCESS/FAILURE

{
    "type":"object",
    "properties":{
        "corporateId":{
            "type":"string",
            "description":"Corporate id"
        },
        "divisionCodes":{
            "type":"array",
            "description":"div code",
            "items":{
                "$ref":"#/definitions/divisionCodeResponseDTOColl",
                "description":"division code"
            }
        },
        "recordStatus":{
            "type":"string",
            "description":"recordStatus"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "errors":{
            "type":"array",
            "description":"Error List",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        },
        "responseCode":{
            "type":"string",
            "description":"Response - SUCCESS/FAILURE"
        },
        "modNo":{
            "type":"string",
            "description":"Latest Modification No."
        }
    }
}

Nested Schema : divisionCodes

Type: array

div code

Show Source

• Array of: object divisionCodeResponseDTOColl

{
    "type":"array",
    "description":"div code",
    "items":{
        "$ref":"#/definitions/divisionCodeResponseDTOColl",
        "description":"division code"
    }
}

Nested Schema : errors

Type: array

Error List

Show Source

• Array of: object ErrorDto

{
    "type":"array",
    "description":"Error List",
    "items":{
        "$ref":"#/definitions/ErrorDto"
    }
}

Nested Schema : divisionCodeResponseDTOColl

Type: object

Show Source

• divisionCode(optional): string
  Division Code
• divisionName(optional): string
  Division Name

{
    "type":"object",
    "properties":{
        "divisionCode":{
            "type":"string",
            "description":"Division Code"
        },
        "divisionName":{
            "type":"string",
            "description":"Division Name"
        }
    }
}

Nested Schema : ErrorDto

Type: object

Show Source

• errorCode(optional): string
  Error Codes Displaying
• errorDesc(optional): string
  Error Description displaying based on error codes

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Codes Displaying"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description displaying based on error codes"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top