Test

<back to all web services

AllTypes

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

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

<AllTypes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceModel.Types">
  <Byte>0</Byte>
  <Char>0</Char>
  <DateTime>0001-01-01T00:00:00</DateTime>
  <DateTimeOffset xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateTimeOffset>
  <Decimal>0</Decimal>
  <Double>0</Double>
  <Float>0</Float>
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <Id>0</Id>
  <Int>0</Int>
  <IntStringMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </IntStringMap>
  <KeyValuePair xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>String</d2p1:key>
    <d2p1:value>String</d2p1:value>
  </KeyValuePair>
  <Long>0</Long>
  <NullableDateTime>0001-01-01T00:00:00</NullableDateTime>
  <NullableId>0</NullableId>
  <NullableTimeSpan>PT0S</NullableTimeSpan>
  <Short>0</Short>
  <String>String</String>
  <StringArray xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StringArray>
  <StringList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StringList>
  <StringMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </StringMap>
  <SubType>
    <Id>0</Id>
    <Name>String</Name>
  </SubType>
  <TimeSpan>PT0S</TimeSpan>
  <UInt>0</UInt>
  <ULong>0</ULong>
  <UShort>0</UShort>
</AllTypes>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AllTypes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Test.ServiceModel.Types">
  <Byte>0</Byte>
  <Char>0</Char>
  <DateTime>0001-01-01T00:00:00</DateTime>
  <DateTimeOffset xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateTimeOffset>
  <Decimal>0</Decimal>
  <Double>0</Double>
  <Float>0</Float>
  <Guid>00000000-0000-0000-0000-000000000000</Guid>
  <Id>0</Id>
  <Int>0</Int>
  <IntStringMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </IntStringMap>
  <KeyValuePair xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:key>String</d2p1:key>
    <d2p1:value>String</d2p1:value>
  </KeyValuePair>
  <Long>0</Long>
  <NullableDateTime>0001-01-01T00:00:00</NullableDateTime>
  <NullableId>0</NullableId>
  <NullableTimeSpan>PT0S</NullableTimeSpan>
  <Short>0</Short>
  <String>String</String>
  <StringArray xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StringArray>
  <StringList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StringList>
  <StringMap xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </StringMap>
  <SubType>
    <Id>0</Id>
    <Name>String</Name>
  </SubType>
  <TimeSpan>PT0S</TimeSpan>
  <UInt>0</UInt>
  <ULong>0</ULong>
  <UShort>0</UShort>
</AllTypes>