Rest API for Oracle Banking Cash Management

Add a new relationshipmaster

post

/service/v1/relationshipRecords

This API adds a new relationship master.

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

appId
branchCode(required): string

branchCode
userId(required): string

userId

Request Body that contains data required for creating a new relationshipmaster

Root Schema : RelationshipmasterWebModelCollection

Type: object

Collection of datasegment.

Show Source

data: array data

{
    "description":"Collection of datasegment.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RelationshipmasterWebModel"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object RelationshipmasterWebModel

RelationshipmasterAggregateModel

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

Nested Schema : RelationshipmasterWebModel

Type: object

RelationshipmasterAggregateModel

Show Source

approverRemarks: string

approver remarks
authStatus: string

auth status flag
checkerDateStamp: string(date-time)

checker date stamp
checkerId: string

check id
doerRemarks: string

doer remarks
extendedDatasegments: array extendedDatasegments

data for the extended datasegment operation
makerDateStamp: string(date-time)

make date stamp
makerId: string

maker id
modNo: integer

mod no
obcmTmRelationshipMaster: object ObcmTmRelationshipMasterDTO
onceAuth: string

once auth flag
operationType: string

operation type
recordStatus: string

record status flag
resourceId: string

resource id
resourceName: string

resource name

{
    "description":"RelationshipmasterAggregateModel",
    "type":"object",
    "properties":{
        "resourceId":{
            "description":"resource id",
            "type":"string"
        },
        "resourceName":{
            "description":"resource name",
            "type":"string"
        },
        "operationType":{
            "description":"operation type",
            "type":"string"
        },
        "makerId":{
            "description":"maker id",
            "type":"string"
        },
        "makerDateStamp":{
            "description":"make date stamp",
            "type":"string",
            "format":"date-time"
        },
        "checkerId":{
            "description":"check id",
            "type":"string"
        },
        "checkerDateStamp":{
            "description":"checker date stamp",
            "type":"string",
            "format":"date-time"
        },
        "modNo":{
            "description":"mod no",
            "type":"integer"
        },
        "recordStatus":{
            "description":"record status flag",
            "type":"string"
        },
        "authStatus":{
            "description":"auth status flag",
            "type":"string"
        },
        "onceAuth":{
            "description":"once auth flag",
            "type":"string"
        },
        "doerRemarks":{
            "description":"doer remarks",
            "type":"string"
        },
        "approverRemarks":{
            "description":"approver  remarks",
            "type":"string"
        },
        "obcmTmRelationshipMaster":{
            "$ref":"#/definitions/ObcmTmRelationshipMasterDTO"
        },
        "extendedDatasegments":{
            "description":"data for the extended datasegment operation",
            "type":"array",
            "items":{
                "type":"object"
            },
            "required":[
                "resourceId",
                "operationType"
            ]
        }
    }
}

Nested Schema : extendedDatasegments

Type: array

data for the extended datasegment operation

Show Source

Array of: object items

{
    "description":"data for the extended datasegment operation",
    "type":"array",
    "items":{
        "type":"object"
    },
    "required":[
        "resourceId",
        "operationType"
    ]
}

Nested Schema : ObcmTmRelationshipMasterDTO

Type: object

Match All

Show Source

allOf GenericDto
object ObcmTmRelationshipMasterDTO-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":"Auto Auth"
                },
                "modificationStatus":{
                    "type":"string",
                    "description":"Modification Status"
                },
                "datasegmentCode":{
                    "type":"string",
                    "description":"Datasegment Code"
                },
                "checkerRemarks":{
                    "type":"string",
                    "description":"checkerRemarks"
                },
                "makerRemarks":{
                    "type":"string",
                    "description":"makerRemarks"
                },
                "autoAcceptance":{
                    "type":"string",
                    "description":"Auto Acceptance"
                },
                "corporateId":{
                    "type":"string",
                    "description":"Corporate Id"
                },
                "corporateName":{
                    "type":"string",
                    "description":"Corporate Name"
                },
                "effFromDate":{
                    "type":"string",
                    "description":"Effective From Date"
                },
                "relationshipCode":{
                    "type":"string",
                    "description":"Relationship Code"
                },
                "relationshipName":{
                    "type":"string",
                    "description":"Relationship Name"
                },
                "expiresOn":{
                    "type":"string",
                    "description":"Expires On"
                },
                "product":{
                    "type":"string",
                    "description":"Product"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"Holiday Treatment"
                },
                "autoDebitApplicable":{
                    "type":"string",
                    "description":"Auto Debit Applicable"
                },
                "noOfDays":{
                    "type":"integer",
                    "description":"Number of Days"
                },
                "maxDate":{
                    "type":"string",
                    "description":"Maximum Date"
                },
                "allowOverdueRcv":{
                    "type":"string",
                    "description":"Allow Overdue Receivables"
                },
                "maxDaysOverdue":{
                    "type":"integer",
                    "description":"Maximum Days Overdue"
                },
                "excessHandling":{
                    "type":"string",
                    "description":"Excess Handling"
                },
                "excessRefundParty":{
                    "type":"string",
                    "description":"Excess Refund Party"
                },
                "excessRefundPaymentMode":{
                    "type":"string",
                    "description":"Excess Refund Payment Mode"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"Transaction Controller Reference Number"
                }
            }
        }
    ]
}

Nested Schema : items

Type: object

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 : ObcmTmRelationshipMasterDTO-allOf[1]

Type: object

Show Source

action: string

Action
allowOverdueRcv: string

Allow Overdue Receivables
autoAcceptance: string

Auto Acceptance
autoAuth: string

Auto Auth
autoDebitApplicable: string

Auto Debit Applicable
checkerRemarks: string

checkerRemarks
corporateId: string

Corporate Id
corporateName: string

Corporate Name
datasegmentCode: string

Datasegment Code
effFromDate: string

Effective From Date
excessHandling: string

Excess Handling
excessRefundParty: string

Excess Refund Party
excessRefundPaymentMode: string

Excess Refund Payment Mode
expiresOn: string

Expires On
holidayTreatment: string

Holiday Treatment
id: string

Id
makerRemarks: string

makerRemarks
maxDate: string

Maximum Date
maxDaysOverdue: integer

Maximum Days Overdue
modificationStatus: string

Modification Status
noOfDays: integer

Number of Days
product: string

Product
relationshipCode: string

Relationship Code
relationshipName: string

Relationship Name
txnControllerRefNo: string

Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "action":{
            "type":"string",
            "description":"Action"
        },
        "autoAuth":{
            "type":"string",
            "description":"Auto Auth"
        },
        "modificationStatus":{
            "type":"string",
            "description":"Modification Status"
        },
        "datasegmentCode":{
            "type":"string",
            "description":"Datasegment Code"
        },
        "checkerRemarks":{
            "type":"string",
            "description":"checkerRemarks"
        },
        "makerRemarks":{
            "type":"string",
            "description":"makerRemarks"
        },
        "autoAcceptance":{
            "type":"string",
            "description":"Auto Acceptance"
        },
        "corporateId":{
            "type":"string",
            "description":"Corporate Id"
        },
        "corporateName":{
            "type":"string",
            "description":"Corporate Name"
        },
        "effFromDate":{
            "type":"string",
            "description":"Effective From Date"
        },
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "relationshipName":{
            "type":"string",
            "description":"Relationship Name"
        },
        "expiresOn":{
            "type":"string",
            "description":"Expires On"
        },
        "product":{
            "type":"string",
            "description":"Product"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"Holiday Treatment"
        },
        "autoDebitApplicable":{
            "type":"string",
            "description":"Auto Debit Applicable"
        },
        "noOfDays":{
            "type":"integer",
            "description":"Number of Days"
        },
        "maxDate":{
            "type":"string",
            "description":"Maximum Date"
        },
        "allowOverdueRcv":{
            "type":"string",
            "description":"Allow Overdue Receivables"
        },
        "maxDaysOverdue":{
            "type":"integer",
            "description":"Maximum Days Overdue"
        },
        "excessHandling":{
            "type":"string",
            "description":"Excess Handling"
        },
        "excessRefundParty":{
            "type":"string",
            "description":"Excess Refund Party"
        },
        "excessRefundPaymentMode":{
            "type":"string",
            "description":"Excess Refund Payment Mode"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of succes or failure

Headers

Location: string

URL of newly created relationshipmaster

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

codes: array codes
id: string
requestId: string
status: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

arg: string
args: array args
Code: string
Desc: string
Language: string
Type: string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error