Jump to

• Request
• Response

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: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Body ()

Request Body contain data required for creating a new adhoc task.

Root Schema : AdhocTaskDto

Type: object

Show Source

• accountId(optional): string
  Account ID
• actionCode(optional): string
  Actin Code
• adhocFlag(optional): string
  Adhoc Flag
• applyDateToAllInitiatedTask(optional): string
  Apply Date to all initiated Tasks
• applyStatusToAllAccounts(optional): string
  Apply Status To all Accounts
• assignee(optional): string
  Assignee
• caseId(optional): string
  Case ID
• collectionStatus(optional): array collectionStatus
  Collection Status
• createdBy(optional): string
  Created By
• createdDtTm(optional): string
  Created Date Time
• desc(optional): string
  Description
• escalationDate(optional): string
  Escalation Date
• existingCollectionStatus(optional): string
  Existing Collection Status
• expiryDate(optional): string
  Expiry Date
• followUpDate(optional): string
  Follow Up Date
• groupTaskStatusCode(optional): string
  Group Task Status Code
• nextTaskTriggerDate(optional): string
  Next Task Trigger Date
• notes(optional): string
  Notes
• partyId(optional): string
  Party ID
• resultCode(optional): string
  Result Code
• segmentCode(optional): string
  Segment Code
• sequence(optional): integer
  Sequence
• startDate(optional): string
  Start Date
• strategyCode(optional): string
  Strategy Code
• taskId(optional): string
  Task ID
• taskName(optional): string
  Task Name
• taskStatusCode(optional): string
  Task Status Code
• taskTypeCode(optional): string
  Task Type Code
• updatedBy(optional): string
  Updated By
• updateDtTm(optional): 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(optional): string
  Action
• collectionStatusCode(optional): string
  Collection Status Code

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Adhoc task data updated successfully.

Headers

• Location: string
  URL of newly created Adhoc task.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

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

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

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

Back to Top