Jump to

• Request
• Response

Fetch the location setup by location code

get

/service/v1/location/{locationCode}

This API fetches location setup by location code.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

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

Query Parameters

• recordStat(optional): string
  record status 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 : CmTmLocationLinkWrapperDTO

Type: object

CmTmLocation Link Wrapper DTO

Show Source

• data(optional): object CmTmLocationLinkDTO
  CmTmLocationLink DTO

{
    "type":"object",
    "description":"CmTmLocation Link Wrapper DTO",
    "properties":{
        "data":{
            "$ref":"#/definitions/CmTmLocationLinkDTO"
        }
    }
}

Nested Schema : CmTmLocationLinkDTO

Type: object

CmTmLocationLink DTO

Match All

Show Source

• allOf GenericDto
• object CmTmLocationLinkDTO-allOf[1]

{
    "description":"CmTmLocationLink DTO",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Reference Number"
                },
                "calendarCode":{
                    "type":"string",
                    "description":"Calendar Code"
                },
                "clearingNetwork":{
                    "type":"string",
                    "description":"Clearing Network"
                },
                "highValueCutoffAmt":{
                    "type":"number",
                    "description":"High Value Cutoff Amount"
                },
                "highValueCutoffAmtCcy":{
                    "type":"string",
                    "description":"High Value Cutoff Amount Currency"
                },
                "locationClusterCode":{
                    "type":"string",
                    "description":"Location Cluster Code"
                },
                "locationClusterDescription":{
                    "type":"string",
                    "description":"Location Cluster Description"
                },
                "locationCode":{
                    "type":"string",
                    "description":"Location Code"
                },
                "locationDescription":{
                    "type":"string",
                    "description":"Location Description"
                },
                "CmTmLocCorrBankDTO":{
                    "type":"array",
                    "description":"CmTmLocCorrBank DTO",
                    "items":{
                        "$ref":"#/definitions/CmTmLocCorrBankDTO"
                    }
                },
                "CmTmLocOsNwBankDTO":{
                    "type":"array",
                    "description":"CmTmLocOsNwBank DTO",
                    "items":{
                        "$ref":"#/definitions/CmTmLocOsNwBankDTO"
                    }
                },
                "CmTmLocOwnBranchDTO":{
                    "type":"array",
                    "description":"CmTmLocOwnBranch DTO",
                    "items":{
                        "$ref":"#/definitions/CmTmLocOwnBranchDTO"
                    }
                }
            }
        }
    ]
}

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 : CmTmLocationLinkDTO-allOf[1]

Type: object

Show Source

• calendarCode(optional): string
  Calendar Code
• clearingNetwork(optional): string
  Clearing Network
• CmTmLocCorrBankDTO(optional): array CmTmLocCorrBankDTO
  CmTmLocCorrBank DTO
• CmTmLocOsNwBankDTO(optional): array CmTmLocOsNwBankDTO
  CmTmLocOsNwBank DTO
• CmTmLocOwnBranchDTO(optional): array CmTmLocOwnBranchDTO
  CmTmLocOwnBranch DTO
• highValueCutoffAmt(optional): number
  High Value Cutoff Amount
• highValueCutoffAmtCcy(optional): string
  High Value Cutoff Amount Currency
• locationClusterCode(optional): string
  Location Cluster Code
• locationClusterDescription(optional): string
  Location Cluster Description
• locationCode(optional): string
  Location Code
• locationDescription(optional): string
  Location Description
• txnControllerRefNo(optional): string
  Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "calendarCode":{
            "type":"string",
            "description":"Calendar Code"
        },
        "clearingNetwork":{
            "type":"string",
            "description":"Clearing Network"
        },
        "highValueCutoffAmt":{
            "type":"number",
            "description":"High Value Cutoff Amount"
        },
        "highValueCutoffAmtCcy":{
            "type":"string",
            "description":"High Value Cutoff Amount Currency"
        },
        "locationClusterCode":{
            "type":"string",
            "description":"Location Cluster Code"
        },
        "locationClusterDescription":{
            "type":"string",
            "description":"Location Cluster Description"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationDescription":{
            "type":"string",
            "description":"Location Description"
        },
        "CmTmLocCorrBankDTO":{
            "type":"array",
            "description":"CmTmLocCorrBank DTO",
            "items":{
                "$ref":"#/definitions/CmTmLocCorrBankDTO"
            }
        },
        "CmTmLocOsNwBankDTO":{
            "type":"array",
            "description":"CmTmLocOsNwBank DTO",
            "items":{
                "$ref":"#/definitions/CmTmLocOsNwBankDTO"
            }
        },
        "CmTmLocOwnBranchDTO":{
            "type":"array",
            "description":"CmTmLocOwnBranch DTO",
            "items":{
                "$ref":"#/definitions/CmTmLocOwnBranchDTO"
            }
        }
    }
}

Nested Schema : CmTmLocCorrBankDTO

Type: array

CmTmLocCorrBank DTO

Show Source

• Array of: object CmTmLocCorrBankDTO
  CmTmLocCorrBank DTO

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

Nested Schema : CmTmLocOsNwBankDTO

Type: array

CmTmLocOsNwBank DTO

Show Source

• Array of: object CmTmLocOsNwBankDTO
  CmTmLocOsNwBank DTO

{
    "type":"array",
    "description":"CmTmLocOsNwBank DTO",
    "items":{
        "$ref":"#/definitions/CmTmLocOsNwBankDTO"
    }
}

Nested Schema : CmTmLocOwnBranchDTO

Type: array

CmTmLocOwnBranch DTO

Show Source

• Array of: object CmTmLocOwnBranchDTO
  CmTmLocOwnBranch DTO

{
    "type":"array",
    "description":"CmTmLocOwnBranch DTO",
    "items":{
        "$ref":"#/definitions/CmTmLocOwnBranchDTO"
    }
}

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"
        }
    }
}

Nested Schema : CmTmLocOsNwBankDTO

Type: object

CmTmLocOsNwBank 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":"CmTmLocOsNwBank 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"
        }
    }
}

Nested Schema : CmTmLocOwnBranchDTO

Type: object

CmTmLocOwnBranch DTO

Show Source

• 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":"CmTmLocOwnBranch DTO",
    "type":"object",
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Branch Code"
        },
        "branchDescription":{
            "type":"string",
            "description":"Branch Description"
        },
        "priority":{
            "type":"number",
            "description":"Priority"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "locationCode":{
            "type":"string",
            "description":"Location Code"
        },
        "locationMasterId":{
            "type":"string",
            "description":"Location Master ID"
        }
    }
}

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