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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	name: String,
	allTypes: 
	{
		id: 0,
		nullableId: 0,
		byte: 0,
		short: 0,
		int: 0,
		long: 0,
		uShort: 0,
		uInt: 0,
		uLong: 0,
		float: 0,
		double: 0,
		decimal: 0,
		string: String,
		dateTime: 0001-01-01,
		timeSpan: PT0S,
		dateTimeOffset: 0001-01-01T00:00:00.0000000+00:00,
		guid: 00000000000000000000000000000000,
		char: ,
		keyValuePair: 
		{
			key: String,
			value: String
		},
		nullableDateTime: 0001-01-01,
		nullableTimeSpan: PT0S,
		stringList: 
		[
			String
		],
		stringArray: 
		[
			String
		],
		stringMap: 
		{
			String: String
		},
		intStringMap: 
		{
			0: String
		},
		subType: 
		{
			id: 0,
			name: String
		}
	},
	allCollectionTypes: 
	{
		intArray: 
		[
			0
		],
		intList: 
		[
			0
		],
		stringArray: 
		[
			String
		],
		stringList: 
		[
			String
		],
		floatArray: 
		[
			0
		],
		doubleList: 
		[
			0
		],
		byteArray: AA==,
		charArray: 
		[
			
		],
		decimalList: 
		[
			0
		],
		pocoArray: 
		[
			{
				name: String
			}
		],
		pocoList: 
		[
			{
				name: String
			}
		],
		pocoLookup: 
		{
			String: 
			[
				{
					name: String
				}
			]
		},
		pocoLookupMap: 
		{
			String: 
			[
				{
					String: 
					{
						name: String
					}
				}
			]
		}
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: String,
	allTypes: 
	{
		id: 0,
		nullableId: 0,
		byte: 0,
		short: 0,
		int: 0,
		long: 0,
		uShort: 0,
		uInt: 0,
		uLong: 0,
		float: 0,
		double: 0,
		decimal: 0,
		string: String,
		dateTime: 0001-01-01,
		timeSpan: PT0S,
		dateTimeOffset: 0001-01-01T00:00:00.0000000+00:00,
		guid: 00000000000000000000000000000000,
		char: ,
		keyValuePair: 
		{
			key: String,
			value: String
		},
		nullableDateTime: 0001-01-01,
		nullableTimeSpan: PT0S,
		stringList: 
		[
			String
		],
		stringArray: 
		[
			String
		],
		stringMap: 
		{
			String: String
		},
		intStringMap: 
		{
			0: String
		},
		subType: 
		{
			id: 0,
			name: String
		}
	},
	allCollectionTypes: 
	{
		intArray: 
		[
			0
		],
		intList: 
		[
			0
		],
		stringArray: 
		[
			String
		],
		stringList: 
		[
			String
		],
		floatArray: 
		[
			0
		],
		doubleList: 
		[
			0
		],
		byteArray: AA==,
		charArray: 
		[
			
		],
		decimalList: 
		[
			0
		],
		pocoArray: 
		[
			{
				name: String
			}
		],
		pocoList: 
		[
			{
				name: String
			}
		],
		pocoLookup: 
		{
			String: 
			[
				{
					name: String
				}
			]
		},
		pocoLookupMap: 
		{
			String: 
			[
				{
					String: 
					{
						name: String
					}
				}
			]
		}
	}
}