REST API for Oracle Banking Collections

Add New Strategy

post

/api/1.0/strategymaintenance

This endpoint is used to add a new Strategy

Request

Supported Media Types

application/json
application/xml

Header Parameters

appId(required): string

The application ID of host service.
branchCode(required): string

The branch code of requesting branch.
contentType: string

The content type of request or response body.
userId(required): string

The user ID of requesting user.

Request Body that contains data required for creating a new Strategy

Root Schema : DmTmStrategymaintenanceDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmStrategymaintenanceDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "code":{
                    "description":"Code",
                    "type":"string"
                },
                "description":{
                    "description":"Description",
                    "type":"string"
                },
                "effectiveDate":{
                    "description":"Effective date",
                    "type":"string"
                },
                "expiryDate":{
                    "description":"Expiry date",
                    "type":"string"
                },
                "DmTmTaskDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmTaskDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

object GenericDto-allOf[0]

Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : DmTmStrategymaintenanceDTO-allOf[1]

Type: object

Show Source

code: string

Code
description: string

Description
DmTmTaskDTO: array DmTmTaskDTO
effectiveDate: string

Effective date
expiryDate: string

Expiry date

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "description":{
            "description":"Description",
            "type":"string"
        },
        "effectiveDate":{
            "description":"Effective date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry date",
            "type":"string"
        },
        "DmTmTaskDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmTaskDTO"
            }
        }
    }
}

Nested Schema : DmTmTaskDTO

Type: array

Show Source

Array of: object DmTmTaskDTO

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

Nested Schema : DmTmTaskDTO

Type: object

Show Source

dependency: string

Dependency
DmTmAdviceDTO: array DmTmAdviceDTO
escalation: string

Escalation
expiration: string

Expiration
id: string

ID
mandatory: boolean

Mandatory
sequence: integer

Sequence
strategymaintenanceMasterId: string

Strategy maintenance master ID
taskName: string

Task name
waitPeriod: string

Wait Period

{
    "type":"object",
    "properties":{
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "taskName":{
            "description":"Task name",
            "type":"string"
        },
        "mandatory":{
            "description":"Mandatory",
            "type":"boolean"
        },
        "waitPeriod":{
            "description":"Wait Period",
            "type":"string"
        },
        "escalation":{
            "description":"Escalation",
            "type":"string"
        },
        "expiration":{
            "description":"Expiration",
            "type":"string"
        },
        "dependency":{
            "description":"Dependency",
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "strategymaintenanceMasterId":{
            "type":"string",
            "description":"Strategy maintenance master ID"
        },
        "DmTmAdviceDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmAdviceDTO"
            }
        }
    }
}

Nested Schema : DmTmAdviceDTO

Type: array

Show Source

Array of: object DmTmAdviceDTO

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

Nested Schema : DmTmAdviceDTO

Type: object

Show Source

code: string
default: boolean

Default
description: string
id: string

ID
selected: boolean
TaskMasterId: string

Task master ID

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "selected":{
            "type":"boolean"
        },
        "default":{
            "type":"boolean",
            "description":"Default"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "TaskMasterId":{
            "type":"string",
            "description":"Task master ID"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Returns message of success or failure

Headers

Location: string

URL of newly created Strategy.

Root Schema : ResponseDtoWrapper

Type: object

Response Data Transfer object

Show Source

data: object ResponseResourceSupport
messages: object ResponseDto

Response Data Transfer object

{
    "type":"object",
    "description":"Response Data Transfer object",
    "properties":{
        "messages":{
            "description":"Messages",
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "description":"Data",
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Response Data Transfer object

Show Source

codes: array codes

Codes
id: string

ID
requestId: string

Request ID
status: string

Status

{
    "description":"Response Data Transfer object",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

Array of: object ResponseCode

Response code

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

Nested Schema : ResponseCode

Type: object

Response code

Show Source

arg: string

Argument
args: array args

Arguments
Code: string

Code
Desc: string

Description
Language: string

Language
Type: string

Type

{
    "type":"object",
    "description":"Response code",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Arguments",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"Argument"
        }
    }
}

Nested Schema : args

Type: array

Arguments

Show Source

Array of: object items

{
    "type":"array",
    "description":"Arguments",
    "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