Jump to

• Request
• Response

Retrieve the Call Action by ID

get

/api/1.0/callAction/{id}

This endpoint is used to retrieve the Call Action by ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id(required): string
  ID of the user that needs to be fetched.

Query Parameters

• version(required): string
  Version ID of the record that needs to be fetched.

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

Returns the Call Action based on given ID.

Body ()

Root Schema : DmTmCallActionWrapperDTO

Type: object

Show Source

• data: object DmTmCallActionDTO
  Call ation details

{
    "type":"object",
    "properties":{
        "data":{
            "$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"
        }
    }
}

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