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(required): string
  Account ID

Query Parameters

• segmentCode: string
  Segment Code
• strategyCode: string
  Strategy Code

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.

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

Init Load Adhoc Task Data Transfer Object details.

Show Source

• callActionCollection: object DmTmCallActionCollection
  Collection of Call Action Data
• partyId: string
  Party ID
• segmentStrategyList: array segmentStrategyList
  Segment Strategy List
• taskTypeList: array taskTypeList
  Task Type List

{
    "description":"Init Load Adhoc Task Data Transfer Object details.",
    "type":"object",
    "properties":{
        "taskTypeList":{
            "type":"array",
            "description":"Task Type List",
            "items":{
                "$ref":"#/definitions/DmTaskTypeDto"
            }
        },
        "segmentStrategyList":{
            "type":"array",
            "description":"Segment Strategy List",
            "items":{
                "$ref":"#/definitions/DmSegmentStrategyAssignDTO"
            }
        },
        "callActionCollection":{
            "$ref":"#/definitions/DmTmCallActionCollection",
            "description":"Call action collection"
        },
        "partyId":{
            "description":"Party ID",
            "type":"string"
        }
    }
}

Nested Schema : DmTmCallActionCollection

Type: object

Collection of Call Action Data

Show Source

• data: array data
  data

{
    "description":"Collection of Call Action Data",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "description":"data",
            "items":{
                "$ref":"#/definitions/DmTmCallActionDTO"
            }
        }
    }
}

Nested Schema : segmentStrategyList

Type: array

Segment Strategy List

Show Source

• Array of: object DmSegmentStrategyAssignDTO
  Segment Strategy Assign Data

{
    "type":"array",
    "description":"Segment Strategy List",
    "items":{
        "$ref":"#/definitions/DmSegmentStrategyAssignDTO"
    }
}

Nested Schema : taskTypeList

Type: array

Task Type List

Show Source

• Array of: object DmTaskTypeDto
  Task type data transfer object

{
    "type":"array",
    "description":"Task Type List",
    "items":{
        "$ref":"#/definitions/DmTaskTypeDto"
    }
}

Nested Schema : data

Type: array

data

Show Source

• Array of: object DmTmCallActionDTO
  Call ation details

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

Nested Schema : DmTmCallActionDTO

Type: object

Call ation details

Show Source

• code: string
  Code
• description: string
  Description
• DmTmCallActionDetailDTO: array DmTmCallActionDetailDTO
  Call action details

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

Nested Schema : DmTmCallActionDetailDTO

Type: array

Call action details

Show Source

• Array of: object DmTmCallActionDetailDTO

{
    "type":"array",
    "description":"Call action details",
    "items":{
        "$ref":"#/definitions/DmTmCallActionDetailDTO"
    }
}

Nested Schema : DmTmCallActionDetailDTO

Type: object

Show Source

• actionType: string
  Action Type
• active: string
  Active
• callActionMasterId: string
  Call Action Master ID
• callType: string
  Call Type
• DmTmCallActionResultDTO: array DmTmCallActionResultDTO
  Call Action result
• id: string
  ID
• serialNumber: string
  Serial Number

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

Nested Schema : DmTmCallActionResultDTO

Type: array

Call Action result

Show Source

• Array of: object DmTmCallActionResultDTO

{
    "type":"array",
    "description":"Call Action result",
    "items":{
        "$ref":"#/definitions/DmTmCallActionResultDTO"
    }
}

Nested Schema : DmTmCallActionResultDTO

Type: object

Show Source

• actionResult: string
  Action Result
• active: string
  Active
• callActionDetailMasterId: string
  Call Action Detail Master ID
• DmTmResultStatusDTO: array DmTmResultStatusDTO
  Result Status
• followUpDays: string
  Follow Up Days
• id: string
  ID
• rightPartyContacted: string
  Right Party Contacted

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

Nested Schema : DmTmResultStatusDTO

Type: array

Result Status

Show Source

• Array of: object DmTmResultStatusDTO

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

Nested Schema : DmTmResultStatusDTO

Type: object

Show Source

• action: string
  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":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "callActionResultMasterId":{
            "description":"Call Action Result Master ID",
            "type":"string"
        }
    }
}

Nested Schema : DmSegmentStrategyAssignDTO

Type: object

Segment Strategy Assign Data

Show Source

• segmentCd: string
  Segment Code
• segmentDesc: string
  Segment Description
• strategyList: array strategyList
  Strategy List

{
    "description":"Segment Strategy Assign Data",
    "type":"object",
    "properties":{
        "segmentCd":{
            "description":"Segment Code",
            "type":"string"
        },
        "segmentDesc":{
            "type":"string",
            "description":"Segment Description"
        },
        "strategyList":{
            "type":"array",
            "description":"Strategy List",
            "items":{
                "$ref":"#/definitions/DmStrategyAssignDataDTO"
            }
        }
    }
}

Nested Schema : strategyList

Type: array

Strategy List

Show Source

• Array of: object DmStrategyAssignDataDTO
  Strategy Assign Data data transfer object model

{
    "type":"array",
    "description":"Strategy List",
    "items":{
        "$ref":"#/definitions/DmStrategyAssignDataDTO"
    }
}

Nested Schema : DmStrategyAssignDataDTO

Type: object

Strategy Assign Data data transfer object model

Show Source

• ignoreGroupBasisFlag: string
  Ignore Group Basis Flag
• strategyCode: string
  Strategy Code
• strategyDesc: string
  Strategy Description
• strategyId: string
  Strategy ID
• userGrpCd: string
  User Group Code
• userId: string
  User ID
• userName: string
  User Name

{
    "description":"Strategy Assign Data data transfer object model",
    "type":"object",
    "properties":{
        "strategyId":{
            "description":"Strategy ID",
            "type":"string"
        },
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "strategyDesc":{
            "description":"Strategy Description",
            "type":"string"
        },
        "ignoreGroupBasisFlag":{
            "description":"Ignore Group Basis Flag",
            "type":"string"
        },
        "userId":{
            "description":"User ID",
            "type":"string"
        },
        "userName":{
            "description":"User Name",
            "type":"string"
        },
        "userGrpCd":{
            "description":"User Group Code",
            "type":"string"
        }
    }
}

Nested Schema : DmTaskTypeDto

Type: object

Task type data transfer object

Show Source

• taskCd: string
  Task Code
• taskTypeCd: string
  Task Type Code
• taskTypeDesc: string
  Task Type Description
• workflowCd: string
  Workflow Code

{
    "description":"Task type data transfer object",
    "type":"object",
    "properties":{
        "taskTypeCd":{
            "description":"Task Type Code",
            "type":"string"
        },
        "taskTypeDesc":{
            "description":"Task Type Description",
            "type":"string"
        },
        "taskCd":{
            "description":"Task Code",
            "type":"string"
        },
        "workflowCd":{
            "description":"Workflow Code",
            "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