DigiOffice Gateway Web Services

<back to all web services

GetRegistrationprofileFieldStates

Requires Authentication
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

enum MessageType
{
    Information,
    Warning,
    Error,
    Success,
}

abstract class InformationMessageBase implements IInformationMessage
{
    MessageType? Type;
    String? Summary;
    String? FullMessage;
    String? FieldName;
    bool? KeepOpen;

    InformationMessageBase({this.Type,this.Summary,this.FullMessage,this.FieldName,this.KeepOpen});
    InformationMessageBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Type = JsonConverters.fromJson(json['Type'],'MessageType',context!);
        Summary = json['Summary'];
        FullMessage = json['FullMessage'];
        FieldName = json['FieldName'];
        KeepOpen = json['KeepOpen'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Type': JsonConverters.toJson(Type,'MessageType',context!),
        'Summary': Summary,
        'FullMessage': FullMessage,
        'FieldName': FieldName,
        'KeepOpen': KeepOpen
    };

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

class InformationMessages extends ListBase<InformationMessageBase> implements IInformationMessages, IConvertible
{
    final List<InformationMessageBase> l = [];
    set length(int newLength) { l.length = newLength; }
    int get length => l.length;
    InformationMessageBase operator [](int index) => l[index];
    void operator []=(int index, InformationMessageBase value) { l[index] = value; }
    InformationMessages();
    InformationMessages.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "InformationMessages";
    TypeContext? context = _ctx;
}

class RegistrationProfileFieldStateBase implements IConvertible
{
    String? DocumentFieldID;
    bool? Required;
    bool? Visible;
    bool? Readonly;

    RegistrationProfileFieldStateBase({this.DocumentFieldID,this.Required,this.Visible,this.Readonly});
    RegistrationProfileFieldStateBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentFieldID = json['DocumentFieldID'];
        Required = json['Required'];
        Visible = json['Visible'];
        Readonly = json['Readonly'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentFieldID': DocumentFieldID,
        'Required': Required,
        'Visible': Visible,
        'Readonly': Readonly
    };

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

class RegistrationProfileFieldStates implements IConvertible
{
    bool? ReadOnly;
    InformationMessages? Messages;
    List<RegistrationProfileFieldStateBase>? ControlStates;
    List<RegistrationProfileFieldStateBase>? DependentFieldsControlStates;

    RegistrationProfileFieldStates({this.ReadOnly,this.Messages,this.ControlStates,this.DependentFieldsControlStates});
    RegistrationProfileFieldStates.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ReadOnly = json['ReadOnly'];
        Messages = JsonConverters.fromJson(json['Messages'],'InformationMessages',context!);
        ControlStates = JsonConverters.fromJson(json['ControlStates'],'List<RegistrationProfileFieldStateBase>',context!);
        DependentFieldsControlStates = JsonConverters.fromJson(json['DependentFieldsControlStates'],'List<RegistrationProfileFieldStateBase>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ReadOnly': ReadOnly,
        'Messages': JsonConverters.toJson(Messages,'InformationMessages',context!),
        'ControlStates': JsonConverters.toJson(ControlStates,'List<RegistrationProfileFieldStateBase>',context!),
        'DependentFieldsControlStates': JsonConverters.toJson(DependentFieldsControlStates,'List<RegistrationProfileFieldStateBase>',context!)
    };

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

class RegistrationProfileFieldValue implements IConvertible
{
    String? DocumentFieldID;
    String? Value;
    String? ShadowValue;
    bool? IsModifiedByUser;

    RegistrationProfileFieldValue({this.DocumentFieldID,this.Value,this.ShadowValue,this.IsModifiedByUser});
    RegistrationProfileFieldValue.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentFieldID = json['DocumentFieldID'];
        Value = json['Value'];
        ShadowValue = json['ShadowValue'];
        IsModifiedByUser = json['IsModifiedByUser'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentFieldID': DocumentFieldID,
        'Value': Value,
        'ShadowValue': ShadowValue,
        'IsModifiedByUser': IsModifiedByUser
    };

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

class GetRegistrationprofileFieldStates implements IConvertible
{
    String? RegistrationprofileID;
    String? DocumentID;
    int? QueueDocumentID;
    String? StandardDocumentID;
    List<String>? RequestTriggeredByDependentDocumentFieldIds;
    List<RegistrationProfileFieldValue>? CurrentRegistrationprofileFieldValues;
    bool? IsOffice365Context;
    bool? IsOpenedFromNonDMSLocation;
    String? PidTag;

    GetRegistrationprofileFieldStates({this.RegistrationprofileID,this.DocumentID,this.QueueDocumentID,this.StandardDocumentID,this.RequestTriggeredByDependentDocumentFieldIds,this.CurrentRegistrationprofileFieldValues,this.IsOffice365Context,this.IsOpenedFromNonDMSLocation,this.PidTag});
    GetRegistrationprofileFieldStates.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RegistrationprofileID = json['RegistrationprofileID'];
        DocumentID = json['DocumentID'];
        QueueDocumentID = json['QueueDocumentID'];
        StandardDocumentID = json['StandardDocumentID'];
        RequestTriggeredByDependentDocumentFieldIds = JsonConverters.fromJson(json['RequestTriggeredByDependentDocumentFieldIds'],'List<String>',context!);
        CurrentRegistrationprofileFieldValues = JsonConverters.fromJson(json['CurrentRegistrationprofileFieldValues'],'List<RegistrationProfileFieldValue>',context!);
        IsOffice365Context = json['IsOffice365Context'];
        IsOpenedFromNonDMSLocation = json['IsOpenedFromNonDMSLocation'];
        PidTag = json['PidTag'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RegistrationprofileID': RegistrationprofileID,
        'DocumentID': DocumentID,
        'QueueDocumentID': QueueDocumentID,
        'StandardDocumentID': StandardDocumentID,
        'RequestTriggeredByDependentDocumentFieldIds': JsonConverters.toJson(RequestTriggeredByDependentDocumentFieldIds,'List<String>',context!),
        'CurrentRegistrationprofileFieldValues': JsonConverters.toJson(CurrentRegistrationprofileFieldValues,'List<RegistrationProfileFieldValue>',context!),
        'IsOffice365Context': IsOffice365Context,
        'IsOpenedFromNonDMSLocation': IsOpenedFromNonDMSLocation,
        'PidTag': PidTag
    };

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

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'MessageType': TypeInfo(TypeOf.Enum, enumValues:MessageType.values),
    'InformationMessageBase': TypeInfo(TypeOf.AbstractClass),
    'InformationMessages': TypeInfo(TypeOf.Class, create:() => InformationMessages()),
    'RegistrationProfileFieldStateBase': TypeInfo(TypeOf.Class, create:() => RegistrationProfileFieldStateBase()),
    'RegistrationProfileFieldStates': TypeInfo(TypeOf.Class, create:() => RegistrationProfileFieldStates()),
    'List<RegistrationProfileFieldStateBase>': TypeInfo(TypeOf.Class, create:() => <RegistrationProfileFieldStateBase>[]),
    'RegistrationProfileFieldValue': TypeInfo(TypeOf.Class, create:() => RegistrationProfileFieldValue()),
    'GetRegistrationprofileFieldStates': TypeInfo(TypeOf.Class, create:() => GetRegistrationprofileFieldStates()),
    'List<RegistrationProfileFieldValue>': TypeInfo(TypeOf.Class, create:() => <RegistrationProfileFieldValue>[]),
});

Dart GetRegistrationprofileFieldStates DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/GetRegistrationprofileFieldStates HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RegistrationprofileID":"00000000-0000-0000-0000-000000000000","DocumentID":"00000000-0000-0000-0000-000000000000","QueueDocumentID":0,"StandardDocumentID":"00000000-0000-0000-0000-000000000000","RequestTriggeredByDependentDocumentFieldIds":["00000000-0000-0000-0000-000000000000"],"CurrentRegistrationprofileFieldValues":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Value":"String","ShadowValue":"String","IsModifiedByUser":false}],"IsOffice365Context":false,"IsOpenedFromNonDMSLocation":false,"PidTag":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ReadOnly":false,"Messages":[{}],"ControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}],"DependentFieldsControlStates":[{"DocumentFieldID":"00000000-0000-0000-0000-000000000000","Required":false,"Visible":false,"Readonly":false}]}