Server

<back to all web services

GetOrderSummaries

Requires Authentication
The following routes are available for this service:
GET/OrderSummaries
<?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};


enum ProcessState : string
{
    case InProgress = 'InProgress';
    case Updating = 'Updating';
    case Creating = 'Creating';
    case Completed = 'Completed';
}

class OrderSummary implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $guid='',
        /** @var ProcessState|null */
        public ?ProcessState $processingState=null
    ) {
    }

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

class GetOrderSummariesResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<OrderSummary>|null */
        public ?array $orderSummaries=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class GetOrderSummaries implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP GetOrderSummaries 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.

GET /OrderSummaries HTTP/1.1 
Host: develop-servamw.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}