DigiOffice Gateway Web Services

<back to all web services

AddMessageQueueWithSendDocumentByEmail

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue/senddocumentbyemail
import 'package:servicestack/servicestack.dart';

class AddMessageQueueResonse implements IConvertible
{
    int? ID;

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

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

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

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

class AddMessageQueueWithSendDocumentByEmail implements IConvertible
{
    String? FromProgCode;
    String? DocumentID;
    bool? TakeOverEmailAddresses;
    int? ShippingFormID;
    List<String>? LinkedDocumentIDs;

    AddMessageQueueWithSendDocumentByEmail({this.FromProgCode,this.DocumentID,this.TakeOverEmailAddresses,this.ShippingFormID,this.LinkedDocumentIDs});
    AddMessageQueueWithSendDocumentByEmail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FromProgCode = json['FromProgCode'];
        DocumentID = json['DocumentID'];
        TakeOverEmailAddresses = json['TakeOverEmailAddresses'];
        ShippingFormID = json['ShippingFormID'];
        LinkedDocumentIDs = JsonConverters.fromJson(json['LinkedDocumentIDs'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FromProgCode': FromProgCode,
        'DocumentID': DocumentID,
        'TakeOverEmailAddresses': TakeOverEmailAddresses,
        'ShippingFormID': ShippingFormID,
        'LinkedDocumentIDs': JsonConverters.toJson(LinkedDocumentIDs,'List<String>',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'digiofficeapigateway.deltares.nl', types: <String, TypeInfo> {
    'AddMessageQueueResonse': TypeInfo(TypeOf.Class, create:() => AddMessageQueueResonse()),
    'AddMessageQueueWithSendDocumentByEmail': TypeInfo(TypeOf.Class, create:() => AddMessageQueueWithSendDocumentByEmail()),
});

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

{
	FromProgCode: String,
	TakeOverEmailAddresses: False,
	ShippingFormID: 0,
	LinkedDocumentIDs: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ID: 0
}