digitaluapi

<back to all web services

UploadFieldsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/upload_fields
"use strict";
export class UploadFieldsLookup {
    /** @param {{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 {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 UploadFieldsLookup 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.

GET /upload_fields HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
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
			}
		}
	}
]