Jump to

• Request
• Response

Fetch the core branch details

post

/service/v1/corebranch/getByLocList

This API fetches core branch details based on list of location.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId(required): string
  Application Id
• authToken: string
  Authorization Token
• branchCode(required): string
  Branch Code
• contentType: string
  Content Type
• userId(required): string
  User id for SMS

Body ()

Request Body that contains data required for getting data

Root Schema : LocationModel

Type: object

location model

Show Source

• locations: array locations
  List of locations

{
    "description":"location model",
    "type":"object",
    "properties":{
        "locations":{
            "type":"array",
            "description":"List of locations",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : locations

Type: array

List of locations

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of locations",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation

Body ()

Root Schema : CmcCoreBranchCollection

Type: object

Collection of Cmc Core Branch Model Objects.

Show Source

• data: array data
  List of Bank Branch Objects.
• paging: object PagingDto
  Paging Dto

{
    "description":"Collection of Cmc Core Branch Model Objects.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"List of Bank Branch Objects.",
            "items":{
                "$ref":"#/definitions/CmcCoreBranchModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

List of Bank Branch Objects.

Show Source

• Array of: object CmcCoreBranchModel
  Cmc Core Branch Model.

{
    "type":"array",
    "description":"List of Bank Branch Objects.",
    "items":{
        "$ref":"#/definitions/CmcCoreBranchModel"
    }
}

Nested Schema : PagingDto

Type: object

Paging Dto

Show Source

• totalResults: integer
  Total Results

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

Nested Schema : CmcCoreBranchModel

Type: object

Cmc Core Branch Model.

Show Source

• addressLine1: string
  Address line 1
• addressLine2: string
  Address line 2
• addressLine3: string
  Address line 3
• addressLine4: string
  Address line 4
• autoAuth: string
  Bank code
• branchCode: string
  Bank name
• branchLcy: string
  Branch code
• branchName: string
  Branch name
• contactPerson: string
  Contact Person
• countryCode: string
  Country code
• designation: string
  Designation
• emailId: string
  Email Id
• fax: string
  Fax
• hoBranch: string
  Home Branch
• hostCode: string
  hostCode
• isServiceBranch: string
  Is Service Branch (Y/N)
• localCcy: string
  Local Currency
• locationClusterCode: string
  Location Cluster Code
• locationClusterDesc: string
  Location Cluster Description
• locationCode: string
  Location Code
• locationDesc: string
  Location Description
• mobileNo: number
  Mobile Number
• pinCode: string
  Pincode
• routingCode: number
  Rounting Code
• sourceBranchCode: string
  Source Branch Code
• sourceSystem: string
  Source System
• stateCode: string
  State Code
• telephone: number
  Telephone
• walkinCustomer: string
  Walk In Customer
• weekHol1: string
  Week Holiday 1
• weekHol2: string
  Week Holiday 2

{
    "description":"Cmc Core Branch Model.",
    "type":"object",
    "properties":{
        "addressLine1":{
            "description":"Address line 1",
            "type":"string"
        },
        "addressLine2":{
            "description":"Address line 2",
            "type":"string"
        },
        "addressLine3":{
            "description":"Address line 3",
            "type":"string"
        },
        "addressLine4":{
            "description":"Address line 4",
            "type":"string"
        },
        "autoAuth":{
            "description":"Bank code",
            "type":"string"
        },
        "branchCode":{
            "description":"Bank name",
            "type":"string"
        },
        "branchLcy":{
            "description":"Branch code",
            "type":"string"
        },
        "branchName":{
            "description":"Branch name",
            "type":"string"
        },
        "contactPerson":{
            "description":"Contact Person",
            "type":"string"
        },
        "countryCode":{
            "description":"Country code",
            "type":"string"
        },
        "designation":{
            "description":"Designation",
            "type":"string"
        },
        "emailId":{
            "description":"Email Id",
            "type":"string"
        },
        "fax":{
            "description":"Fax",
            "type":"string"
        },
        "locationCode":{
            "description":"Location Code",
            "type":"string"
        },
        "hostCode":{
            "description":"hostCode",
            "type":"string"
        },
        "isServiceBranch":{
            "description":"Is Service Branch (Y/N)",
            "type":"string"
        },
        "hoBranch":{
            "description":"Home Branch",
            "type":"string"
        },
        "localCcy":{
            "description":"Local Currency",
            "type":"string"
        },
        "mobileNo":{
            "description":"Mobile Number",
            "type":"number"
        },
        "pinCode":{
            "description":"Pincode",
            "type":"string"
        },
        "routingCode":{
            "description":"Rounting Code",
            "type":"number"
        },
        "sourceBranchCode":{
            "description":"Source Branch Code",
            "type":"string"
        },
        "sourceSystem":{
            "description":"Source System",
            "type":"string"
        },
        "stateCode":{
            "description":"State Code",
            "type":"string"
        },
        "telephone":{
            "description":"Telephone",
            "type":"number"
        },
        "locationDesc":{
            "description":"Location Description",
            "type":"string"
        },
        "locationClusterCode":{
            "description":"Location Cluster Code",
            "type":"string"
        },
        "locationClusterDesc":{
            "description":"Location Cluster Description",
            "type":"string"
        },
        "walkinCustomer":{
            "description":"Walk In Customer",
            "type":"string"
        },
        "weekHol1":{
            "description":"Week Holiday 1",
            "type":"string"
        },
        "weekHol2":{
            "description":"Week Holiday 2",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top