Jump to

• Request
• Response

Get Initial or Filtered Task Summary for Task

post

/api/1.0/taskSummary/task

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

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  Limit is maximum number of records to be fetched.
• mode(optional): boolean
  Mode is total results count to be fetched.
• offset(optional): integer
  Offset is starting number of records to be fetched.

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• userId: string
  The user ID of requesting user.

Body ()

Request Body containing data required to fetching task summary details for Task Tab.

Root Schema : DmTaskTabFilterDTO

Type: object

Show Source

• accountNumber(optional): string
  Account Number
• customerId(optional): string
  Customer ID
• escalationDateMax(optional): string
  Escalation range maximum
• escalationDateMin(optional): string
  Escalation range minimum
• expirationDateMax(optional): string
  Expiration range maximum
• expirationDateMin(optional): string
  Expiration range Minimum
• flagType(optional): string
  Flag Type
• followUpDate(optional): string
  Follow up date
• isEscalatedFlag(optional): string
  Is Escalated
• segmentCodes(optional): array segmentCodes
  Segment Codes
• taskType(optional): array taskType
  Task type
• userAssigned(optional): array userAssigned
  User Assigned

{
    "type":"object",
    "properties":{
        "taskType":{
            "description":"Task type",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "segmentCodes":{
            "description":"Segment Codes",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "followUpDate":{
            "description":"Follow up date",
            "type":"string"
        },
        "expirationDateMin":{
            "description":"Expiration range Minimum",
            "type":"string"
        },
        "expirationDateMax":{
            "description":"Expiration range maximum",
            "type":"string"
        },
        "escalationDateMin":{
            "description":"Escalation range minimum",
            "type":"string"
        },
        "escalationDateMax":{
            "description":"Escalation range maximum",
            "type":"string"
        },
        "userAssigned":{
            "description":"User Assigned",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "isEscalatedFlag":{
            "description":"Is Escalated",
            "type":"string"
        },
        "customerId":{
            "description":"Customer ID",
            "type":"string"
        },
        "flagType":{
            "description":"Flag Type",
            "type":"string"
        }
    }
}

Nested Schema : segmentCodes

Type: array

Segment Codes

Show Source

• Array of: string

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

Nested Schema : taskType

Type: array

Task type

Show Source

• Array of: string

{
    "description":"Task type",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : userAssigned

Type: array

User Assigned

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Return tasks assigned to user.

Body ()

Root Schema : TaskTabCollection

Type: object

Collection of the Task Details.

Show Source

• data(optional): array data
  Data
• paging(optional): object PagingDto

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

Nested Schema : data

Type: array

Data

Show Source

• Array of: object TaskTabDTO
  Task tab Data transfer object

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : TaskTabDTO

Type: object

Task tab Data transfer object

Show Source

• accountId(optional): string
  Account ID
• accountNumber(optional): string
  Account Number
• acctCurrCd(optional): string
  Account Currency Code
• adhocFlag(optional): string
  Adhoc Flag
• caseId(optional): string
  Case ID
• caseNumber(optional): string
  Case Number
• customerName(optional): string
  Customer Name
• daysPastDue(optional): string
  Days Past Due
• escalationDate(optional): string
  Escalation Date
• expirationDate(optional): string
  Expiration Date
• flagged(optional): string
  Is Flagged
• flagType(optional): string
  Flag Type
• followUpDate(optional): string
  Followup Date
• overdueAmt(optional): string
  Overdue Amount
• partyId(optional): string
  Party ID
• prdProcessrCd(optional): string
  Product Processor Code
• productType(optional): string
  Product Type
• segmentCd(optional): string
  Segment Code
• segmentDesc(optional): string
  Segment Description
• strategyCd(optional): string
  Strategy Code
• taskId(optional): string
  Task ID
• taskNameCd(optional): string
  Task Name Code
• taskNameDesc(optional): string
  Task Name Desc
• taskStatusCd(optional): string
  Task Status Code
• taskStatusDesc(optional): string
  Task Status Description
• taskType(optional): string
  Task Type Code
• userAssigned(optional): string
  User Assigned
• userAssignedId(optional): string
  User Assigned ID

{
    "type":"object",
    "description":"Task tab Data transfer object",
    "properties":{
        "taskId":{
            "description":"Task ID",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "partyId":{
            "description":"Party ID",
            "type":"string"
        },
        "taskNameCd":{
            "description":"Task Name Code",
            "type":"string"
        },
        "taskNameDesc":{
            "description":"Task Name Desc",
            "type":"string"
        },
        "taskStatusCd":{
            "description":"Task Status Code",
            "type":"string"
        },
        "taskStatusDesc":{
            "description":"Task Status Description",
            "type":"string"
        },
        "taskType":{
            "description":"Task Type Code",
            "type":"string"
        },
        "accountNumber":{
            "description":"Account Number",
            "type":"string"
        },
        "customerName":{
            "description":"Customer Name",
            "type":"string"
        },
        "productType":{
            "description":"Product Type",
            "type":"string"
        },
        "overdueAmt":{
            "description":"Overdue Amount",
            "type":"string"
        },
        "acctCurrCd":{
            "description":"Account Currency Code",
            "type":"string"
        },
        "daysPastDue":{
            "description":"Days Past Due",
            "type":"string"
        },
        "prdProcessrCd":{
            "description":"Product Processor Code",
            "type":"string"
        },
        "segmentCd":{
            "description":"Segment Code",
            "type":"string"
        },
        "segmentDesc":{
            "description":"Segment Description",
            "type":"string"
        },
        "strategyCd":{
            "description":"Strategy Code",
            "type":"string"
        },
        "followUpDate":{
            "description":"Followup Date",
            "type":"string"
        },
        "escalationDate":{
            "description":"Escalation Date",
            "type":"string"
        },
        "expirationDate":{
            "description":"Expiration Date",
            "type":"string"
        },
        "userAssigned":{
            "description":"User Assigned",
            "type":"string"
        },
        "userAssignedId":{
            "description":"User Assigned ID",
            "type":"string"
        },
        "adhocFlag":{
            "description":"Adhoc Flag",
            "type":"string"
        },
        "caseNumber":{
            "description":"Case Number",
            "type":"string"
        },
        "caseId":{
            "description":"Case ID",
            "type":"string"
        },
        "flagged":{
            "type":"string",
            "description":"Is Flagged"
        },
        "flagType":{
            "type":"string",
            "description":"Flag Type"
        }
    }
}

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.

Back to Top