Jump to

• Request
• Response

Get all valid division code

get

/service/v1/divisioncode/division

This endpoints is used to get all valid division code maintenance records based on given set of parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• corporateId(optional): string
• divisionCode(optional): string
• divisionName(optional): string
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : ScfTmDivCodeServiceCollection

Match All

Show Source

• object ScfTmCustDivisionCodeCollection
  Collection of custdivision.
• object ScfTmDivCodeServiceCollection-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/ScfTmCustDivisionCodeCollection"
        },
        {
            "type":"object",
            "properties":{
                "message":{
                    "type":"object",
                    "description":"Error Message",
                    "$ref":"#/definitions/ErrorDto"
                }
            }
        }
    ]
}

Nested Schema : ScfTmCustDivisionCodeCollection

Type: object

Collection of custdivision.

Show Source

• data(optional): array data
• paging(optional): object PagingDto
  Paging DTO

{
    "description":"Collection of custdivision.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ScfTmCustDivisionCodeDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : ScfTmDivCodeServiceCollection-allOf[1]

Type: object

Show Source

• message(optional): object ErrorDto

{
    "type":"object",
    "properties":{
        "message":{
            "type":"object",
            "description":"Error Message",
            "$ref":"#/definitions/ErrorDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ScfTmCustDivisionCodeDTO

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

Nested Schema : PagingDto

Type: object

Paging DTO

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : ScfTmCustDivisionCodeDTO

Type: object

Show Source

• countryCode(optional): string
  Country Code
• countryName(optional): string
  Country Name
• custDivisionMasterId(optional): string
  Customer Division Master Id
• divisionAddressLine1(optional): string
  Division Address Line1
• divisionAddressLine2(optional): string
  Division Address Line2
• divisionAddressLine3(optional): string
  Division Address Line3
• divisionAddressLine4(optional): string
  Division Address Line4
• divisionCode(optional): string
  Division Code
• divisionName(optional): string
  Division Name
• email(optional): string
  Email
• id(optional): string
  Id
• partyId(optional): string
  Party Id
• partyName(optional): string
  Party Name
• telNo(optional): string
  Telephone Number

{
    "type":"object",
    "properties":{
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "countryName":{
            "type":"string",
            "description":"Country Name"
        },
        "custDivisionMasterId":{
            "type":"string",
            "description":"Customer Division Master Id"
        },
        "divisionAddressLine1":{
            "type":"string",
            "description":"Division Address Line1"
        },
        "divisionAddressLine2":{
            "type":"string",
            "description":"Division Address Line2"
        },
        "divisionAddressLine3":{
            "type":"string",
            "description":"Division Address Line3"
        },
        "divisionAddressLine4":{
            "type":"string",
            "description":"Division Address Line4"
        },
        "divisionCode":{
            "type":"string",
            "description":"Division Code"
        },
        "divisionName":{
            "type":"string",
            "description":"Division Name"
        },
        "email":{
            "type":"string",
            "description":"Email"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "partyId":{
            "type":"string",
            "description":"Party Id"
        },
        "partyName":{
            "type":"string",
            "description":"Party Name"
        },
        "telNo":{
            "type":"string",
            "description":"Telephone Number"
        }
    }
}

Nested Schema : ErrorDto

Type: object

Show Source

• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Desc

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Desc"
        }
    }
}

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