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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
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
		}
	}
}