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}

export class UploadFieldsEditResponse
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public FieldName: string;

    // @DataMember(Order=3)
    public Required?: boolean;

    // @DataMember(Order=4)
    public UploadType: string;

    // @DataMember(Order=5)
    public Label: string;

    // @DataMember(Order=6)
    public UploadSubtype: string;

    // @DataMember(Order=7)
    public IsEnabled?: boolean;

    // @DataMember(Order=8)
    public SortOrder?: number;

    // @DataMember(Order=9)
    public Help: string;

    // @DataMember(Order=10)
    public Placeholder: string;

    // @DataMember(Order=12)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<UploadFieldsEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class UploadFieldsEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Id: number;

    // @DataMember(Order=2)
    public FieldName: string;

    // @DataMember(Order=3)
    public Required?: boolean;

    // @DataMember(Order=4)
    public UploadType: string;

    // @DataMember(Order=5)
    public Label: string;

    // @DataMember(Order=6)
    public UploadSubtype: string;

    // @DataMember(Order=7)
    public IsEnabled?: boolean;

    // @DataMember(Order=8)
    public SortOrder?: number;

    // @DataMember(Order=9)
    public Help: string;

    // @DataMember(Order=10)
    public Placeholder: string;

    public constructor(init?: Partial<UploadFieldsEdit>) { (Object as any).assign(this, init); }
}

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