Jump to

• Request
• Response

Adds a new division code

post

/service/v1/divisioncode/division

This endpoint is used to add a new division code.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
  branchCode
• userId: string
  userId

Body ()

Request Body that contains data required for creating a new divisioncode

Root Schema : CreateServiceCollection

Match All

Show Source

• object allOf ScfTmCustDivisionMasterDTO
• object CreateServiceCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ScfTmCustDivisionMasterDTO"
        },
        {
            "type":"object",
            "properties":{
                "authRequire":{
                    "type":"string",
                    "description":"Auth Status Y/N"
                }
            }
        }
    ]
}

Nested Schema : ScfTmCustDivisionMasterDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ScfTmCustDivisionMasterDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "partyId":{
                    "type":"string",
                    "description":"Party Id"
                },
                "partyName":{
                    "type":"string",
                    "description":"Party Name"
                },
                "ScfTmCustDivisionCodeDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ScfTmCustDivisionCodeDTO"
                    }
                }
            },
            "required":[
                "partyId",
                "partyName"
            ]
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ScfTmCustDivisionMasterDTO-allOf[1]

Type: object

Show Source

• partyId: string
  Party Id
• partyName: string
  Party Name
• ScfTmCustDivisionCodeDTO(optional): array ScfTmCustDivisionCodeDTO

{
    "type":"object",
    "properties":{
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "ScfTmCustDivisionCodeDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmCustDivisionCodeDTO"
            }
        }
    },
    "required":[
        "partyId",
        "partyName"
    ]
}

Nested Schema : CreateServiceCollection-allOf[1]

Type: object

Show Source

• authRequire(optional): string
  Auth Status Y/N

{
    "type":"object",
    "properties":{
        "authRequire":{
            "type":"string",
            "description":"Auth Status Y/N"
        }
    }
}

Nested Schema : ScfTmCustDivisionCodeDTO

Type: array

Show Source

• Array of: object ScfTmCustDivisionCodeDTO
  Collection of Division.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScfTmCustDivisionCodeDTO"
    }
}

Nested Schema : ScfTmCustDivisionCodeDTO

Type: object

Collection of Division.

Show Source

• authStatus(optional): string
  Auth Status
• countryCode(optional): string
  Country Code
• countryName(optional): string
  Country Name
• custDivisionMasterId(optional): string
  Customet Division Master ID
• divisionAddressLine1(optional): string
  Division Address Line 1
• divisionAddressLine2(optional): string
  Division Address Line 2
• divisionAddressLine3(optional): string
  Division Address Line 3
• divisionAddressLine4(optional): string
  Division Address Line 4
• divisionCode(optional): string
  Division Code
• divisionName(optional): string
  Division Name
• email(optional): string
  Email Address
• id(optional): string
  Division Id
• partyId(optional): string
  Party Id
• partyName(optional): string
  Party Name
• telNo(optional): string
  Telphone Number

{
    "description":"Collection of Division.",
    "type":"object",
    "properties":{
        "authStatus":{
            "type":"string",
            "description":"Auth Status"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "countryName":{
            "type":"string",
            "description":"Country Name"
        },
        "custDivisionMasterId":{
            "type":"string",
            "description":"Customet Division Master ID"
        },
        "divisionAddressLine1":{
            "type":"string",
            "description":"Division Address Line 1"
        },
        "divisionAddressLine2":{
            "type":"string",
            "description":"Division Address Line 2"
        },
        "divisionAddressLine3":{
            "type":"string",
            "description":"Division Address Line 3"
        },
        "divisionAddressLine4":{
            "type":"string",
            "description":"Division Address Line 4"
        },
        "divisionCode":{
            "type":"string",
            "description":"Division Code"
        },
        "divisionName":{
            "type":"string",
            "description":"Division Name"
        },
        "email":{
            "type":"string",
            "description":"Email Address"
        },
        "id":{
            "type":"string",
            "description":"Division Id"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "telNo":{
            "type":"string",
            "description":"Telphone Number"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created divisioncode

Body ()

Root Schema : CreateDivCode

Type: object

Show Source

• authStatus(optional): string
  Authorization Status
• corporateId(optional): string
  Corp id
• divisionCodeResponseDTO(optional): array divisionCodeResponseDTO
  div code
• errors(optional): array errors
  Error List
• id(optional): string
  Id
• modNo(optional): string
  Mod Number
• responseCode(optional): string
  Response Code

{
    "type":"object",
    "properties":{
        "corporateId":{
            "type":"string",
            "description":"Corp id"
        },
        "divisionCodeResponseDTO":{
            "type":"array",
            "description":"div code",
            "items":{
                "$ref":"#/definitions/divisionCodeResponseDTOColl"
            }
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "responseCode":{
            "type":"string",
            "description":"Response Code"
        },
        "modNo":{
            "type":"string",
            "description":"Mod Number"
        },
        "errors":{
            "type":"array",
            "description":"Error List",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        }
    }
}

Nested Schema : divisionCodeResponseDTO

Type: array

div code

Show Source

• Array of: object divisionCodeResponseDTOColl

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

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