DC5.0.0 6.4.4 - SetTransferMode

Owned by Magnus Frank
Last updated: May 14, 2019
1 min read

This method is used for initiating an upload

URL : /UploadService.js

Method : POST

Auth required : Yes

Required parameters

NameExampleDescription
methodSetTransferModeFixed parameter that identifies the endpoint method.
accessKeyeb774621-1c2f-467b-b006-a8efa67094a7AccesKey for API
uploadId1234id of the upload
transferMode1describes how the batch system should get the physical file. 1 should be used normally


cUrl data example

--data "accesskey=method=SetTransferMode&eb774621-1c2f-467b-b006-a8efa67094a7&uploadId=318&transferMode=1"

Success Response

Code : 200 OK

Content example

{
	"success": true,
	"total": 1,
	"error": "",
	"items": null,
	"warnings": null
}

Error Response

Code : 200 OK

Content  example

{
	"success": false,
	"total": 0,
	"error": "Access denied\r\n",
	"items": null,
	"warnings": [{
		"Severity": 10,
		"Code": 420,
		"Description": "Access denied"
	}]
}