digitaluapi

<back to all web services

UploadFieldsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/upload_fields/{Id}
"use strict";
export class UploadFieldsEditResponse {
    /** @param {{Id?:number,FieldName?:string,Required?:boolean,UploadType?:string,Label?:string,UploadSubtype?:string,IsEnabled?:boolean,SortOrder?:number,Help?:string,Placeholder?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    FieldName;
    /** @type {?boolean} */
    Required;
    /** @type {string} */
    UploadType;
    /** @type {string} */
    Label;
    /** @type {string} */
    UploadSubtype;
    /** @type {?boolean} */
    IsEnabled;
    /** @type {?number} */
    SortOrder;
    /** @type {string} */
    Help;
    /** @type {string} */
    Placeholder;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class UploadFieldsEdit {
    /** @param {{Id?:number,FieldName?:string,Required?:boolean,UploadType?:string,Label?:string,UploadSubtype?:string,IsEnabled?:boolean,SortOrder?:number,Help?:string,Placeholder?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    FieldName;
    /** @type {?boolean} */
    Required;
    /** @type {string} */
    UploadType;
    /** @type {string} */
    Label;
    /** @type {string} */
    UploadSubtype;
    /** @type {?boolean} */
    IsEnabled;
    /** @type {?number} */
    SortOrder;
    /** @type {string} */
    Help;
    /** @type {string} */
    Placeholder;
}

JavaScript UploadFieldsEdit DTOs

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.

PUT /upload_fields/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	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

{
	Id: 0,
	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
		}
	}
}