transform

POSTCFI,ALL/BulkDispatchProcessExcelFile

Description

Dispatches forms for each record in an Excel file containing dispatch information. The Excel file must be accessible over the web via URL.

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.

Parameters 

Name
Description
body

REQUIRED - JSON Object with the following properties defined:

excelfileurl

REQUIRED, string; the URL to the location of the Excel file that contains the form dispatch information.

Example:

{
    "excelfileurl":"https://www.example.com/dispatchSiteVists.xlsx"
}

Example Request 

curl --location --request POST 'https://alphademo1-transformbeta.cloud.alphasoftware.com/transformAPIVersion1.a5svc/BulkDispatchProcessExcelFile' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "excelfileurl":"https://www.example.com/dispatchSiteVists.xlsx"
}'

Example Response 

{
    "resultSummary": {
        "errorCount": 0
    },
    "result": [
        {
            "error": false,
            "action": "insert",
            "formInstanceId": "k9bng9ti_xxxxxxxx",
            "index": 1
        },
        {
            "error": false,
            "action": "insert",
            "formInstanceId": "k9bng9wj_xxxxxxxx",
            "index": 2
        },
        {
            "error": false,
            "action": "insert",
            "formInstanceId": "k9bng9xe_xxxxxxxx",
            "index": 3
        }
    ],
    "notifications": [
        {
            "type": "insert",
            "person": "[email protected]"
        },
        {
            "type": "insert",
            "person": "[email protected]"
        },
        {
            "type": "insert",
            "person": "[email protected]"
        }

    ],
    "error": false,
    "errorText": "",
    "notificationErrors": false,
    "notificationErrorText": ""
}

See Also