REST API for Oracle Banking Collections

Add a New Call Action

post

/api/1.0/callAction

This endpoint is used to add a new Call Action.

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.

This request body contains data required for creating a new Call Action.

Root Schema : DmTmCallActionDTO

Type: object

Match All

Show Source

allOf GenericDto
object DmTmCallActionDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "code":{
                    "description":"Code",
                    "type":"string"
                },
                "description":{
                    "description":"Description",
                    "type":"string"
                },
                "DmTmCallActionDetailDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DmTmCallActionDetailDTO"
                    }
                }
            }
        }
    ]
}

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

Type: object

Show Source

code: string

Code
description: string

Description
DmTmCallActionDetailDTO: array DmTmCallActionDetailDTO

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "description":{
            "description":"Description",
            "type":"string"
        },
        "DmTmCallActionDetailDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmCallActionDetailDTO"
            }
        }
    }
}

Nested Schema : DmTmCallActionDetailDTO

Type: array

Show Source

Array of: object DmTmCallActionDetailDTO

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

Nested Schema : DmTmCallActionDetailDTO

Type: object

Show Source

actionType: string

Action Type
active: boolean

Active
callActionMasterId: string

Call Action Master ID
callType: string

Call Type
DmTmCallActionResultDTO: array DmTmCallActionResultDTO
id: string

ID
serialNumber: integer

Serial Number

{
    "type":"object",
    "properties":{
        "serialNumber":{
            "description":"Serial Number",
            "type":"integer"
        },
        "actionType":{
            "description":"Action Type",
            "type":"string"
        },
        "callType":{
            "description":"Call Type",
            "type":"string"
        },
        "active":{
            "description":"Active",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "callActionMasterId":{
            "type":"string",
            "description":"Call Action Master ID"
        },
        "DmTmCallActionResultDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmCallActionResultDTO"
            }
        }
    }
}

Nested Schema : DmTmCallActionResultDTO

Type: array

Show Source

Array of: object DmTmCallActionResultDTO

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

Nested Schema : DmTmCallActionResultDTO

Type: object

Show Source

actionResult: string

Action Result
active: boolean

Active
callActionDetailMasterId: string

Call Action Detail Master ID
DmTmResultStatusDTO: array DmTmResultStatusDTO
followUpDays: integer

FollowUp Days
id: string

ID
rightPartyContacted: boolean

Right Party Contacted

{
    "type":"object",
    "properties":{
        "actionResult":{
            "description":"Action Result",
            "type":"string"
        },
        "followUpDays":{
            "description":"FollowUp Days",
            "type":"integer"
        },
        "rightPartyContacted":{
            "description":"Right Party Contacted",
            "type":"boolean"
        },
        "active":{
            "description":"Active",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "callActionDetailMasterId":{
            "type":"string",
            "description":"Call Action Detail Master ID"
        },
        "DmTmResultStatusDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmResultStatusDTO"
            }
        }
    }
}

Nested Schema : DmTmResultStatusDTO

Type: array

Show Source

Array of: object DmTmResultStatusDTO

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

Nested Schema : DmTmResultStatusDTO

Type: object

Show Source

action: boolean

Action
callActionResultMasterId: string

Call Action Result Master ID
collectionStatus: string

Collection Status
id: string

ID

{
    "type":"object",
    "properties":{
        "collectionStatus":{
            "description":"Collection Status",
            "type":"string"
        },
        "action":{
            "description":"Action",
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"ID"
        },
        "callActionResultMasterId":{
            "type":"string",
            "description":"Call Action Result 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 Call Action.

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