Retrieve the Netting Structure
get
/service/v1/getStructureTree
This service is used to retrieve the Netting Structure for a party Id based on given set of parameters.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
authRecord: boolean
Auth record if true and unauth record if falseDefault Value:
true -
currentNodeIdentifier: string
Node whose children are requested
-
depth(required): integer
Depth for which record is needed
-
limit: integer
LimitDefault Value:
0 -
offset: integer
OffsetDefault Value:
0 -
partyId(required): string
Party Id who has logged in
-
recordStat: string
Record type of the structure
-
structureCode(required): string
Structure Code for which the request is made
Header Parameters
-
appId(required): string
Source Application Id
-
branchCode(required): string
Branch Code
-
userId(required): string
Source User id
Response
Supported Media Types
- application/json
- application/xml
200 Response
Successfully performs the operation
Root Schema : StructureTreeResponse
Type:
objectStructureTreeResponse
Show Source
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
-
loginEntityType:
string
Login Entity Type
-
status:
string
Default Value:
SUCCESSStatus - SUCCESS OR FAILED -
structureDetails:
object ObcmTmStructureMasterServiceModel
ObcmTmStructureMasterServiceModel
-
totalRecords:
integer
Total Number Of Nodes Fetched
Nested Schema : ObcmTmStructureMasterServiceModel
Type:
objectObcmTmStructureMasterServiceModel
Show Source
-
approverRemarks:
string
approver remarks
-
authStatus:
string
auth status flag
-
checkerDateStamp:
string
checker date stamp
-
checkerId:
string
check id
-
doerRemarks:
string
doer remarks
-
makerDateStamp:
string
make date stamp
-
makerId:
string
maker id
-
modNo:
integer
mod no
-
obcmTmStructureEnrichParamDetails:
array obcmTmStructureEnrichParamDetails
-
obcmTmStructureMaster:
object ObcmTmStructureMasterModel
-
obcmTmStructureNode:
array obcmTmStructureNode
-
onceAuth:
string
once auth flag
-
operationType:
string
operation type
-
recordStatus:
string
record status flag
-
resourceId:
string
resource id
-
resourceName:
string
resource name
Nested Schema : obcmTmStructureEnrichParamDetails
Type:
Show Source
array-
Array of:
object ObcmTmStructureEnrichParamDetailsModel
ObcmTmStructureEnrichParamDetails model
Nested Schema : ObcmTmStructureMasterModel
Type:
Show Source
object-
action:
string
action
-
autoAuth:
string
auth status
-
checkerRemarks:
string
checker remarks
-
createdDate:
string
Created Date
-
datasegmentCode:
string
data segment code
-
dayOfTheMonth:
string
-
dayOfTheWeek:
string
-
frequency:
string
-
globalCentreId:
string
-
globalCentreName:
string
-
holidayTreatment:
string
-
id:
string
Id
-
lastUpdatedTimestamp:
string
Last Updated Timestamp
-
makerRemarks:
string
maker remarks
-
modificationStatus:
string
modification status
-
nettingCycle:
integer
-
payInMode:
string
PayIn Mode
-
payoutDays:
integer
Pattern:
[^*%]{0,50} -
payOutMode:
string
PayOut Mode
-
previousCycle:
integer
-
previousCycleType:
string
-
settlementDays:
integer
Pattern:
[^*%]{0,50} -
structureCode:
string
Pattern:
[^*%]{0,50}Structure Code -
structureDescription:
string
Pattern:
[^*%]{0,50}Structure Description -
structureEndDate:
string
Structure End Date
-
structureStartDate:
string
Structure Start Date
Match All
Show Source
Nested Schema : obcmTmStructureNode
Type:
Show Source
array-
Array of:
object ObcmTmStructureNodeModel
ObcmTmStructureNode model
Nested Schema : ObcmTmStructureEnrichParamDetailsModel
Type:
objectObcmTmStructureEnrichParamDetails model
Show Source
-
actionOnNode:
string
Action Performed On Node
-
allowOverduePay:
string
allowOverduePay
-
allowOverdueRcv:
string
allowOverdueRcv
-
autoAcceptancePay:
string
autoAcceptancePay
-
autoAcceptanceRcv:
string
autoAcceptanceRcv
-
autoApproval:
string
autoApproval
-
autoDrApplicablePay:
string
autoDrApplicablePay
-
autoDrApplicableRcv:
string
autoDrApplicableRcv
-
autoDrPayin:
string
autoDrPayin
-
autoDrPayout:
string
autoDrPayout
-
depth:
number
Depth of the node
-
enrichParamMasterId:
string
Enrich Param master Id
-
entityRole:
string
entityRole
-
entityType:
string
entityType
-
existingRelationFlag:
string
existingRelationFlag
-
expiresOn:
string
expiresOn
-
globalCentreId:
string
globalCentreId
-
holidayTreatmentPay:
string
holidayTreatmentPay
-
holidayTreatmentRcv:
string
holidayTreatmentRcv
-
id:
string
Id of the ObcmTmStructureEnrichParamDetails
-
isExistingCounterparty:
string
Is Existing Counterparty
-
isFlipped:
string
Is Flipped Node
-
isNonAcceptedPayChild:
string
Is Non Accepted Payable Child
-
isNonAcceptedRcvChild:
string
Is Non Accepted Receivable Child
-
isNonAcceptedReceivable:
string
isNonAcceptedReceivable
-
isPastDuePayChild:
string
Is Past Due Payable Child
-
isPastDueRcvChild:
string
Is Past Due Receivable Child
-
isPastDueReceivable:
string
isPastDueReceivable
-
maxDaysOverduePay:
integer
maxDaysOverduePay
-
maxDaysOverdueRcv:
integer
maxDaysOverdueRcv
-
nodeAction:
string
Node Action- CREATE or Null
-
nodeIdentifier:
string
Node Identifier
-
nodeUniqueId:
string
Node Unique Id
-
noOfDays:
integer
No Of Days
-
noOfDaysPay:
integer
noOfDaysPay
-
noOfDaysPayChild:
integer
No Of Days Payable Child
-
noOfDaysRcv:
integer
noOfDaysRcv
-
noOfDaysRcvChild:
integer
No Of Days Receivable Child
-
parentId:
string
parent Id
-
parentName:
string
parent Name
-
parentNodeIdentifier:
string
Parent Node Identifier
-
participationFlag:
string
participationFlag
-
payInMode:
string
PayIn Mode
-
payOutMode:
string
PayOut Mode
-
previousEntityRole:
string
Previous Entity Role of the Subsidiary
-
relationshipCode:
string
relationshipCode
-
relationshipModNo:
integer
relationshipModNo
-
relationshipName:
string
relationshipName
-
relationshipOwnerId:
string
Relationship Owner Id
-
relationshipOwnerName:
string
Relationship Owner Name
-
settlementCcy:
string
settlementCcy
-
status:
string
status
-
structureCode:
string
Structure Code
-
structureDescription:
string
Structure Description
-
subCentreId:
string
subCentreId
-
subsidiaryId:
string
subsidiaryId
-
subsidiaryName:
string
subsidiaryName
-
validateLinkedPoPay:
string
validateLinkedPoPay
-
validateLinkedPoRcv:
string
validateLinkedPoRcv
Nested Schema : GenericDto-allOf[0]
Type:
objectNested Schema : ObcmTmStructureMasterModel-allOf[1]
Type:
objectNested Schema : ObcmTmStructureNodeModel
Type:
objectObcmTmStructureNode model
Show Source
-
actionOnNode:
string
Action Performed On Node
-
childCount:
number
Child Count
-
depth:
number
Depth of the node
-
entityRole:
string
entityRole
-
entityType:
string
entityType
-
globalCentreId:
string
globalCentreId
-
globalCentreName:
string
globalCentreName
-
id:
string
Id of the ObcmTmStructureNode
-
isFlipped:
string
Is Flipped Node
-
linkageMasterId:
string
Linkage Master Id
-
nodeAction:
string
Node Action- CREATE or Null
-
nodeIdentifier:
string
Node Identifier
-
nodeUniqueId:
string
Node Unique Id
-
parentId:
string
parent Id
-
parentName:
string
parent Name
-
parentNodeIdentifier:
string
Parent Node Identifier
-
parentNodeSequence:
number
Parent Node Sequence
-
previousEntityRole:
string
Previous Entity Role of the Subsidiary
-
settlementCcy:
string
settlementCcy
-
structureCode:
string
Structure Code
-
structureDescription:
string
Structure Description
-
subCentreId:
string
subCentreId
-
subCentreName:
string
subCentreName
-
subsidiaryId:
string
subsidiaryId
-
subsidiaryName:
string
subsidiaryName
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
500 Response
Internal error