Jump to

• Request
• Response

Fetch the list of correspondant bank setup for location code

get

/service/v1/location/corrbanks/{locationCode}

This API fetches list of correspondant bank setup for location code.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• locationCode: string
  location code of the location that needs to be fetched

Header Parameters

• appId: string
  App ID
• branchCode: string
  branchCode
• userId: string
  userId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the location based on given id.

Body ()

Root Schema : CmTmLocCorrBankCollection

Type: object

Collection of CmTmLocCorrBank DTO.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object CmTmLocCorrBankDTO
  CmTmLocCorrBank DTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : CmTmLocCorrBankDTO

Type: object

CmTmLocCorrBank DTO

Show Source

• bankCode(optional): string
  Bank Code
• bankDescription(optional): string
  Bank Description
• branchCode(optional): string
  Branch Code
• branchDescription(optional): string
  Branch Description
• id(optional): string
  ID
• locationCode(optional): string
  Location Code
• locationMasterId(optional): string
  Location Master ID
• priority(optional): number
  Priority

{
    "description":"CmTmLocCorrBank DTO",
    "type":"object",
    "properties":{
        "bankCode":{
            "type":"string",
            "description":"Bank Code"
        },
        "bankDescription":{
            "type":"string",
            "description":"Bank Description"
        },
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchDescription":{
            "type":"string",
            "description":"Branch Description"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationMasterId":{
            "type":"string",
            "description":"Location Master ID"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        }
    }
}

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