DigiOffice Gateway Web Services

AddMessageQueueWithSendDocumentByEmail

The following routes are available for this service:
POST	/api/messagequeue/senddocumentbyemail

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class AddMessageQueueResonse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        return empty($o) ? new class(){} : $o;
    }
}

class AddMessageQueueWithSendDocumentByEmail implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $FromProgCode=null,
        /** @var string */
        public string $DocumentID='',
        /** @var bool|null */
        public ?bool $TakeOverEmailAddresses=null,
        /** @var int */
        public int $ShippingFormID=0,
        /** @var array<string>|null */
        public ?array $LinkedDocumentIDs=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FromProgCode'])) $this->FromProgCode = $o['FromProgCode'];
        if (isset($o['DocumentID'])) $this->DocumentID = $o['DocumentID'];
        if (isset($o['TakeOverEmailAddresses'])) $this->TakeOverEmailAddresses = $o['TakeOverEmailAddresses'];
        if (isset($o['ShippingFormID'])) $this->ShippingFormID = $o['ShippingFormID'];
        if (isset($o['LinkedDocumentIDs'])) $this->LinkedDocumentIDs = JsonConverters::fromArray('string', $o['LinkedDocumentIDs']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FromProgCode)) $o['FromProgCode'] = $this->FromProgCode;
        if (isset($this->DocumentID)) $o['DocumentID'] = $this->DocumentID;
        if (isset($this->TakeOverEmailAddresses)) $o['TakeOverEmailAddresses'] = $this->TakeOverEmailAddresses;
        if (isset($this->ShippingFormID)) $o['ShippingFormID'] = $this->ShippingFormID;
        if (isset($this->LinkedDocumentIDs)) $o['LinkedDocumentIDs'] = JsonConverters::toArray('string', $this->LinkedDocumentIDs);
        return empty($o) ? new class(){} : $o;
    }
}

PHP 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: dogw.klokgroep.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>