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';
import 'dart:typed_data';

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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AddMessageQueueWithSendDocumentByEmail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Messaging.Operations">
  <DocumentID>00000000-0000-0000-0000-000000000000</DocumentID>
  <FromProgCode>String</FromProgCode>
  <LinkedDocumentIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </LinkedDocumentIDs>
  <ShippingFormID>0</ShippingFormID>
  <TakeOverEmailAddresses>false</TakeOverEmailAddresses>
</AddMessageQueueWithSendDocumentByEmail>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddMessageQueueResonse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Messaging">
  <ID>0</ID>
</AddMessageQueueResonse>