Server

<back to all web services

GetOrderDescriptors

Requires Authentication
The following routes are available for this service:
GET/App/{UserId}/GetOrderDescriptors
<?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 Eras2AppServiceModelBase implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="UserId")
        /** @var string */
        public string $UserId=''
    ) {
    }

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

// @DataContract
class OrderDescriptor implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="AuftragGuid")
        /** @var string */
        public string $AuftragGuid='',

        // @DataMember(Name="AbrechnungseinheitGuid")
        /** @var string */
        public string $AbrechnungseinheitGuid='',

        // @DataMember(Name="NutzeinheitGuids")
        /** @var array<string>|null */
        public ?array $NutzeinheitGuids=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AuftragGuid'])) $this->AuftragGuid = $o['AuftragGuid'];
        if (isset($o['AbrechnungseinheitGuid'])) $this->AbrechnungseinheitGuid = $o['AbrechnungseinheitGuid'];
        if (isset($o['NutzeinheitGuids'])) $this->NutzeinheitGuids = JsonConverters::fromArray('Guid', $o['NutzeinheitGuids']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AuftragGuid)) $o['AuftragGuid'] = $this->AuftragGuid;
        if (isset($this->AbrechnungseinheitGuid)) $o['AbrechnungseinheitGuid'] = $this->AbrechnungseinheitGuid;
        if (isset($this->NutzeinheitGuids)) $o['NutzeinheitGuids'] = JsonConverters::toArray('Guid', $this->NutzeinheitGuids);
        return empty($o) ? new class(){} : $o;
    }
}

class GetOrderDescriptorsResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Name="OrderDescriptors")
        /** @var array<OrderDescriptor>|null */
        public ?array $OrderDescriptors=null,

        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

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

// @DataContract
class GetOrderDescriptors extends Eras2AppServiceModelBase implements JsonSerializable
{
    /**
     * @param string $UserId
     */
    public function __construct(
        string $UserId=''
    ) {
        parent::__construct($UserId);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

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

GET /App/{UserId}/GetOrderDescriptors HTTP/1.1 
Host: mi-waerme-servamw.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetOrderDescriptorsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Amw.Service.Server.ServiceModel.Eras2App.Get">
  <OrderDescriptors i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetOrderDescriptorsResponse>