This method is used for initiating an upload
URL : /UploadService.js
Method : POST
Auth required : NO
Required parameters
| Name | Example | Description |
|---|---|---|
| method | SetTransferMode | Fixed parameter that identifies the endpoint method. |
| accessKey | eb774621-1c2f-467b-b006-a8efa67094a7 | AccesKey for API |
| uploadId | 1234 | id of the upload |
| transferMode | 1 | describes how the batch system should get the physical file. 1 should be used normally |
cUrl data example
| Info | ||
|---|---|---|
| ||
--data "accesskey=method=SetTransferMode&eb774621-1c2f-467b-b006-a8efa67094a7&uploadId=318&transferMode=1" |
Success Response
Code : 200 OK
Content example
| Code Block |
|---|
{
"success": true,
"total": 1,
"error": "",
"items": null,
"warnings": null
} |
Error Response
Code : 200 OK
Content example
| Code Block |
|---|
{
"success": false,
"total": 0,
"error": "Access denied\r\n",
"items": null,
"warnings": [{
"Severity": 10,
"Code": 420,
"Description": "Access denied"
}]
} |