Test

<back to all web services

HelloAllTypes

The following routes are available for this service:
All Verbs/all-types
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubType:
    id: int = 0
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AllTypes:
    id: int = 0
    nullable_id: Optional[int] = None
    byte: int = 0
    short: int = 0
    int_: int = field(metadata=config(field_name='int'), default=0)
    long: int = 0
    u_short: int = 0
    u_int: int = 0
    u_long: int = 0
    float_: float = field(metadata=config(field_name='float'), default=0.0)
    double: float = 0.0
    decimal: Decimal = decimal.Decimal(0)
    string: Optional[str] = None
    date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    time_span: datetime.timedelta = datetime.timedelta()
    date_time_offset: datetime.datetime = datetime.datetime(1, 1, 1)
    guid: Optional[str] = None
    char: Optional[str] = None
    key_value_pair: Optional[KeyValuePair[str, str]] = None
    nullable_date_time: Optional[datetime.datetime] = None
    nullable_time_span: Optional[datetime.timedelta] = None
    string_list: Optional[List[str]] = None
    string_array: Optional[List[str]] = None
    string_map: Optional[Dict[str, str]] = None
    int_string_map: Optional[Dict[int, str]] = None
    sub_type: Optional[SubType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Poco:
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AllCollectionTypes:
    int_array: Optional[List[int]] = None
    int_list: Optional[List[int]] = None
    string_array: Optional[List[str]] = None
    string_list: Optional[List[str]] = None
    float_array: Optional[List[float]] = None
    double_list: Optional[List[float]] = None
    byte_array: Optional[bytes] = None
    char_array: Optional[List[str]] = None
    decimal_list: Optional[List[Decimal]] = None
    poco_array: Optional[List[Poco]] = None
    poco_list: Optional[List[Poco]] = None
    poco_lookup: Optional[Dict[str, List[Poco]]] = None
    poco_lookup_map: Optional[Dict[str, List[Dict[str, Poco]]]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HelloAllTypes:
    name: Optional[str] = None
    all_types: Optional[AllTypes] = None
    all_collection_types: Optional[AllCollectionTypes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HelloAllTypesResponse:
    result: Optional[str] = None
    all_types: Optional[AllTypes] = None
    all_collection_types: Optional[AllCollectionTypes] = None

Python HelloAllTypes 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 /all-types HTTP/1.1 
Host: test.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HelloAllTypes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceModel">
  <AllCollectionTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Test.ServiceModel.Types">
    <d2p1:ByteArray>AA==</d2p1:ByteArray>
    <d2p1:CharArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:char>0</d3p1:char>
    </d2p1:CharArray>
    <d2p1:DecimalList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:decimal>0</d3p1:decimal>
    </d2p1:DecimalList>
    <d2p1:DoubleList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:double>0</d3p1:double>
    </d2p1:DoubleList>
    <d2p1:FloatArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:float>0</d3p1:float>
    </d2p1:FloatArray>
    <d2p1:IntArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:IntArray>
    <d2p1:IntList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:IntList>
    <d2p1:PocoArray>
      <d2p1:Poco>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Poco>
    </d2p1:PocoArray>
    <d2p1:PocoList>
      <d2p1:Poco>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Poco>
    </d2p1:PocoList>
    <d2p1:PocoLookup xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfPocoSxVl28_Sd>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d2p1:Poco>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:Poco>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfPocoSxVl28_Sd>
    </d2p1:PocoLookup>
    <d2p1:PocoLookupMap xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringPocoSxVl28_Sdty7Ep6D1>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d3p1:ArrayOfKeyValueOfstringPocoSxVl28_Sd>
            <d3p1:KeyValueOfstringPocoSxVl28_Sd>
              <d3p1:Key>String</d3p1:Key>
              <d3p1:Value>
                <d2p1:Name>String</d2p1:Name>
              </d3p1:Value>
            </d3p1:KeyValueOfstringPocoSxVl28_Sd>
          </d3p1:ArrayOfKeyValueOfstringPocoSxVl28_Sd>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringPocoSxVl28_Sdty7Ep6D1>
    </d2p1:PocoLookupMap>
    <d2p1:StringArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringArray>
    <d2p1:StringList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringList>
  </AllCollectionTypes>
  <AllTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Test.ServiceModel.Types">
    <d2p1:Byte>0</d2p1:Byte>
    <d2p1:Char>0</d2p1:Char>
    <d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
    <d2p1:DateTimeOffset xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:DateTimeOffset>
    <d2p1:Decimal>0</d2p1:Decimal>
    <d2p1:Double>0</d2p1:Double>
    <d2p1:Float>0</d2p1:Float>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Int>0</d2p1:Int>
    <d2p1:IntStringMap xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>0</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </d2p1:IntStringMap>
    <d2p1:KeyValuePair xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>String</d3p1:key>
      <d3p1:value>String</d3p1:value>
    </d2p1:KeyValuePair>
    <d2p1:Long>0</d2p1:Long>
    <d2p1:NullableDateTime>0001-01-01T00:00:00</d2p1:NullableDateTime>
    <d2p1:NullableId>0</d2p1:NullableId>
    <d2p1:NullableTimeSpan>PT0S</d2p1:NullableTimeSpan>
    <d2p1:Short>0</d2p1:Short>
    <d2p1:String>String</d2p1:String>
    <d2p1:StringArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringArray>
    <d2p1:StringList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringList>
    <d2p1:StringMap 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:StringMap>
    <d2p1:SubType>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:SubType>
    <d2p1:TimeSpan>PT0S</d2p1:TimeSpan>
    <d2p1:UInt>0</d2p1:UInt>
    <d2p1:ULong>0</d2p1:ULong>
    <d2p1:UShort>0</d2p1:UShort>
  </AllTypes>
  <Name>String</Name>
</HelloAllTypes>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HelloAllTypesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceModel">
  <AllCollectionTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Test.ServiceModel.Types">
    <d2p1:ByteArray>AA==</d2p1:ByteArray>
    <d2p1:CharArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:char>0</d3p1:char>
    </d2p1:CharArray>
    <d2p1:DecimalList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:decimal>0</d3p1:decimal>
    </d2p1:DecimalList>
    <d2p1:DoubleList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:double>0</d3p1:double>
    </d2p1:DoubleList>
    <d2p1:FloatArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:float>0</d3p1:float>
    </d2p1:FloatArray>
    <d2p1:IntArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:IntArray>
    <d2p1:IntList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:IntList>
    <d2p1:PocoArray>
      <d2p1:Poco>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Poco>
    </d2p1:PocoArray>
    <d2p1:PocoList>
      <d2p1:Poco>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:Poco>
    </d2p1:PocoList>
    <d2p1:PocoLookup xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfPocoSxVl28_Sd>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d2p1:Poco>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:Poco>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfPocoSxVl28_Sd>
    </d2p1:PocoLookup>
    <d2p1:PocoLookupMap xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringPocoSxVl28_Sdty7Ep6D1>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>
          <d3p1:ArrayOfKeyValueOfstringPocoSxVl28_Sd>
            <d3p1:KeyValueOfstringPocoSxVl28_Sd>
              <d3p1:Key>String</d3p1:Key>
              <d3p1:Value>
                <d2p1:Name>String</d2p1:Name>
              </d3p1:Value>
            </d3p1:KeyValueOfstringPocoSxVl28_Sd>
          </d3p1:ArrayOfKeyValueOfstringPocoSxVl28_Sd>
        </d3p1:Value>
      </d3p1:KeyValueOfstringArrayOfArrayOfKeyValueOfstringPocoSxVl28_Sdty7Ep6D1>
    </d2p1:PocoLookupMap>
    <d2p1:StringArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringArray>
    <d2p1:StringList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringList>
  </AllCollectionTypes>
  <AllTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/Test.ServiceModel.Types">
    <d2p1:Byte>0</d2p1:Byte>
    <d2p1:Char>0</d2p1:Char>
    <d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
    <d2p1:DateTimeOffset xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:DateTimeOffset>
    <d2p1:Decimal>0</d2p1:Decimal>
    <d2p1:Double>0</d2p1:Double>
    <d2p1:Float>0</d2p1:Float>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Int>0</d2p1:Int>
    <d2p1:IntStringMap xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfintstring>
        <d3p1:Key>0</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfintstring>
    </d2p1:IntStringMap>
    <d2p1:KeyValuePair xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
      <d3p1:key>String</d3p1:key>
      <d3p1:value>String</d3p1:value>
    </d2p1:KeyValuePair>
    <d2p1:Long>0</d2p1:Long>
    <d2p1:NullableDateTime>0001-01-01T00:00:00</d2p1:NullableDateTime>
    <d2p1:NullableId>0</d2p1:NullableId>
    <d2p1:NullableTimeSpan>PT0S</d2p1:NullableTimeSpan>
    <d2p1:Short>0</d2p1:Short>
    <d2p1:String>String</d2p1:String>
    <d2p1:StringArray xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringArray>
    <d2p1:StringList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:StringList>
    <d2p1:StringMap 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:StringMap>
    <d2p1:SubType>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:SubType>
    <d2p1:TimeSpan>PT0S</d2p1:TimeSpan>
    <d2p1:UInt>0</d2p1:UInt>
    <d2p1:ULong>0</d2p1:ULong>
    <d2p1:UShort>0</d2p1:UShort>
  </AllTypes>
  <Result>String</Result>
</HelloAllTypesResponse>