DigiOffice Gateway Web Services

<back to all web services

AddMessageQueue

Requires Authentication
The following routes are available for this service:
POST/api/messagequeue
<?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 AddMessageQueue implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $FromProgCode=null,
        /** @var string|null */
        public ?string $ToProgCode=null,
        /** @var string|null */
        public ?string $Xml=null
    ) {
    }

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

PHP AddMessageQueue DTOs

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

HTTP + CSV

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

POST /api/messagequeue HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FromProgCode":"String","ToProgCode":"String","Xml":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ID":0}