Test

<back to all web services

HelloWithEnumMap

<?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 EnumType : string
{
    case Value1 = 'Value1';
    case Value2 = 'Value2';
    case Value3 = 'Value3';
}

enum EnumWithValues : string
{
    case None = 'None';
    case Value1 = 'Member 1';
    case Value2 = 'Value2';
}

// @Flags()
enum EnumFlags : int
{
    case Value0 = 0;
    case Value1 = 1;
    case Value2 = 2;
    case Value3 = 4;
    case Value123 = 7;
}

enum EnumStyle : string
{
    case lower = 'lower';
    case UPPER = 'UPPER';
    case PascalCase = 'PascalCase';
    case camelCase = 'camelCase';
    case camelUPPER = 'camelUPPER';
    case PascalUPPER = 'PascalUPPER';
}

class HelloWithEnumMap implements JsonSerializable
{
    public function __construct(
        /** @var array<string,EnumType>|null */
        public ?array $enumProp=null,
        /** @var array<string,EnumWithValues>|null */
        public ?array $enumWithValues=null,
        /** @var array<string,EnumType>|null */
        public ?array $nullableEnumProp=null,
        /** @var array<string,EnumFlags>|null */
        public ?array $enumFlags=null,
        /** @var array<string,EnumStyle>|null */
        public ?array $enumStyle=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['enumProp'])) $this->enumProp = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['EnumType','EnumType']), $o['enumProp']);
        if (isset($o['enumWithValues'])) $this->enumWithValues = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['EnumWithValues','EnumWithValues']), $o['enumWithValues']);
        if (isset($o['nullableEnumProp'])) $this->nullableEnumProp = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['Nullable<EnumType>','Nullable<EnumType>']), $o['nullableEnumProp']);
        if (isset($o['enumFlags'])) $this->enumFlags = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['EnumFlags','EnumFlags']), $o['enumFlags']);
        if (isset($o['enumStyle'])) $this->enumStyle = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['EnumStyle','EnumStyle']), $o['enumStyle']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->enumProp)) $o['enumProp'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['EnumType','EnumType']), $this->enumProp);
        if (isset($this->enumWithValues)) $o['enumWithValues'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['EnumWithValues','EnumWithValues']), $this->enumWithValues);
        if (isset($this->nullableEnumProp)) $o['nullableEnumProp'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['Nullable<EnumType>','Nullable<EnumType>']), $this->nullableEnumProp);
        if (isset($this->enumFlags)) $o['enumFlags'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['EnumFlags','EnumFlags']), $this->enumFlags);
        if (isset($this->enumStyle)) $o['enumStyle'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['EnumStyle','EnumStyle']), $this->enumStyle);
        return empty($o) ? new class(){} : $o;
    }
}

PHP HelloWithEnumMap 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/oneway/HelloWithEnumMap HTTP/1.1 
Host: test.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HelloWithEnumMap xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceModel">
  <EnumFlags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfEnumFlagsEnumFlagsIKzD6DHq>
      <d2p1:Key>Value0</d2p1:Key>
      <d2p1:Value>Value0</d2p1:Value>
    </d2p1:KeyValueOfEnumFlagsEnumFlagsIKzD6DHq>
  </EnumFlags>
  <EnumProp xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfEnumTypeEnumTypeIKzD6DHq>
      <d2p1:Key>Value1</d2p1:Key>
      <d2p1:Value>Value1</d2p1:Value>
    </d2p1:KeyValueOfEnumTypeEnumTypeIKzD6DHq>
  </EnumProp>
  <EnumStyle xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfEnumStyleEnumStyleIKzD6DHq>
      <d2p1:Key>lower</d2p1:Key>
      <d2p1:Value>lower</d2p1:Value>
    </d2p1:KeyValueOfEnumStyleEnumStyleIKzD6DHq>
  </EnumStyle>
  <EnumWithValues xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfEnumWithValuesEnumWithValuesIKzD6DHq>
      <d2p1:Key>None</d2p1:Key>
      <d2p1:Value>None</d2p1:Value>
    </d2p1:KeyValueOfEnumWithValuesEnumWithValuesIKzD6DHq>
  </EnumWithValues>
  <NullableEnumProp xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfNullableOfEnumTypep_S_PBaRK1NullableOfEnumTypep_S_PBaRK1_ShTDFhl_P>
      <d2p1:Key>Value1</d2p1:Key>
      <d2p1:Value>Value1</d2p1:Value>
    </d2p1:KeyValueOfNullableOfEnumTypep_S_PBaRK1NullableOfEnumTypep_S_PBaRK1_ShTDFhl_P>
  </NullableEnumProp>
</HelloWithEnumMap>