REST API for Oracle Banking Collections

Get Initial or Filtered Task Summary for Specialized Cases

post

/api/1.0/taskSummary/specializedcase

This endpoint is used to view Task Summary for Specialized Cases by user ID from headers.

Request

Supported Media Types

application/json
application/xml

Query Parameters

limit: integer

Limit is maximum number of records to be fetched.
mode: boolean

Mode is total results count to be fetched.
offset: integer

Offset is starting number of records to be fetched.

Header Parameters

appId(required): string

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

The branch code of requesting branch.
userId(required): string

The user ID of requesting user.

Request Body contain data required to fetch task summary details for specialized case tab.

Root Schema : DmSpecializedCaseTabFilterDTO

Type: object

Show Source

accountNumber: string

Account Number
customerNumber: string

Customer Number
segmentCodes: array segmentCodes

Segment Code
strategyCodes: array strategyCodes

Strategy Code
userAssigned: array userAssigned

User Assigned

{
    "type":"object",
    "properties":{
        "segmentCodes":{
            "description":"Segment Code",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "strategyCodes":{
            "description":"Strategy Code",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "userAssigned":{
            "type":"array",
            "description":"User Assigned",
            "items":{
                "type":"string"
            }
        },
        "customerNumber":{
            "description":"Customer Number",
            "type":"string"
        }
    }
}

Nested Schema : segmentCodes

Type: array

Segment Code

Show Source

Array of: string

{
    "description":"Segment Code",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : strategyCodes

Type: array

Strategy Code

Show Source

Array of: string

{
    "description":"Strategy Code",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : userAssigned

Type: array

User Assigned

Show Source

Array of: string

{
    "type":"array",
    "description":"User Assigned",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Return specialized cases assigned to user.

Root Schema : SpecializedCaseTabCollection

Type: object

Collection of the Specialized Case Details.

Show Source

data: array data

Data
paging: object PagingDto

Paging data transfer object.

{
    "description":"Collection of the Specialized Case Details.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"Data",
            "items":{
                "$ref":"#/definitions/SpecializedCaseTabDTO"
            }
        },
        "paging":{
            "description":"Paging",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Data

Show Source

Array of: object SpecializedCaseTabDTO

{
    "type":"array",
    "description":"Data",
    "items":{
        "$ref":"#/definitions/SpecializedCaseTabDTO"
    }
}

Nested Schema : PagingDto

Type: object

Paging data transfer object.

Show Source

totalResults: integer

Total results

{
    "description":"Paging data transfer object.",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total results"
        }
    }
}

Nested Schema : SpecializedCaseTabDTO

Type: object

Show Source

accountId: string

Account ID
accountNumber: string

Account Number
caseNumber: string

Case Number
customerName: string

Customer Name
escalated: integer

Escalated
notStarted: integer

not Started
prdProcessrCd: string

Product Processor Code
productType: string

Product Type
segmentCode: string

Segment Code
segmentDesc: string

Segment Description
strategyCode: string

Strategy Code
strategyDesc: string

Strategy Description
userAssigned: string

User Assigned
workInProgress: integer

Work In Progress

{
    "type":"object",
    "properties":{
        "accountId":{
            "type":"string",
            "description":"Account ID"
        },
        "segmentCode":{
            "type":"string",
            "description":"Segment Code"
        },
        "strategyCode":{
            "type":"string",
            "description":"Strategy Code"
        },
        "strategyDesc":{
            "type":"string",
            "description":"Strategy Description"
        },
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "customerName":{
            "type":"string",
            "description":"Customer Name"
        },
        "segmentDesc":{
            "description":"Segment Description",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "productType":{
            "type":"string",
            "description":"Product Type"
        },
        "notStarted":{
            "type":"integer",
            "description":"not Started"
        },
        "escalated":{
            "type":"integer",
            "description":"Escalated"
        },
        "workInProgress":{
            "type":"integer",
            "description":"Work In Progress"
        },
        "userAssigned":{
            "type":"string",
            "description":"User Assigned"
        },
        "caseNumber":{
            "type":"string",
            "description":"Case Number"
        }
    }
}

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.