Jump to

• Request
• Response

Add New Call Action Followup Record

post

/api/1.0/callActionTransactional

This end point is used to add a new call action followup record.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• followupDate: string
  Flag to update follow up date.

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.
• entityId: string
  The entity ID of host service.
• userId: string
  The user ID of requesting user.

Body ()

Request Body that contains data required for creating a new call action followup.

Root Schema : DmActionResultsDTO

Type: object

Show Source

• accountId(optional): string
  Account ID
• actionCode(optional): string
  Action Code
• applyDateToAllInitiatedTask(optional): string
  Apply Date To All Initiated Task
• applyStatusToAllAccounts(optional): string
  Apply Status To All Accounts
• caseId(optional): string
  Case ID
• collectionStatus(optional): array collectionStatus
• existingCollectionStatus(optional): string
  Existing Collection Status
• followupDate(optional): string
  Followup Date
• id(optional): string
  ID
• notes(optional): string
  Notes
• resultCode(optional): string
  Result Code
• taskId(optional): string
  Task ID
• taskName(optional): string
  Task Name
• taskStatus(optional): string
  Task Status

{
    "properties":{
        "caseId":{
            "description":"Case ID",
            "type":"string"
        },
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "id":{
            "description":"ID",
            "type":"string"
        },
        "notes":{
            "description":"Notes",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID",
            "type":"string"
        },
        "taskName":{
            "description":"Task Name",
            "type":"string"
        },
        "actionCode":{
            "description":"Action Code",
            "type":"string"
        },
        "resultCode":{
            "description":"Result Code",
            "type":"string"
        },
        "collectionStatus":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DmTmCollectionStatusDetails"
            }
        },
        "applyStatusToAllAccounts":{
            "description":"Apply Status To All Accounts",
            "type":"string"
        },
        "existingCollectionStatus":{
            "description":"Existing Collection Status",
            "type":"string"
        },
        "taskStatus":{
            "description":"Task Status",
            "type":"string"
        },
        "followupDate":{
            "description":"Followup Date",
            "type":"string"
        },
        "applyDateToAllInitiatedTask":{
            "description":"Apply Date To All Initiated Task",
            "type":"string"
        }
    }
}

Nested Schema : collectionStatus

Type: array

Show Source

• Array of: object DmTmCollectionStatusDetails

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

Nested Schema : DmTmCollectionStatusDetails

Type: object

Show Source

• action(optional): string
  Action
• collectionStatusCode(optional): string
  Collection Status Code

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Headers

• Location: string
  URL of newly created Call Action

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