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
import Foundation
import ServiceStack

// @DataContract
public class UploadFieldsLookup : Codable
{
    // @DataMember(Order=2)
    public var fieldName:String

    // @DataMember(Order=3)
    public var required:Bool?

    // @DataMember(Order=4)
    public var uploadType:String

    // @DataMember(Order=5)
    public var label:String

    // @DataMember(Order=6)
    public var uploadSubtype:String

    // @DataMember(Order=7)
    public var isEnabled:Bool?

    // @DataMember(Order=8)
    public var sortOrder:Double?

    // @DataMember(Order=9)
    public var help:String

    // @DataMember(Order=10)
    public var placeholder:String

    required public init(){}
}


Swift 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
			}
		}
	}
]