Platform API

<back to all web services

GetSettings

<?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 SettingModel implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $SettingId='',
        /** @var string|null */
        public ?string $SettingName=null,
        /** @var string|null */
        public ?string $SettingValue=null
    ) {
    }

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

// @ApiResponse(Description="List of settings")
class GetSettingsResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<SettingModel>|null */
        public ?array $Settings=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class GetSettings implements JsonSerializable
{
    public function __construct(
        /** @var array<string>|null */
        public ?array $SettingIds=null
    ) {
    }

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

PHP GetSettings DTOs

POST /api/settings HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <SettingIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SettingIds>
</GetSettings>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
  <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>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
    <d2p1:SettingModel>
      <d2p1:SettingId>00000000-0000-0000-0000-000000000000</d2p1:SettingId>
      <d2p1:SettingName>String</d2p1:SettingName>
      <d2p1:SettingValue>String</d2p1:SettingValue>
    </d2p1:SettingModel>
  </Settings>
</GetSettingsResponse>