digitaluapi

<back to all web services

Requests

Requires Authentication
Requires any of the roles:Client, Admin, Partner
<?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};


// @DataContract
class MetaParseUpload implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $Data=null
    ) {
    }

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

/**
 * @template array of MetaParseUpload
 */
class CSVRequestsArrResponse extends \ArrayObject implements JsonSerializable
{
    public function __construct(MetaParseUpload ...$items) {
        parent::__construct($items, \ArrayObject::STD_PROP_LIST);
    }
    
    /** @throws \Exception */
    public function append($value): void {
        if ($value instanceof MetaParseUpload)
            parent::append($value);
        else
            throw new \Exception("Can only append a MetaParseUpload to " . __CLASS__);
    }
    
    /** @throws Exception */
    public function fromMap($o): void {
        foreach ($o as $item) {
            $el = new MetaParseUpload();
            $el->fromMap($item);
            $this->append($el);
        }
    }
    
    /** @throws Exception */
    public function jsonSerialize(): array {
        return parent::getArrayCopy();
    }
}

/**
 * @template array of String
 * @template array1 of String
 */
class JsonObject extends array implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

class CSVErrors implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $type=null,
        /** @var string|null */
        public ?string $code=null,
        /** @var string|null */
        public ?string $message=null,
        /** @var string|null */
        public ?string $row=null
    ) {
    }

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

class CSVRequestsArr implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $BatchId=0,
        /** @var JsonObject|null */
        public ?JsonObject $Data=null,
        /** @var CSVErrors[]|null */
        public ?array $Errors=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['BatchId'])) $this->BatchId = $o['BatchId'];
        if (isset($o['Data'])) $this->Data = JsonConverters::from('JsonObject', $o['Data']);
        if (isset($o['Errors'])) $this->Errors = JsonConverters::fromArray('CSVErrors', $o['Errors']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->BatchId)) $o['BatchId'] = $this->BatchId;
        if (isset($this->Data)) $o['Data'] = JsonConverters::to('JsonObject', $this->Data);
        if (isset($this->Errors)) $o['Errors'] = JsonConverters::toArray('CSVErrors', $this->Errors);
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template array of CSVRequestsArr
 */
class Requests extends \ArrayObject implements JsonSerializable
{
    public function __construct(CSVRequestsArr ...$items) {
        parent::__construct($items, \ArrayObject::STD_PROP_LIST);
    }
    
    /** @throws \Exception */
    public function append($value): void {
        if ($value instanceof CSVRequestsArr)
            parent::append($value);
        else
            throw new \Exception("Can only append a CSVRequestsArr to " . __CLASS__);
    }
    
    /** @throws Exception */
    public function fromMap($o): void {
        foreach ($o as $item) {
            $el = new CSVRequestsArr();
            $el->fromMap($item);
            $this->append($el);
        }
    }
    
    /** @throws Exception */
    public function jsonSerialize(): array {
        return parent::getArrayCopy();
    }
}

PHP Requests 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/Requests HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ArrayOfCSVRequestsArr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfMetaParseUpload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel" />