POSTCFI,ALL/BulkDispatchGetExcelTemplate

IN THIS PAGE

Request Headers
Body JSON
Example Request
Example Response

Description

Creates an Excel template for a Bulk Dispatch operation. The Excel template is filled in and then uploaded. Data in the uploaded Excel file is used to dispatch forms.

For information on how to fill out the Excel template, see Bulk Dispatch Excel Template

Request Headers

Name: Description
apikey: REQUIRED - A TransForm API key with the appropriate scopes to access the endpoint. The API Key must have either the CFI or ALL scopes.

Body JSON

The body is a JSON object with the following properties:

Name

Description

forms

REQUIRED, string; a comma delimited list of form IDs of the forms for which the Excel template should be generated.

Example:

{
    "forms":"homeinspection,fieldservice"
}

Example Request

curl --location --request POST 'https://transform.alphasoftware.com/transformAPIVersion1.a5svc/BulkDispatchGetExcelTemplate' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
    "forms":"homeinspection,fieldservice"
}'

Example Response

{
    "error": false,
    "result": {
        "ExcelTemplateURL": "https://transformcentral.s3.amazonaws.com/exceltemplates/download/XXXXXXXX.xlsx"
    },
    "errortext": "",
    "ExcelTemplateURL": "https://transformcentral.s3.amazonaws.com/exceltemplates/download/XXXXXXXX.xlsx"
}