Jump to

• Request
• Response

Operation to ModifyOTBrnParam

post

/OptionBranchParameterService/OptionBranchParameter/ModifyOTBrnParam

This operation modifies the OT branch parameter using the OptionBranchParameter Service.

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

Type: object

Show Source

• authstat: string
  Indicates Authstat
• branchCode(required): string
  Indicates Branch Code
• branchName: string
  Indicates Branch Name
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• deltaAcctReqd: string
  Indicates Delta Accounting Required Y - on N - Off
• extRevalReqd: string
  Indicates ExtRevalReqd
• extRevaluationLevel: string
  Allowed Values: [ "N", "B", "P" ]

  Indicates ExtRevaluationLevel
• fields: string
  Indicates Fields
• fieldsList: array fieldsList
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• processTill: string
  Allowed Values: [ "S", "N" ]

  Indicates Process Till Next Working Day S - System Date N - Next Working Day - 1
• txnstat: string
  Indicates Txnstat
• udfDetailsList: array udfDetailsList

{
    "type":"object",
    "required":[
        "branchCode"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates Branch Code"
        },
        "processTill":{
            "type":"string",
            "description":"Indicates Process Till Next Working Day\tS - System Date\tN - Next Working Day - 1",
            "enum":[
                "S",
                "N"
            ]
        },
        "deltaAcctReqd":{
            "type":"string",
            "description":"Indicates Delta Accounting Required\tY - on\tN - Off"
        },
        "branchName":{
            "type":"string",
            "description":"Indicates Branch Name"
        },
        "fields":{
            "type":"string",
            "description":"Indicates Fields"
        },
        "extRevaluationLevel":{
            "type":"string",
            "description":"Indicates ExtRevaluationLevel",
            "enum":[
                "N",
                "B",
                "P"
            ]
        },
        "extRevalReqd":{
            "type":"string",
            "description":"Indicates ExtRevalReqd"
        },
        "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 : 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

ModifyOTBrnParam Successfully Performed

Body ()

Root Schema : RESTResponse

Type: object

Show Source

• FCUBS_ERROR_RESP: object FCUBSErrorResponse
• FCUBS_WARNING_RESP: object FCUBSWarnResponse
• Stfincle-Full: object StfincleDto

{
    "type":"object",
    "properties":{
        "Stfincle-Full":{
            "$ref":"#/definitions/StfincleDto"
        },
        "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 : StfincleDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• description: string
  Indicates Description
• fcEndDate(required): string
  Indicates End Date
• fcStartDate(required): string
  Indicates Start Date
• finCycle(required): string
  Indicates Financial Cycle
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• stprdcdsList: array stprdcdsList
• txnstat: string
  Indicates Txnstat
• udf: string
  Indicates Udf

{
    "type":"object",
    "required":[
        "fcEndDate",
        "fcStartDate",
        "finCycle"
    ],
    "properties":{
        "finCycle":{
            "type":"string",
            "description":"Indicates Financial Cycle"
        },
        "fcStartDate":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "description":{
            "type":"string",
            "description":"Indicates Description"
        },
        "fcEndDate":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "udf":{
            "type":"string",
            "description":"Indicates Udf"
        },
        "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"
        },
        "stprdcdsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StprdcdsDto"
            }
        }
    }
}

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

Nested Schema : stprdcdsList

Type: array

Show Source

• Array of: object StprdcdsDto

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

Nested Schema : StprdcdsDto

Type: object

Show Source

• fcEndDate(required): string
  Indicates End Date
• fcStartDate: string
  Indicates Start Date
• finCycle: string
  Indicates FinCycle
• periodCode(required): string
  Indicates Period Code

{
    "type":"object",
    "required":[
        "fcEndDate",
        "periodCode"
    ],
    "properties":{
        "periodCode":{
            "type":"string",
            "description":"Indicates Period Code"
        },
        "fcStartDate":{
            "type":"string",
            "description":"Indicates Start Date"
        },
        "fcEndDate":{
            "type":"string",
            "description":"Indicates End Date"
        },
        "finCycle":{
            "type":"string",
            "description":"Indicates FinCycle"
        }
    }
}

400 Response

Failed while processing request

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top