Jump to

• Request
• Response

Operation to ModifyOBTRAddressCode

post

/OBTRAddressCodeService/OBTRAddressCode/ModifyOBTRAddressCode

This operation modifies the OBTR Address code.

Request

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

Body ()

Root Schema : AddressCodeDto

Type: object

Show Source

• addressCode(required): string
  Indicates AddressCode
• addressLine1: string
  Indicates AddressLine1
• addressLine2: string
  Indicates AddressLine2
• addressLine3: string
  Indicates AddressLine3
• addressLine4: string
  Indicates AddressLine4
• authstat: string
  Indicates Authstat
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• country: string
  Indicates Country
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• pinCode: string
  Indicates PinCode
• txnstat: string
  Indicates Txnstat

{
    "type":"object",
    "required":[
        "addressCode"
    ],
    "properties":{
        "addressLine2":{
            "type":"string",
            "description":"Indicates AddressLine2"
        },
        "addressLine4":{
            "type":"string",
            "description":"Indicates AddressLine4"
        },
        "addressLine1":{
            "type":"string",
            "description":"Indicates AddressLine1"
        },
        "addressCode":{
            "type":"string",
            "description":"Indicates AddressCode"
        },
        "addressLine3":{
            "type":"string",
            "description":"Indicates AddressLine3"
        },
        "pinCode":{
            "type":"string",
            "description":"Indicates PinCode"
        },
        "country":{
            "type":"string",
            "description":"Indicates Country"
        },
        "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

ModifyOBTRAddressCode Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse
• Stcrpactdue-Full: object StcrpactdueDto

{
    "type":"object",
    "properties":{
        "Stcrpactdue-Full":{
            "$ref":"#/definitions/StcrpactdueDto"
        },
        "FCUBS_ERROR_RESP":{
            "$ref":"#/definitions/FCUBSErrorResponse"
        },
        "FCUBS_WARNING_RESP":{
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

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 : StcrpactdueDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• bonusencashed: number
  Indicates Bonus Encashed
• branchCode(required): string
  Indicates Branch Code
• branchDesc: string
  Indicates Branch Description
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• eventDate: string
  Indicates Event Date
• initialbonusdue: number
  Indicates Initial Bonus Due
• locdesc: string
  Indicates Location Description
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• portfolioDescription: string
  Indicates Portfolio Description
• portfolioId: string
  Indicates Portfolio Id
• recordDate: string
  Indicates Record Date
• referenceNo(required): string
  Indicates Reference No
• seAdjBonusEncash: number
  Indicates Adjusted Bonus Encashed
• securityDescription: string
  Indicates Security Description
• securityId: string
  Indicates Security Id
• seInternalActionId(required): string
  Indicates Corporate Action Id
• seReltdIntactid: string
  Indicates Related Corporate Action ID
• seResidBonusDue: number
  Indicates Residual Bonus
• seResultantSecurityId: string
  Indicates Resultant Security ID
• seSecqty: number
  Indicates Security Quantity
• skAccount(required): string
  Indicates Safe Keeping Account
• skLocation(required): string
  Indicates Safe Keeping Location
• txnstat: string
  Indicates Txnstat

{
    "type":"object",
    "required":[
        "branchCode",
        "referenceNo",
        "seInternalActionId",
        "skAccount",
        "skLocation"
    ],
    "properties":{
        "seAdjBonusEncash":{
            "type":"number",
            "description":"Indicates Adjusted Bonus Encashed"
        },
        "branchCode":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "seInternalActionId":{
            "type":"string",
            "description":"Indicates Corporate Action Id"
        },
        "referenceNo":{
            "type":"string",
            "description":"Indicates Reference No"
        },
        "skLocation":{
            "type":"string",
            "description":"Indicates Safe Keeping Location"
        },
        "skAccount":{
            "type":"string",
            "description":"Indicates Safe Keeping Account"
        },
        "securityId":{
            "type":"string",
            "description":"Indicates Security Id"
        },
        "portfolioId":{
            "type":"string",
            "description":"Indicates Portfolio Id"
        },
        "eventDate":{
            "type":"string",
            "description":"Indicates Event Date"
        },
        "seSecqty":{
            "type":"number",
            "description":"Indicates Security Quantity"
        },
        "initialbonusdue":{
            "type":"number",
            "description":"Indicates Initial Bonus Due"
        },
        "seResidBonusDue":{
            "type":"number",
            "description":"Indicates Residual Bonus"
        },
        "bonusencashed":{
            "type":"number",
            "description":"Indicates Bonus Encashed"
        },
        "seReltdIntactid":{
            "type":"string",
            "description":"Indicates Related Corporate Action ID"
        },
        "recordDate":{
            "type":"string",
            "description":"Indicates Record Date"
        },
        "securityDescription":{
            "type":"string",
            "description":"Indicates Security Description"
        },
        "portfolioDescription":{
            "type":"string",
            "description":"Indicates Portfolio Description"
        },
        "locdesc":{
            "type":"string",
            "description":"Indicates Location Description"
        },
        "seResultantSecurityId":{
            "type":"string",
            "description":"Indicates Resultant Security ID"
        },
        "branchDesc":{
            "type":"string",
            "description":"Indicates Branch Description"
        },
        "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"
        }
    }
}

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