REST API for Oracle Banking Collections

Save Ad hoc Task Data

post

/api/1.0/adhocktask

This endpoint is used to save ad hoc task data.

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 contain data required for creating a new adhoc task.

Root Schema : AdhocTaskDto

Type: object

Show Source

accountId: string

Account ID
actionCode: string

Actin Code
adhocFlag: string

Adhoc Flag
applyDateToAllInitiatedTask: string

Apply Date to all initiated Tasks
applyStatusToAllAccounts: string

Apply Status To all Accounts
assignee: string

Assignee
caseId: string

Case ID
collectionStatus: array collectionStatus

Collection Status
createdBy: string

Created By
createdDtTm: string

Created Date Time
desc: string

Description
escalationDate: string

Escalation Date
existingCollectionStatus: string

Existing Collection Status
expiryDate: string

Expiry Date
followUpDate: string

Follow Up Date
groupTaskStatusCode: string

Group Task Status Code
nextTaskTriggerDate: string

Next Task Trigger Date
notes: string

Notes
partyId: string

Party ID
resultCode: string

Result Code
segmentCode: string

Segment Code
sequence: integer

Sequence
startDate: string

Start Date
strategyCode: string

Strategy Code
taskId: string

Task ID
taskName: string

Task Name
taskStatusCode: string

Task Status Code
taskTypeCode: string

Task Type Code
updatedBy: string

Updated By
updateDtTm: string

Update Date Time

{
    "type":"object",
    "properties":{
        "caseId":{
            "description":"Case ID",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "segmentCode":{
            "description":"Segment Code",
            "type":"string"
        },
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "taskName":{
            "description":"Task Name",
            "type":"string"
        },
        "taskStatusCode":{
            "description":"Task Status Code",
            "type":"string"
        },
        "taskTypeCode":{
            "description":"Task Type Code",
            "type":"string"
        },
        "updatedBy":{
            "description":"Updated By",
            "type":"string"
        },
        "createdDtTm":{
            "description":"Created Date Time",
            "type":"string"
        },
        "updateDtTm":{
            "description":"Update Date Time",
            "type":"string"
        },
        "createdBy":{
            "description":"Created By",
            "type":"string"
        },
        "startDate":{
            "description":"Start Date",
            "type":"string"
        },
        "followUpDate":{
            "description":"Follow Up Date",
            "type":"string"
        },
        "escalationDate":{
            "description":"Escalation Date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry Date",
            "type":"string"
        },
        "nextTaskTriggerDate":{
            "description":"Next Task Trigger Date",
            "type":"string"
        },
        "partyId":{
            "description":"Party ID",
            "type":"string"
        },
        "groupTaskStatusCode":{
            "description":"Group Task Status Code",
            "type":"string"
        },
        "assignee":{
            "description":"Assignee",
            "type":"string"
        },
        "adhocFlag":{
            "description":"Adhoc Flag",
            "type":"string"
        },
        "actionCode":{
            "description":"Actin Code",
            "type":"string"
        },
        "resultCode":{
            "description":"Result Code",
            "type":"string"
        },
        "collectionStatus":{
            "description":"Collection Status",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CollectionStatus"
            }
        },
        "applyStatusToAllAccounts":{
            "description":"Apply Status To all Accounts",
            "type":"string"
        },
        "applyDateToAllInitiatedTask":{
            "description":"Apply Date to all initiated Tasks",
            "type":"string"
        },
        "notes":{
            "description":"Notes",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "existingCollectionStatus":{
            "description":"Existing Collection Status",
            "type":"string"
        }
    }
}

Nested Schema : collectionStatus

Type: array

Collection Status

Show Source

Array of: object CollectionStatus

{
    "description":"Collection Status",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CollectionStatus"
    }
}

Nested Schema : CollectionStatus

Type: object

Show Source

action: string

Action
collectionStatusCode: string

Collection Status Code

{
    "type":"object",
    "properties":{
        "collectionStatusCode":{
            "type":"string",
            "description":"Collection Status Code"
        },
        "action":{
            "type":"string",
            "description":"Action"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

201 Response

Adhoc task data updated successfully.

Headers

Location: string

URL of newly created Adhoc task.

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.