Jump to

• Request
• Response

Retrieve Ad hoc Task Onload

get

/api/1.0/onloadadhoctask/{accountId}

This endpoint is used to retrieve ad hoc task onload.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• accountId: string
  Account ID

Query Parameters

• segmentCode(optional): string
  Segment Code
• strategyCode(optional): string
  Strategy Code

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.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Return onload ad hoc task details based on given account ID.

Body ()

Root Schema : DmInitLoadAdhocTaskDto

Type: object

Show Source

• assigneeList(optional): array assigneeList
• callActionCollection(optional): object DmTmCallActionCollection
  Collection of callAction.
• partyId(optional): string
• segmentList(optional): array segmentList
• strategyList(optional): array strategyList
• taskTypeList(optional): array taskTypeList

{
    "type":"object",
    "properties":{
        "taskTypeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTaskTypeDto"
            }
        },
        "segmentList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmSegmentDto"
            }
        },
        "strategyList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmStrategyDto"
            }
        },
        "assigneeList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "callActionCollection":{
            "$ref":"#/definitions/DmTmCallActionCollection"
        },
        "partyId":{
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : assigneeList

Type: array

Show Source

• Array of: string

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

Nested Schema : DmTmCallActionCollection

Type: object

Collection of callAction.

Show Source

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

{
    "description":"Collection of callAction.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmCallActionDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : segmentList

Type: array

Show Source

• Array of: object DmSegmentDto

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

Nested Schema : strategyList

Type: array

Show Source

• Array of: object DmStrategyDto

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

Nested Schema : taskTypeList

Type: array

Show Source

• Array of: object DmTaskTypeDto

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

Nested Schema : data

Type: array

Show Source

• Array of: object DmTmCallActionDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer
  Total number of results available.

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total number of results available."
        }
    }
}

Nested 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(optional): string
  Code
• description(optional): string
  Description
• DmTmCallActionDetailDTO(optional): 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(optional): string
  Action Type
• active(optional): boolean
  Active
• callActionMasterId(optional): string
  Call Action Master ID
• callType(optional): string
  Call Type
• DmTmCallActionResultDTO(optional): array DmTmCallActionResultDTO
• id(optional): string
  ID
• serialNumber(optional): 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(optional): string
  Action Result
• active(optional): boolean
  Active
• callActionDetailMasterId(optional): string
  Call Action Detail Master ID
• DmTmResultStatusDTO(optional): array DmTmResultStatusDTO
• followUpDays(optional): integer
  FollowUp Days
• id(optional): string
  ID
• rightPartyContacted(optional): 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(optional): boolean
  Action
• callActionResultMasterId(optional): string
  Call Action Result Master ID
• collectionStatus(optional): string
  Collection Status
• id(optional): 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"
        }
    }
}

Nested Schema : DmSegmentDto

Type: object

Show Source

• segmentCode(optional): string
• segmentDesc(optional): string

{
    "type":"object",
    "properties":{
        "segmentCode":{
            "description":"",
            "type":"string"
        },
        "segmentDesc":{
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : DmStrategyDto

Type: object

Show Source

• callDetails(optional): string
• effectiveDate(optional): string
• expiryDate(optional): string
• segmentCode(optional): string
• strategyCode(optional): string
• strategyDesc(optional): string

{
    "type":"object",
    "properties":{
        "strategyCode":{
            "description":"",
            "type":"string"
        },
        "strategyDesc":{
            "description":"",
            "type":"string"
        },
        "callDetails":{
            "description":"",
            "type":"string"
        },
        "effectiveDate":{
            "description":"",
            "type":"string"
        },
        "expiryDate":{
            "description":"",
            "type":"string"
        },
        "segmentCode":{
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : DmTaskTypeDto

Type: object

Show Source

• taskCd(optional): string
• taskTypeCd(optional): string
• taskTypeDesc(optional): string
• workflowCd(optional): string

{
    "type":"object",
    "properties":{
        "taskTypeCd":{
            "description":"",
            "type":"string"
        },
        "taskTypeDesc":{
            "description":"",
            "type":"string"
        },
        "taskCd":{
            "description":"",
            "type":"string"
        },
        "workflowCd":{
            "description":"",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error.

Back to Top