DigiOffice Gateway Web Services

<back to all web services

AddBlobFile

Requires Authentication
<?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 AddBlobFileResponse implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $BlobFileID=''
    ) {
    }

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

// @DataContract
class AddBlobFile implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string|null */
        public ?string $FileName=null,

        // @DataMember
        /** @var string|null */
        public ?string $Type=null,

        // @DataMember
        /** @var ByteArray|null */
        public ?ByteArray $Image=null,

        // @DataMember
        /** @var string|null */
        public ?string $ExternalID=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['FileName'])) $this->FileName = $o['FileName'];
        if (isset($o['Type'])) $this->Type = $o['Type'];
        if (isset($o['Image'])) $this->Image = JsonConverters::from('ByteArray', $o['Image']);
        if (isset($o['ExternalID'])) $this->ExternalID = $o['ExternalID'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->FileName)) $o['FileName'] = $this->FileName;
        if (isset($this->Type)) $o['Type'] = $this->Type;
        if (isset($this->Image)) $o['Image'] = JsonConverters::to('ByteArray', $this->Image);
        if (isset($this->ExternalID)) $o['ExternalID'] = $this->ExternalID;
        return empty($o) ? new class(){} : $o;
    }
}

PHP AddBlobFile 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 /xml/reply/AddBlobFile HTTP/1.1 
Host: dogw.klokgroep.nl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddBlobFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <ExternalID>String</ExternalID>
  <FileName>String</FileName>
  <Image>AA==</Image>
  <Type>String</Type>
</AddBlobFile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddBlobFileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDB.API.DTO.Document.Operations">
  <BlobFileID>00000000-0000-0000-0000-000000000000</BlobFileID>
</AddBlobFileResponse>