Jump to

• Request
• Response

Operation to SummaryQueryBranch

post

/TRBranchDetailsService/TRBranchDetails/SummaryQueryBranch

This operation summarises the branch details using the TRBranchDetails 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 : SttmTrBranchDto

Type: object

Show Source

• authstat: string
  Indicates Authstat
• backValueDays: number
  Indicates BackValueDays
• bckvalchkreqd: string
  Indicates Bckvalchkreqd
• branchCode(required): string
  Indicates BranchCode
• branchName: string
  Indicates BranchName
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• cidif: string
  Indicates Cidif
• currcycle: string
  Indicates Currcycle
• currentPeriod: string
  Indicates CurrentPeriod
• cutoffTime: number
  Indicates CutoffTime
• defbnkopcd: string
  Indicates Defbnkopcd
• description: string
  Indicates Description
• individualTaxCertReqd: string
  Indicates IndividualTaxCertReqd
• intswapcust: string
  Indicates Intswapcust
• lcyMsgPrefList: array lcyMsgPrefList
• lcyMsgType: string
  Indicates LcyMsgType
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• modno: number
  Indicates Modno
• netsuspgl: string
  Indicates Netsuspgl
• onceauth: string
  Indicates Onceauth
• parentBranch: string
  Indicates ParentBranch
• prcdPrvsAvbleRate: string
  Indicates PrcdPrvsAvbleRate
• telex: string
  Indicates Telex
• trckprevyrprls: string
  Indicates Trckprevyrprls
• txnstat: string
  Indicates Txnstat

{
    "type":"object",
    "required":[
        "branchCode"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "parentBranch":{
            "type":"string",
            "description":"Indicates ParentBranch"
        },
        "netsuspgl":{
            "type":"string",
            "description":"Indicates Netsuspgl"
        },
        "backValueDays":{
            "type":"number",
            "description":"Indicates BackValueDays"
        },
        "bckvalchkreqd":{
            "type":"string",
            "description":"Indicates Bckvalchkreqd"
        },
        "defbnkopcd":{
            "type":"string",
            "description":"Indicates Defbnkopcd"
        },
        "individualTaxCertReqd":{
            "type":"string",
            "description":"Indicates IndividualTaxCertReqd"
        },
        "intswapcust":{
            "type":"string",
            "description":"Indicates Intswapcust"
        },
        "telex":{
            "type":"string",
            "description":"Indicates Telex"
        },
        "branchName":{
            "type":"string",
            "description":"Indicates BranchName"
        },
        "cidif":{
            "type":"string",
            "description":"Indicates Cidif"
        },
        "trckprevyrprls":{
            "type":"string",
            "description":"Indicates Trckprevyrprls"
        },
        "description":{
            "type":"string",
            "description":"Indicates Description"
        },
        "lcyMsgType":{
            "type":"string",
            "description":"Indicates LcyMsgType"
        },
        "currcycle":{
            "type":"string",
            "description":"Indicates Currcycle"
        },
        "currentPeriod":{
            "type":"string",
            "description":"Indicates CurrentPeriod"
        },
        "cutoffTime":{
            "type":"number",
            "description":"Indicates CutoffTime"
        },
        "prcdPrvsAvbleRate":{
            "type":"string",
            "description":"Indicates PrcdPrvsAvbleRate"
        },
        "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"
        },
        "lcyMsgPrefList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LcyMsgPrefDto"
            }
        }
    }
}

Nested Schema : lcyMsgPrefList

Type: array

Show Source

• Array of: object LcyMsgPrefDto

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

Nested Schema : LcyMsgPrefDto

Type: object

Show Source

• branch: string
  Indicates Branch
• lcymsgtyp: string
  Allowed Values: [ "S", "M", "P" ]

  Indicates Lcymsgtyp
• module(required): string
  Indicates Module
• moduleDesc: string
  Indicates ModuleDesc

{
    "type":"object",
    "required":[
        "module"
    ],
    "properties":{
        "branch":{
            "type":"string",
            "description":"Indicates Branch"
        },
        "lcymsgtyp":{
            "type":"string",
            "description":"Indicates Lcymsgtyp",
            "enum":[
                "S",
                "M",
                "P"
            ]
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "moduleDesc":{
            "type":"string",
            "description":"Indicates ModuleDesc"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

SummaryQueryBranch 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