Rest API for Oracle Banking Cash Management

Retrieve all the netting structures

get

/service/v1/getStructureList

This API is used to retrieves all the netting structures for a party Id.

Request

Supported Media Types

application/json
application/xml

Query Parameters

authRecord: boolean

Auth record if true and unauth record if false

Default Value: true
frequency: string

Frequency
fromStructureEndDate: string

From Structure End Date
fromStructureStartDate: string

From Structure Start Date
globalCentreId: string

GlobalNettingCenter Id
globalCentreName: string

GlobalNettingCenter Name
limit: integer

Limit

Default Value: 0
nettingCycle: integer

Netting Cycle
offset: integer

Offset

Default Value: 0
partyId(required): string

Party Id who has logged in
recordStat: string

Record type of the structure
structureCode: string

Structure Code
structureDescription: string

Structure Description
toStructureEndDate: string

To Structure End Date
toStructureStartDate: string

To Structure Start Date

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

Type: object

StructureListResponse

Show Source

errorCode: string

Error Code
errorDesc: string

Error Desc
paging: object PagingDto
status: string

Default Value: SUCCESS

Status - SUCCESS OR FAILED
structureDetails: array structureDetails
totalRecords: integer

Total Number Of Structures fetched for the given party Id

{
    "description":"StructureListResponse",
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"Error Code",
            "type":"string"
        },
        "errorDesc":{
            "description":"Error Desc",
            "type":"string"
        },
        "status":{
            "description":"Status - SUCCESS OR FAILED",
            "type":"string",
            "default":"SUCCESS"
        },
        "totalRecords":{
            "description":"Total Number Of Structures fetched for the given party Id",
            "type":"integer"
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "structureDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObcmTmStructureMasterListModel"
            }
        }
    }
}

Nested Schema : PagingDto

Type: object

Show Source

totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : structureDetails

Type: array

Show Source

Array of: object ObcmTmStructureMasterListModel

ObcmTmStructureMasterListModel

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

Nested Schema : ObcmTmStructureMasterListModel

Type: object

ObcmTmStructureMasterListModel

Show Source

obcmTmStructureMaster: object ObcmTmStructureMasterModel
resourceId: string

resource id
resourceName: string

resource name

{
    "description":"ObcmTmStructureMasterListModel",
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "obcmTmStructureMaster":{
            "$ref":"#/definitions/ObcmTmStructureMasterModel"
        }
    }
}

Nested Schema : ObcmTmStructureMasterModel

Type: object

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "autoAuth":{
            "type":"string",
            "description":"auth status"
        },
        "modificationStatus":{
            "type":"string",
            "description":"modification status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"data segment code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checker remarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"maker remarks"
        },
        "structureCode":{
            "type":"string",
            "description":"Structure Code",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-001"
        },
        "structureDescription":{
            "type":"string",
            "description":"Structure Description",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-002"
        },
        "structureStartDate":{
            "type":"string",
            "description":"Structure Start Date"
        },
        "structureEndDate":{
            "type":"string",
            "description":"Structure End Date"
        },
        "globalCentreId":{
            "type":"string",
            "description":""
        },
        "globalCentreName":{
            "type":"string",
            "description":""
        },
        "settlementDays":{
            "type":"integer",
            "description":"",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-006"
        },
        "payoutDays":{
            "type":"integer",
            "description":"",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-007"
        },
        "frequency":{
            "type":"string",
            "description":""
        },
        "dayOfTheWeek":{
            "type":"string",
            "description":""
        },
        "dayOfTheMonth":{
            "type":"string",
            "description":""
        },
        "holidayTreatment":{
            "type":"string",
            "description":""
        },
        "nettingCycle":{
            "type":"integer",
            "description":""
        },
        "previousCycle":{
            "type":"integer",
            "description":""
        },
        "previousCycleType":{
            "type":"string",
            "description":""
        },
        "createdDate":{
            "type":"string",
            "description":"Created Date"
        },
        "lastUpdatedTimestamp":{
            "type":"string",
            "description":"Last Updated Timestamp"
        },
        "payInMode":{
            "type":"string",
            "description":"PayIn Mode"
        },
        "payOutMode":{
            "type":"string",
            "description":"PayOut Mode"
        }
    }
}

Match All

Show Source

allOf GenericDto
object ObcmTmStructureMasterModel-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object"
        }
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"action"
        },
        "autoAuth":{
            "type":"string",
            "description":"auth status"
        },
        "modificationStatus":{
            "type":"string",
            "description":"modification status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"data segment code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checker remarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"maker remarks"
        },
        "structureCode":{
            "type":"string",
            "description":"Structure Code",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-001"
        },
        "structureDescription":{
            "type":"string",
            "description":"Structure Description",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-002"
        },
        "structureStartDate":{
            "type":"string",
            "description":"Structure Start Date"
        },
        "structureEndDate":{
            "type":"string",
            "description":"Structure End Date"
        },
        "globalCentreId":{
            "type":"string",
            "description":""
        },
        "globalCentreName":{
            "type":"string",
            "description":""
        },
        "settlementDays":{
            "type":"integer",
            "description":"",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-006"
        },
        "payoutDays":{
            "type":"integer",
            "description":"",
            "pattern":"[^*%]{0,50}",
            "x-pattern-message":"ML-CTSTR-007"
        },
        "frequency":{
            "type":"string",
            "description":""
        },
        "dayOfTheWeek":{
            "type":"string",
            "description":""
        },
        "dayOfTheMonth":{
            "type":"string",
            "description":""
        },
        "holidayTreatment":{
            "type":"string",
            "description":""
        },
        "nettingCycle":{
            "type":"integer",
            "description":""
        },
        "previousCycle":{
            "type":"integer",
            "description":""
        },
        "previousCycleType":{
            "type":"string",
            "description":""
        },
        "createdDate":{
            "type":"string",
            "description":"Created Date"
        },
        "lastUpdatedTimestamp":{
            "type":"string",
            "description":"Last Updated Timestamp"
        },
        "payInMode":{
            "type":"string",
            "description":"PayIn Mode"
        },
        "payOutMode":{
            "type":"string",
            "description":"PayOut Mode"
        }
    }
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]
Generic Response.

{
    "allOf":[
        {
            "type":"object"
        },
        {
            "description":"Generic Response.",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Nested Schema : ObcmTmStructureMasterModel-allOf[1]

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error