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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class UploadFieldsAdd
    {
        @DataMember(Order=2)
        public String FieldName = null;

        @DataMember(Order=3)
        public Boolean Required = null;

        @DataMember(Order=4)
        public String UploadType = null;

        @DataMember(Order=5)
        public String Label = null;

        @DataMember(Order=6)
        public String UploadSubtype = null;

        @DataMember(Order=7)
        public Boolean IsEnabled = null;

        @DataMember(Order=8)
        public Double SortOrder = null;

        @DataMember(Order=9)
        public String Help = null;

        @DataMember(Order=10)
        public String Placeholder = null;
        
        public String getFieldName() { return FieldName; }
        public UploadFieldsAdd setFieldName(String value) { this.FieldName = value; return this; }
        public Boolean isRequired() { return Required; }
        public UploadFieldsAdd setRequired(Boolean value) { this.Required = value; return this; }
        public String getUploadType() { return UploadType; }
        public UploadFieldsAdd setUploadType(String value) { this.UploadType = value; return this; }
        public String getLabel() { return Label; }
        public UploadFieldsAdd setLabel(String value) { this.Label = value; return this; }
        public String getUploadSubtype() { return UploadSubtype; }
        public UploadFieldsAdd setUploadSubtype(String value) { this.UploadSubtype = value; return this; }
        public Boolean getIsEnabled() { return IsEnabled; }
        public UploadFieldsAdd setIsEnabled(Boolean value) { this.IsEnabled = value; return this; }
        public Double getSortOrder() { return SortOrder; }
        public UploadFieldsAdd setSortOrder(Double value) { this.SortOrder = value; return this; }
        public String getHelp() { return Help; }
        public UploadFieldsAdd setHelp(String value) { this.Help = value; return this; }
        public String getPlaceholder() { return Placeholder; }
        public UploadFieldsAdd setPlaceholder(String value) { this.Placeholder = value; return this; }
    }

    public static class UploadFieldsAddResponse
    {
        @DataMember(Order=2)
        public String FieldName = null;

        @DataMember(Order=3)
        public Boolean Required = null;

        @DataMember(Order=4)
        public String UploadType = null;

        @DataMember(Order=5)
        public String Label = null;

        @DataMember(Order=6)
        public String UploadSubtype = null;

        @DataMember(Order=7)
        public Boolean IsEnabled = null;

        @DataMember(Order=8)
        public Double SortOrder = null;

        @DataMember(Order=9)
        public String Help = null;

        @DataMember(Order=10)
        public String Placeholder = null;

        @DataMember(Order=12)
        public ResponseStatus ResponseStatus = null;
        
        public String getFieldName() { return FieldName; }
        public UploadFieldsAddResponse setFieldName(String value) { this.FieldName = value; return this; }
        public Boolean isRequired() { return Required; }
        public UploadFieldsAddResponse setRequired(Boolean value) { this.Required = value; return this; }
        public String getUploadType() { return UploadType; }
        public UploadFieldsAddResponse setUploadType(String value) { this.UploadType = value; return this; }
        public String getLabel() { return Label; }
        public UploadFieldsAddResponse setLabel(String value) { this.Label = value; return this; }
        public String getUploadSubtype() { return UploadSubtype; }
        public UploadFieldsAddResponse setUploadSubtype(String value) { this.UploadSubtype = value; return this; }
        public Boolean getIsEnabled() { return IsEnabled; }
        public UploadFieldsAddResponse setIsEnabled(Boolean value) { this.IsEnabled = value; return this; }
        public Double getSortOrder() { return SortOrder; }
        public UploadFieldsAddResponse setSortOrder(Double value) { this.SortOrder = value; return this; }
        public String getHelp() { return Help; }
        public UploadFieldsAddResponse setHelp(String value) { this.Help = value; return this; }
        public String getPlaceholder() { return Placeholder; }
        public UploadFieldsAddResponse setPlaceholder(String value) { this.Placeholder = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public UploadFieldsAddResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java UploadFieldsAdd 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.

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