digitaluapi

<back to all web services

UploadFieldsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/upload_fields
UploadFieldsAdd Parameters:
NameParameterData TypeRequiredDescription
FieldNamebodystringNo
Requiredbodybool?No
UploadTypebodystringNo
LabelbodystringNo
UploadSubtypebodystringNo
IsEnabledbodybool?No
SortOrderbodydouble?No
HelpbodystringNo
PlaceholderbodystringNo
UploadFieldsAddResponse Parameters:
NameParameterData TypeRequiredDescription
FieldNameformstringNo
Requiredformbool?No
UploadTypeformstringNo
LabelformstringNo
UploadSubtypeformstringNo
IsEnabledformbool?No
SortOrderformdouble?No
HelpformstringNo
PlaceholderformstringNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /upload_fields HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FieldName":"String","Required":false,"UploadType":"String","Label":"String","UploadSubtype":"String","IsEnabled":false,"SortOrder":0,"Help":"String","Placeholder":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"FieldName":"String","Required":false,"UploadType":"String","Label":"String","UploadSubtype":"String","IsEnabled":false,"SortOrder":0,"Help":"String","Placeholder":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}