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

// @DataContract
export class UploadFieldsLookup
{
    // @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<UploadFieldsLookup>) { (Object as any).assign(this, init); }
}

TypeScript UploadFieldsLookup DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}]