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 'package:servicestack/servicestack.dart';
import 'dart:collection';

// @DataContract
class UploadFieldsLookup implements IConvertible
{
    // @DataMember(Order=2)
    String? FieldName;

    // @DataMember(Order=3)
    bool? Required;

    // @DataMember(Order=4)
    String? UploadType;

    // @DataMember(Order=5)
    String? Label;

    // @DataMember(Order=6)
    String? UploadSubtype;

    // @DataMember(Order=7)
    bool? IsEnabled;

    // @DataMember(Order=8)
    double? SortOrder;

    // @DataMember(Order=9)
    String? Help;

    // @DataMember(Order=10)
    String? Placeholder;

    UploadFieldsLookup({this.FieldName,this.Required,this.UploadType,this.Label,this.UploadSubtype,this.IsEnabled,this.SortOrder,this.Help,this.Placeholder});
    UploadFieldsLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FieldName = json['FieldName'];
        Required = json['Required'];
        UploadType = json['UploadType'];
        Label = json['Label'];
        UploadSubtype = json['UploadSubtype'];
        IsEnabled = json['IsEnabled'];
        SortOrder = JsonConverters.toDouble(json['SortOrder']);
        Help = json['Help'];
        Placeholder = json['Placeholder'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FieldName': FieldName,
        'Required': Required,
        'UploadType': UploadType,
        'Label': Label,
        'UploadSubtype': UploadSubtype,
        'IsEnabled': IsEnabled,
        'SortOrder': SortOrder,
        'Help': Help,
        'Placeholder': Placeholder
    };

    getTypeName() => "UploadFieldsLookup";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'UploadFieldsLookup': TypeInfo(TypeOf.Class, create:() => UploadFieldsLookup()),
});

Dart 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"}}}]