Jump to

• Request
• Response

Fetch the list of routing data

get

/service/v1/routing

This API fetches list of routing data based on given parameters.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• drawnOnBankCode(optional): string
  Drawn On Bank Code
• drawnOnBankName(optional): string
  Drawn On Bank Name
• drawnOnBranchCode(optional): string
  Brawn On Branch Code
• drawnOnBranchName(optional): string
  Drawn On Branch Name
• limit(optional): integer
  Limit To Be Fetched
• offset(optional): integer
  Offset Of Limit
• routingCode(optional): number
  Routing Code

Header Parameters

• appId: string
  Application Id
• authToken(optional): string
  Authorization Token
• branchCode: string
  Branch Code
• contentType(optional): string
  Content Type
• tenantId(optional): string
  Tenant Id
• userId: string
  UserId For SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : RoutingResponseModel

Type: object

Collection of RoutingModel

Show Source

• errors(optional): object errors
  List Of Errors
• paging(optional): object PagingDto
• routingData(optional): array routingData

{
    "description":"Collection of RoutingModel",
    "type":"object",
    "properties":{
        "routingData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RoutingModelDto"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "errors":{
            "type":"object",
            "description":"List Of Errors ",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errors

Type: object

List Of Errors

Show Source

• Array of: object Error
  Error Model

{
    "type":"object",
    "description":"List Of Errors ",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : routingData

Type: array

Show Source

• Array of: object RoutingModelDto
  To get the routing data

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

Nested Schema : Error

Type: object

Error Model

Show Source

• errorCode(optional): string
  Error Code
• errorDescription(optional): string
  Error Description
• errorStatus(optional): string
  Error Status

{
    "type":"object",
    "description":"Error Model",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDescription":{
            "type":"string",
            "description":"Error Description"
        },
        "errorStatus":{
            "type":"string",
            "description":"Error Status"
        }
    }
}

Nested Schema : RoutingModelDto

Type: object

To get the routing data

Show Source

• addressLine1(optional): string
  Address Line 1
• addressLine2(optional): string
  Address Line 2
• addressLine3(optional): string
  Address Line 3
• addressLine4(optional): string
  Address Line 4
• authStat(optional): string
  Authorization Status
• bankCode(optional): string
  Bank Code
• bankName(optional): string
  Bank Name
• branchCode(optional): string
  Branch Code
• branchName(optional): string
  Branch Name
• checkerDtStamp(optional): string
  Checker Date
• checkerId(optional): string
  Checker ID
• contactPerson(optional): string
  Contact Person
• countryCode(optional): string
  Country Code
• designation(optional): string
  Designation
• emailId(optional): string
  Email Id
• fax(optional): string
  Fax
• id(optional): string
  Routing Id
• locationClusterCode(optional): string
  Location Cluster Code
• locationClusterDesc(optional): string
  Location Cluster Description
• locationCode(optional): string
  Location Code
• locationDescription(optional): string
  Location Description
• makerDtStamp(optional): string
  Maker Date
• makerId(optional): string
  Maker Id
• mobileNo(optional): number
  Mobile Number
• modNo(optional): integer
  ModNo
• onceAuth(optional): string
  Once Authorization
• pincode(optional): string
  Pin Code
• recordStat(optional): string
  Record Status
• routingCode(optional): number
  Routing Code
• stateCode(optional): string
  State Code
• telephone(optional): number
  TelePhone Number

{
    "description":"To get the routing data",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Routing Id"
        },
        "recordStat":{
            "type":"string",
            "description":"Record Status"
        },
        "authStat":{
            "type":"string",
            "description":"Authorization Status"
        },
        "modNo":{
            "type":"integer",
            "description":"ModNo"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makerDtStamp":{
            "type":"string",
            "description":"Maker Date"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker ID"
        },
        "checkerDtStamp":{
            "type":"string",
            "description":"Checker Date"
        },
        "onceAuth":{
            "type":"string",
            "description":"Once Authorization"
        },
        "routingCode":{
            "type":"number",
            "description":"Routing Code"
        },
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "bankName":{
            "type":"string",
            "description":"Bank Name"
        },
        "branchName":{
            "type":"string",
            "description":"Branch Name"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationDescription":{
            "type":"string",
            "description":"Location Description"
        },
        "locationClusterCode":{
            "type":"string",
            "description":"Location Cluster Code"
        },
        "locationClusterDesc":{
            "type":"string",
            "description":"Location Cluster Description"
        },
        "addressLine1":{
            "type":"string",
            "description":"Address Line 1"
        },
        "addressLine2":{
            "type":"string",
            "description":"Address Line 2"
        },
        "addressLine3":{
            "type":"string",
            "description":"Address Line 3"
        },
        "addressLine4":{
            "type":"string",
            "description":"Address Line 4"
        },
        "contactPerson":{
            "type":"string",
            "description":"Contact Person"
        },
        "countryCode":{
            "type":"string",
            "description":"Country Code"
        },
        "designation":{
            "type":"string",
            "description":"Designation"
        },
        "emailId":{
            "type":"string",
            "description":"Email Id"
        },
        "fax":{
            "type":"string",
            "description":"Fax"
        },
        "mobileNo":{
            "type":"number",
            "description":"Mobile Number"
        },
        "pincode":{
            "type":"string",
            "description":"Pin Code"
        },
        "stateCode":{
            "type":"string",
            "description":"State Code"
        },
        "telephone":{
            "type":"number",
            "description":"TelePhone Number"
        }
    }
}

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