Jump to

• Request
• Response

Query by addressCode

get

/OBTRAddressCodeService/OBTRAddressCode/QueryOBTRAddressCode/addressCode/{addressCode}

This operation queries based on the Address code.

Request

Path Parameters

• addressCode(required): string
  addressCode

Header Parameters

• BRANCH(required): string
  Enter Transaction Branch
• ENTITY: string
  Enter Entity ID
• SOURCE(required): string
  Enter Source Code of External System
• USERID(required): string
  Enter User ID

Back to Top

Response

Supported Media Types

• application/json

200 Response

OBTRAddressCode Successfully Queried

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• branch-Parameters-Full: object FxBranchParamsDto
• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse

{
    "type":"object",
    "properties":{
        "branch-Parameters-Full":{
            "$ref":"#/definitions/FxBranchParamsDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FxBranchParamsDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• autocnfclsdeal: string
  Indicates Auto Confirm Continuous Linked Settlements Deals Y - on N - Off
• brncd(required): string
  Indicates Branch Code
• btnUdf: string
  Indicates BtnUdf
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• clsprtcpnt: string
  Indicates Continuous Linked Settlement Participant Y - on N - Off
• desc: string
  Indicates Branch Code Description
• fieldsList: array fieldsList
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• msgusrrefno: string
  Indicates User Reference in Messages Y - on N - Off
• onceauth: string
  Indicates Onceauth
• proctil: string
  Indicates Process Till S - System Date N - Next Working Day - 1
• revalatprd: string
  Indicates Revaluation At Product Y - on N - Off
• revalrevpref: string
  Indicates Revaluation Reversal A - Account Revaluation D - Deal Level
• ruledesc: string
  Indicates Settlement Member Description
• settleTrnCd: string
  Indicates SettleTrnCd
• stlmntmbr: string
  Indicates Settlement Member
• tcpyreqd: string
  Indicates T - Copy Y - on N - Off
• txnstat: string
  Indicates Txnstat
• udfDetailsList: array udfDetailsList

{
    "type":"object",
    "required":[
        "brncd"
    ],
    "properties":{
        "brncd":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "proctil":{
            "type":"string",
            "description":"Indicates Process Till\tS - System Date\tN - Next Working Day - 1"
        },
        "revalatprd":{
            "type":"string",
            "description":"Indicates Revaluation At Product\tY - on\tN - Off"
        },
        "revalrevpref":{
            "type":"string",
            "description":"Indicates Revaluation Reversal\tA - Account Revaluation\tD - Deal Level"
        },
        "clsprtcpnt":{
            "type":"string",
            "description":"Indicates Continuous Linked Settlement Participant\tY - on\tN - Off"
        },
        "stlmntmbr":{
            "type":"string",
            "description":"Indicates Settlement Member"
        },
        "tcpyreqd":{
            "type":"string",
            "description":"Indicates T - Copy\tY - on\tN - Off"
        },
        "autocnfclsdeal":{
            "type":"string",
            "description":"Indicates Auto Confirm Continuous Linked Settlements Deals\tY - on\tN - Off"
        },
        "msgusrrefno":{
            "type":"string",
            "description":"Indicates User Reference in Messages\tY - on\tN - Off"
        },
        "desc":{
            "type":"string",
            "description":"Indicates Branch Code Description"
        },
        "ruledesc":{
            "type":"string",
            "description":"Indicates Settlement Member Description"
        },
        "btnUdf":{
            "type":"string",
            "description":"Indicates BtnUdf"
        },
        "settleTrnCd":{
            "type":"string",
            "description":"Indicates SettleTrnCd"
        },
        "maker":{
            "type":"string",
            "description":"Indicates Maker"
        },
        "makerstamp":{
            "type":"string",
            "description":"Indicates Makerstamp"
        },
        "checker":{
            "type":"string",
            "description":"Indicates Checker"
        },
        "checkerstamp":{
            "type":"string",
            "description":"Indicates Checkerstamp"
        },
        "modno":{
            "type":"number",
            "description":"Indicates Modno"
        },
        "txnstat":{
            "type":"string",
            "description":"Indicates Txnstat"
        },
        "authstat":{
            "type":"string",
            "description":"Indicates Authstat"
        },
        "onceauth":{
            "type":"string",
            "description":"Indicates Onceauth"
        },
        "udfDetailsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UdfDetailsDto"
            }
        },
        "fieldsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UdfFieldsDto"
            }
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• ERROR: array ERROR

{
    "type":"object",
    "properties":{
        "ERROR":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• WARNING: array WARNING

{
    "type":"object",
    "properties":{
        "WARNING":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : fieldsList

Type: array

Show Source

• Array of: object UdfFieldsDto

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

Nested Schema : udfDetailsList

Type: array

Show Source

• Array of: object UdfDetailsDto

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

Nested Schema : UdfFieldsDto

Type: object

Show Source

• fldName: string
  Indicates UDF Field Name
• fldVal: string
  Indicates UDF Field Value

{
    "type":"object",
    "properties":{
        "fldName":{
            "type":"string",
            "description":"Indicates UDF Field Name"
        },
        "fldVal":{
            "type":"string",
            "description":"Indicates UDF Field Value"
        }
    }
}

Nested Schema : UdfDetailsDto

Type: object

Show Source

• fielddesc: string
  Indicates Fielddesc
• fldnam(required): string
  Indicates Field Name
• fldval: string
  Indicates Value
• fldvaldesc: string
  Indicates Value Description
• mandatory: string
  Indicates Mandatory

{
    "type":"object",
    "required":[
        "fldnam"
    ],
    "properties":{
        "fldnam":{
            "type":"string",
            "description":"Indicates Field Name"
        },
        "fldval":{
            "type":"string",
            "description":"Indicates Value"
        },
        "fielddesc":{
            "type":"string",
            "description":"Indicates Fielddesc"
        },
        "mandatory":{
            "type":"string",
            "description":"Indicates Mandatory"
        },
        "fldvaldesc":{
            "type":"string",
            "description":"Indicates Value Description"
        }
    }
}

Nested Schema : ERROR

Type: array

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ECODE: string
• EDESC: string

{
    "type":"object",
    "properties":{
        "ECODE":{
            "type":"string"
        },
        "EDESC":{
            "type":"string"
        }
    }
}

Nested Schema : WARNING

Type: array

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• WCODE: string
• WDESC: string

{
    "type":"object",
    "properties":{
        "WCODE":{
            "type":"string"
        },
        "WDESC":{
            "type":"string"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top