DigiOffice Gateway Web Services

<back to all web services

AddDocumentQueuedForRegistration

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

class DocumentQueuedForRegistrationResponse implements IConvertible
{
    int? DocumentQueuedForRegistrationID;

    DocumentQueuedForRegistrationResponse({this.DocumentQueuedForRegistrationID});
    DocumentQueuedForRegistrationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        DocumentQueuedForRegistrationID = json['DocumentQueuedForRegistrationID'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'DocumentQueuedForRegistrationID': DocumentQueuedForRegistrationID
    };

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

// @DataContract
class MetaDataField implements IConvertible
{
    // @DataMember
    String? ID;

    // @DataMember
    String? DocumentVeldID;

    // @DataMember
    String? Name;

    // @DataMember
    String? Label;

    // @DataMember
    String? Datatype;

    // @DataMember
    String? PrintLabel;

    // @DataMember
    String? Entity;

    // @DataMember
    String? PrintValue;

    // @DataMember
    String? RegistrationValue;

    // @DataMember
    String? SPSiteColumnName;

    // @DataMember
    String? ShadowName;

    // @DataMember
    String? ShadowDatatype;

    // @DataMember
    String? ShadowSPSiteColumnName;

    // @DataMember
    String? ShadowSPSiteColumnRegistrationValue;

    // @DataMember
    String? ShadowRegistrationValue;

    // @DataMember
    bool? IsKeyField;

    // @DataMember
    bool? KopierenBijNieuweVersie;

    MetaDataField({this.ID,this.DocumentVeldID,this.Name,this.Label,this.Datatype,this.PrintLabel,this.Entity,this.PrintValue,this.RegistrationValue,this.SPSiteColumnName,this.ShadowName,this.ShadowDatatype,this.ShadowSPSiteColumnName,this.ShadowSPSiteColumnRegistrationValue,this.ShadowRegistrationValue,this.IsKeyField,this.KopierenBijNieuweVersie});
    MetaDataField.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ID = json['ID'];
        DocumentVeldID = json['DocumentVeldID'];
        Name = json['Name'];
        Label = json['Label'];
        Datatype = json['Datatype'];
        PrintLabel = json['PrintLabel'];
        Entity = json['Entity'];
        PrintValue = json['PrintValue'];
        RegistrationValue = json['RegistrationValue'];
        SPSiteColumnName = json['SPSiteColumnName'];
        ShadowName = json['ShadowName'];
        ShadowDatatype = json['ShadowDatatype'];
        ShadowSPSiteColumnName = json['ShadowSPSiteColumnName'];
        ShadowSPSiteColumnRegistrationValue = json['ShadowSPSiteColumnRegistrationValue'];
        ShadowRegistrationValue = json['ShadowRegistrationValue'];
        IsKeyField = json['IsKeyField'];
        KopierenBijNieuweVersie = json['KopierenBijNieuweVersie'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ID': ID,
        'DocumentVeldID': DocumentVeldID,
        'Name': Name,
        'Label': Label,
        'Datatype': Datatype,
        'PrintLabel': PrintLabel,
        'Entity': Entity,
        'PrintValue': PrintValue,
        'RegistrationValue': RegistrationValue,
        'SPSiteColumnName': SPSiteColumnName,
        'ShadowName': ShadowName,
        'ShadowDatatype': ShadowDatatype,
        'ShadowSPSiteColumnName': ShadowSPSiteColumnName,
        'ShadowSPSiteColumnRegistrationValue': ShadowSPSiteColumnRegistrationValue,
        'ShadowRegistrationValue': ShadowRegistrationValue,
        'IsKeyField': IsKeyField,
        'KopierenBijNieuweVersie': KopierenBijNieuweVersie
    };

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

class Mailings implements IConvertible
{
    Mailings();
    Mailings.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

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

class AttachmentMailing implements IConvertible
{
    AttachmentMailing();
    AttachmentMailing.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

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

class AddDocumentQueuedForRegistration implements IConvertible
{
    String? RegistrationProfileID;
    String? FileID;
    String? Description;
    String? Note;
    String? UploadOrigin;
    String? DocumentID;
    String? RootDocumentID;
    int? AssignToUserID;
    int? AssignToGroupID;
    List<MetaDataField>? MetaData;
    Mailings? Mailings;
    List<AttachmentMailing>? AttachmentsMailings;

    AddDocumentQueuedForRegistration({this.RegistrationProfileID,this.FileID,this.Description,this.Note,this.UploadOrigin,this.DocumentID,this.RootDocumentID,this.AssignToUserID,this.AssignToGroupID,this.MetaData,this.Mailings,this.AttachmentsMailings});
    AddDocumentQueuedForRegistration.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RegistrationProfileID = json['RegistrationProfileID'];
        FileID = json['FileID'];
        Description = json['Description'];
        Note = json['Note'];
        UploadOrigin = json['UploadOrigin'];
        DocumentID = json['DocumentID'];
        RootDocumentID = json['RootDocumentID'];
        AssignToUserID = json['AssignToUserID'];
        AssignToGroupID = json['AssignToGroupID'];
        MetaData = JsonConverters.fromJson(json['MetaData'],'List<MetaDataField>',context!);
        Mailings = JsonConverters.fromJson(json['Mailings'],'Mailings',context!);
        AttachmentsMailings = JsonConverters.fromJson(json['AttachmentsMailings'],'List<AttachmentMailing>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RegistrationProfileID': RegistrationProfileID,
        'FileID': FileID,
        'Description': Description,
        'Note': Note,
        'UploadOrigin': UploadOrigin,
        'DocumentID': DocumentID,
        'RootDocumentID': RootDocumentID,
        'AssignToUserID': AssignToUserID,
        'AssignToGroupID': AssignToGroupID,
        'MetaData': JsonConverters.toJson(MetaData,'List<MetaDataField>',context!),
        'Mailings': JsonConverters.toJson(Mailings,'Mailings',context!),
        'AttachmentsMailings': JsonConverters.toJson(AttachmentsMailings,'List<AttachmentMailing>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'DocumentQueuedForRegistrationResponse': TypeInfo(TypeOf.Class, create:() => DocumentQueuedForRegistrationResponse()),
    'MetaDataField': TypeInfo(TypeOf.Class, create:() => MetaDataField()),
    'Mailings': TypeInfo(TypeOf.Class, create:() => Mailings()),
    'AttachmentMailing': TypeInfo(TypeOf.Class, create:() => AttachmentMailing()),
    'AddDocumentQueuedForRegistration': TypeInfo(TypeOf.Class, create:() => AddDocumentQueuedForRegistration()),
    'List<MetaDataField>': TypeInfo(TypeOf.Class, create:() => <MetaDataField>[]),
    'List<AttachmentMailing>': TypeInfo(TypeOf.Class, create:() => <AttachmentMailing>[]),
});

Dart AddDocumentQueuedForRegistration 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 /jsv/reply/AddDocumentQueuedForRegistration HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RegistrationProfileID: 00000000-0000-0000-0000-000000000000,
	FileID: 00000000-0000-0000-0000-000000000000,
	Description: String,
	Note: String,
	UploadOrigin: String,
	DocumentID: 00000000-0000-0000-0000-000000000000,
	RootDocumentID: 00000000-0000-0000-0000-000000000000,
	AssignToUserID: 0,
	AssignToGroupID: 0,
	MetaData: 
	[
		{
			ID: 00000000-0000-0000-0000-000000000000,
			DocumentVeldID: 00000000-0000-0000-0000-000000000000,
			Name: String,
			Label: String,
			Datatype: String,
			PrintLabel: String,
			Entity: String,
			PrintValue: String,
			RegistrationValue: String,
			SPSiteColumnName: String,
			ShadowName: String,
			ShadowDatatype: String,
			ShadowSPSiteColumnName: String,
			ShadowSPSiteColumnRegistrationValue: String,
			ShadowRegistrationValue: String,
			IsKeyField: False,
			KopierenBijNieuweVersie: False
		}
	],
	Mailings: {},
	AttachmentsMailings: 
	[
		{
			
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	DocumentQueuedForRegistrationID: 0
}