Jump to

• Request
• Response

Operation to CreateCLASS

post

/OLProductEventClassService/OLProductEventClass/CreateCLASS

Request

Header Parameters

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

Body ()

Root Schema : OltmClassDto

Type: object

Show Source

• accountFlag: string
  Indicates AccountFlag
• advice: string
  Indicates Advice
• authstat: string
  Indicates Authstat
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• deBtnfields: string
  Indicates DeBtnfields
• deClassCode(required): string
  Indicates DeClassCode
• deClassDesc: string
  Indicates DeClassDesc
• fieldsList: array fieldsList
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• md: string
  Indicates Md
• modno: number
  Indicates Modno
• module(required): string
  Indicates Module
• oltmEventClassList: array oltmEventClassList
• onceauth: string
  Indicates Onceauth
• txnstat: string
  Indicates Txnstat

{
    "type":"object",
    "required":[
        "deClassCode",
        "module"
    ],
    "properties":{
        "deClassCode":{
            "type":"string",
            "description":"Indicates DeClassCode"
        },
        "deClassDesc":{
            "type":"string",
            "description":"Indicates DeClassDesc"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "md":{
            "type":"string",
            "description":"Indicates Md"
        },
        "accountFlag":{
            "type":"string",
            "description":"Indicates AccountFlag"
        },
        "deBtnfields":{
            "type":"string",
            "description":"Indicates DeBtnfields"
        },
        "advice":{
            "type":"string",
            "description":"Indicates Advice"
        },
        "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"
        },
        "oltmEventClassList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltmEventClassDto"
            }
        },
        "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 : oltmEventClassList

Type: array

Show Source

• Array of: object OltmEventClassDto

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

Nested Schema : UdfFieldsDto

Type: object

Show Source

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

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

Nested Schema : OltmEventClassDto

Type: object

Show Source

• classcode: string
  Indicates Classcode
• deEvntdesc: string
  Indicates DeEvntdesc
• eventcode(required): string
  Indicates Eventcode
• module: string
  Indicates Module
• oltmEventAcctEntryClassList: array oltmEventAcctEntryClassList
• oltmEventAdviceClassList: array oltmEventAdviceClassList

{
    "type":"object",
    "required":[
        "eventcode"
    ],
    "properties":{
        "classcode":{
            "type":"string",
            "description":"Indicates Classcode"
        },
        "eventcode":{
            "type":"string",
            "description":"Indicates Eventcode"
        },
        "deEvntdesc":{
            "type":"string",
            "description":"Indicates DeEvntdesc"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "oltmEventAcctEntryClassList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltmEventAcctEntryClassDto"
            }
        },
        "oltmEventAdviceClassList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/OltmEventAdviceClassDto"
            }
        }
    }
}

Nested Schema : oltmEventAcctEntryClassList

Type: array

Show Source

• Array of: object OltmEventAcctEntryClassDto

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

Nested Schema : oltmEventAdviceClassList

Type: array

Show Source

• Array of: object OltmEventAdviceClassDto

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

Nested Schema : OltmEventAcctEntryClassDto

Type: object

Show Source

• aclsorprd(required): string
  Indicates Aclsorprd
• amounttag(required): string
  Indicates Amounttag
• autdeptrncd(required): string
  Indicates Autdeptrncd
• classcd: string
  Indicates Classcd
• deMisHead: string
  Indicates DeMisHead
• drcr: string
  Allowed Values: [ "D", "C" ]

  Indicates Drcr
• eventcd: string
  Indicates Eventcd
• module: string
  Indicates Module
• netind(required): string
  Allowed Values: [ "Y", "N" ]

  Indicates Netind
• roletype: string
  Indicates Roletype
• tagtype: string
  Indicates Tagtype

{
    "type":"object",
    "required":[
        "aclsorprd",
        "amounttag",
        "autdeptrncd",
        "netind"
    ],
    "properties":{
        "drcr":{
            "type":"string",
            "description":"Indicates Drcr",
            "enum":[
                "D",
                "C"
            ]
        },
        "autdeptrncd":{
            "type":"string",
            "description":"Indicates Autdeptrncd"
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "amounttag":{
            "type":"string",
            "description":"Indicates Amounttag"
        },
        "aclsorprd":{
            "type":"string",
            "description":"Indicates Aclsorprd"
        },
        "deMisHead":{
            "type":"string",
            "description":"Indicates DeMisHead"
        },
        "netind":{
            "type":"string",
            "description":"Indicates Netind",
            "enum":[
                "Y",
                "N"
            ]
        },
        "roletype":{
            "type":"string",
            "description":"Indicates Roletype"
        },
        "tagtype":{
            "type":"string",
            "description":"Indicates Tagtype"
        },
        "eventcd":{
            "type":"string",
            "description":"Indicates Eventcd"
        },
        "classcd":{
            "type":"string",
            "description":"Indicates Classcd"
        }
    }
}

Nested Schema : OltmEventAdviceClassDto

Type: object

Show Source

• advname(required): string
  Indicates Advname
• classCode: string
  Indicates ClassCode
• eventCode: string
  Indicates EventCode
• generationtime(required): string
  Allowed Values: [ "A", "U" ]

  Indicates Generationtime
• module: string
  Indicates Module
• priority(required): number
  Indicates Priority
• suppress(required): string
  Allowed Values: [ "N", "Y" ]

  Indicates Suppress

{
    "type":"object",
    "required":[
        "advname",
        "generationtime",
        "priority",
        "suppress"
    ],
    "properties":{
        "classCode":{
            "type":"string",
            "description":"Indicates ClassCode"
        },
        "eventCode":{
            "type":"string",
            "description":"Indicates EventCode"
        },
        "generationtime":{
            "type":"string",
            "description":"Indicates Generationtime",
            "enum":[
                "A",
                "U"
            ]
        },
        "priority":{
            "type":"number",
            "description":"Indicates Priority"
        },
        "suppress":{
            "type":"string",
            "description":"Indicates Suppress",
            "enum":[
                "N",
                "Y"
            ]
        },
        "module":{
            "type":"string",
            "description":"Indicates Module"
        },
        "advname":{
            "type":"string",
            "description":"Indicates Advname"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

CreateCLASS Successfully Performed

Body ()

Root Schema : RESTResponseSuccess

Type: object

Show Source

• fcubsWarningResp: object FCUBSWarnResponse
• margincomponent: object MarginComponentDto

{
    "type":"object",
    "properties":{
        "margincomponent":{
            "description":"Indicates margincomponent",
            "$ref":"#/definitions/MarginComponentDto"
        },
        "fcubsWarningResp":{
            "description":"Indicates fcubsWarningResp",
            "$ref":"#/definitions/FCUBSWarnResponse"
        }
    }
}

Nested Schema : FCUBSWarnResponse

Type: object

Show Source

• warning: array warning
  Indicates Warning

{
    "type":"object",
    "properties":{
        "warning":{
            "type":"array",
            "description":"Indicates Warning",
            "items":{
                "$ref":"#/definitions/FCUBSWarn"
            }
        }
    }
}

Nested Schema : MarginComponentDto

Type: object

Show Source

• amountType: string
  Indicates AmountType
• authstat: string
  Indicates Authstat
• bookDate: string
  Indicates BookDate
• branchCode: string
  Indicates BranchCode
• calculate: string
  Indicates Calculate
• checker: string
  Indicates Checker
• checkerstamp: string
  Indicates Checkerstamp
• component(required): string
  Indicates Component
• componentDesc: string
  Indicates ComponentDesc
• componentType: string
  Indicates ComponentType
• contractRefNo(required): string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• customerName: string
  Indicates CustomerName
• customerNo(required): string
  Indicates CustomerNo
• facilityName: string
  Indicates FacilityName
• facilityRefNo: string
  Indicates FacilityRefNo
• maker: string
  Indicates Maker
• makerstamp: string
  Indicates Makerstamp
• marginCcyList: array marginCcyList
• modno: number
  Indicates Modno
• onceauth: string
  Indicates Onceauth
• prdtypeDesc: string
  Indicates PrdtypeDesc
• product: string
  Indicates Product
• productDesc: string
  Indicates ProductDesc
• productType: string
  Indicates ProductType
• purposeOfSyndication: string
  Indicates PurposeOfSyndication
• txnstat: string
  Indicates Txnstat
• userRefNo: string
  Indicates UserRefNo
• valueDate: string
  Indicates ValueDate

{
    "type":"object",
    "required":[
        "component",
        "contractRefNo",
        "customerNo"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "componentType":{
            "type":"string",
            "description":"Indicates ComponentType"
        },
        "amountType":{
            "type":"string",
            "description":"Indicates AmountType"
        },
        "userRefNo":{
            "type":"string",
            "description":"Indicates UserRefNo"
        },
        "customerName":{
            "type":"string",
            "description":"Indicates CustomerName"
        },
        "facilityRefNo":{
            "type":"string",
            "description":"Indicates FacilityRefNo"
        },
        "componentDesc":{
            "type":"string",
            "description":"Indicates ComponentDesc"
        },
        "bookDate":{
            "type":"string",
            "description":"Indicates BookDate"
        },
        "valueDate":{
            "type":"string",
            "description":"Indicates ValueDate"
        },
        "product":{
            "type":"string",
            "description":"Indicates Product"
        },
        "productDesc":{
            "type":"string",
            "description":"Indicates ProductDesc"
        },
        "facilityName":{
            "type":"string",
            "description":"Indicates FacilityName"
        },
        "productType":{
            "type":"string",
            "description":"Indicates ProductType"
        },
        "prdtypeDesc":{
            "type":"string",
            "description":"Indicates PrdtypeDesc"
        },
        "purposeOfSyndication":{
            "type":"string",
            "description":"Indicates PurposeOfSyndication"
        },
        "calculate":{
            "type":"string",
            "description":"Indicates Calculate"
        },
        "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"
        },
        "marginCcyList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MarginCcyDto"
            }
        }
    }
}

Nested Schema : warning

Type: array

Indicates Warning

Show Source

• Array of: object FCUBSWarn

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

Nested Schema : FCUBSWarn

Type: object

Show Source

• wcode: string
  Indicates Warning Code
• wdesc: string
  Indicates Warning Description

{
    "type":"object",
    "properties":{
        "wcode":{
            "type":"string",
            "description":"Indicates Warning Code"
        },
        "wdesc":{
            "type":"string",
            "description":"Indicates Warning Description"
        }
    }
}

Nested Schema : marginCcyList

Type: array

Show Source

• Array of: object MarginCcyDto

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

Nested Schema : MarginCcyDto

Type: object

Show Source

• branchCode: string
  Indicates BranchCode
• component: string
  Indicates Component
• contractRefNo: string
  Indicates ContractRefNo
• currency(required): string
  Indicates Currency
• currencyDesc: string
  Indicates CurrencyDesc
• customerNo: string
  Indicates CustomerNo
• marginEffdateList: array marginEffdateList

{
    "type":"object",
    "required":[
        "currency"
    ],
    "properties":{
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "currencyDesc":{
            "type":"string",
            "description":"Indicates CurrencyDesc"
        },
        "marginEffdateList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MarginEffdateDto"
            }
        }
    }
}

Nested Schema : marginEffdateList

Type: array

Show Source

• Array of: object MarginEffdateDto

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

Nested Schema : MarginEffdateDto

Type: object

Show Source

• branchCode: string
  Indicates BranchCode
• component: string
  Indicates Component
• contractRefNo: string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• customerNo: string
  Indicates CustomerNo
• effectiveDate(required): string
  Indicates EffectiveDate
• lastChangeTimestamp: string
  Indicates LastChangeTimestamp
• marginRateList: array marginRateList
• recalcReqd: string
  Indicates RecalcReqd

{
    "type":"object",
    "required":[
        "effectiveDate"
    ],
    "properties":{
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "lastChangeTimestamp":{
            "type":"string",
            "description":"Indicates LastChangeTimestamp"
        },
        "recalcReqd":{
            "type":"string",
            "description":"Indicates RecalcReqd"
        },
        "effectiveDate":{
            "type":"string",
            "description":"Indicates EffectiveDate"
        },
        "marginRateList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MarginRateDto"
            }
        }
    }
}

Nested Schema : marginRateList

Type: array

Show Source

• Array of: object MarginRateDto

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

Nested Schema : MarginRateDto

Type: object

Show Source

• branchCode: string
  Indicates BranchCode
• component: string
  Indicates Component
• contractRefNo: string
  Indicates ContractRefNo
• currency: string
  Indicates Currency
• customerNo: string
  Indicates CustomerNo
• effectiveDate: string
  Indicates EffectiveDate
• fromBasisAmt: number
  Indicates FromBasisAmt
• margin: number
  Indicates Margin
• marginRate(required): number
  Indicates MarginRate
• marginRecordStatus: string
  Indicates MarginRecordStatus
• participantMarginList: array participantMarginList
• seqNo: number
  Indicates SeqNo
• toBasisAmt: number
  Indicates ToBasisAmt
• totalRate: number
  Indicates TotalRate

{
    "type":"object",
    "required":[
        "marginRate"
    ],
    "properties":{
        "margin":{
            "type":"number",
            "description":"Indicates Margin"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "effectiveDate":{
            "type":"string",
            "description":"Indicates EffectiveDate"
        },
        "customerNo":{
            "type":"string",
            "description":"Indicates CustomerNo"
        },
        "marginRate":{
            "type":"number",
            "description":"Indicates MarginRate"
        },
        "fromBasisAmt":{
            "type":"number",
            "description":"Indicates FromBasisAmt"
        },
        "contractRefNo":{
            "type":"string",
            "description":"Indicates ContractRefNo"
        },
        "toBasisAmt":{
            "type":"number",
            "description":"Indicates ToBasisAmt"
        },
        "branchCode":{
            "type":"string",
            "description":"Indicates BranchCode"
        },
        "seqNo":{
            "type":"number",
            "description":"Indicates SeqNo"
        },
        "marginRecordStatus":{
            "type":"string",
            "description":"Indicates MarginRecordStatus"
        },
        "currency":{
            "type":"string",
            "description":"Indicates Currency"
        },
        "totalRate":{
            "type":"number",
            "description":"Indicates TotalRate"
        },
        "participantMarginList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ParticipantMarginDto"
            }
        }
    }
}

Nested Schema : participantMarginList

Type: array

Show Source

• Array of: object ParticipantMarginDto

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

Nested Schema : ParticipantMarginDto

Type: object

Show Source

• assetRatio: number
  Indicates AssetRatio
• brncode: string
  Indicates Brncode
• ccy: string
  Indicates Ccy
• component: string
  Indicates Component
• contactrefnum: string
  Indicates Contactrefnum
• customer: string
  Indicates Customer
• effectdate: string
  Indicates Effectdate
• frmbasisamt: number
  Indicates Frmbasisamt
• margin: number
  Indicates Margin
• marginrat: number
  Indicates Marginrat
• participant: string
  Indicates Participant
• partName: string
  Indicates PartName
• tobasisamt: number
  Indicates Tobasisamt
• totalRate: number
  Indicates TotalRate

{
    "type":"object",
    "properties":{
        "brncode":{
            "type":"string",
            "description":"Indicates Brncode"
        },
        "ccy":{
            "type":"string",
            "description":"Indicates Ccy"
        },
        "component":{
            "type":"string",
            "description":"Indicates Component"
        },
        "contactrefnum":{
            "type":"string",
            "description":"Indicates Contactrefnum"
        },
        "customer":{
            "type":"string",
            "description":"Indicates Customer"
        },
        "effectdate":{
            "type":"string",
            "description":"Indicates Effectdate"
        },
        "frmbasisamt":{
            "type":"number",
            "description":"Indicates Frmbasisamt"
        },
        "margin":{
            "type":"number",
            "description":"Indicates Margin"
        },
        "marginrat":{
            "type":"number",
            "description":"Indicates Marginrat"
        },
        "participant":{
            "type":"string",
            "description":"Indicates Participant"
        },
        "tobasisamt":{
            "type":"number",
            "description":"Indicates Tobasisamt"
        },
        "partName":{
            "type":"string",
            "description":"Indicates PartName"
        },
        "assetRatio":{
            "type":"number",
            "description":"Indicates AssetRatio"
        },
        "totalRate":{
            "type":"number",
            "description":"Indicates TotalRate"
        }
    }
}

400 Response

Failed while processing request

Body ()

Root Schema : RESTResponseFailure

Type: object

Show Source

• fcubsErrorResp: object FCUBSErrorResponse

{
    "type":"object",
    "properties":{
        "fcubsErrorResp":{
            "description":"Indicates fcubsErrorResp",
            "$ref":"#/definitions/FCUBSErrorResponse"
        }
    }
}

Nested Schema : FCUBSErrorResponse

Type: object

Show Source

• error: array error
  Indicates Errors

{
    "type":"object",
    "properties":{
        "error":{
            "type":"array",
            "description":"Indicates Errors",
            "items":{
                "$ref":"#/definitions/FCUBSError"
            }
        }
    }
}

Nested Schema : error

Type: array

Indicates Errors

Show Source

• Array of: object FCUBSError

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

Nested Schema : FCUBSError

Type: object

Show Source

• ecode: string
  Indicates Error Code
• edesc: string
  Indicates Error Description

{
    "type":"object",
    "properties":{
        "ecode":{
            "type":"string",
            "description":"Indicates Error Code"
        },
        "edesc":{
            "type":"string",
            "description":"Indicates Error Description"
        }
    }
}

401 Response

User Not Authorized

405 Response

Method Not Allowed

500 Response

Internal Server Error

Back to Top