| All Verbs | /api/timezones |
|---|
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 DataListItemModel:
# @ApiMember(DataType="Guid", Description="Guid of the list item PKID.", IsRequired=true, Name="ListItemId", ParameterType="query")
list_item_id: Optional[str] = None
"""
Guid of the list item PKID.
"""
# @ApiMember(DataType="string", Description="Name of the list item.", Name="Name", ParameterType="query")
name: Optional[str] = None
"""
Name of the list item.
"""
# @ApiMember(DataType="string", Description="Short Version Name of the list item.", Name="ShortName", ParameterType="query")
short_name: Optional[str] = None
"""
Short Version Name of the list item.
"""
# @ApiMember(DataType="string", Description="The primary image url", Name="PrimaryImagePath", ParameterType="query")
primary_image_path: Optional[str] = None
"""
The primary image url
"""
# @ApiMember(DataType="string", Description="Record Status of the List Item (A=Active, I=Inactive, D=Deleted).", Name="RecordStatus", ParameterType="query")
record_status: Optional[str] = None
"""
Record Status of the List Item (A=Active, I=Inactive, D=Deleted).
"""
# @ApiMember(DataType="int", Description="The order (if any) of this item in the list.", Name="Order", ParameterType="query")
order: int = 0
"""
The order (if any) of this item in the list.
"""
# @ApiMember(DataType="Guid", Description="The owner of this item.", Name="OwnerContactId", ParameterType="query")
owner_contact_id: Optional[str] = None
"""
The owner of this item.
"""
extra_values: Optional[List[Object]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DataListModel:
# @ApiMember(DataType="Guid", Description="Guid of the List PKID.", IsRequired=true, Name="ListId", ParameterType="query")
list_id: Optional[str] = None
"""
Guid of the List PKID.
"""
# @ApiMember(DataType="String", Description="Name of the list.", Name="Name", ParameterType="query")
name: Optional[str] = None
"""
Name of the list.
"""
# @ApiMember(DataType="Guid", Description="The owner of this item.", Name="OwnerContactId", ParameterType="query")
owner_contact_id: Optional[str] = None
"""
The owner of this item.
"""
# @ApiMember(DataType="List<DataListItemModel>", Description="List Items in the list.", Name="ListItems", ParameterType="query")
data_list_items: Optional[List[DataListItemModel]] = None
"""
List Items in the list.
"""
# @ApiResponse(Description="List of timezones matching the criteria")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTimezonesResponse:
timezones: Optional[DataListModel] = None
response_status: Optional[ResponseStatus] = None
# @Api(Description="Get a list of timezones")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetTimezones:
"""
Get a list of timezones
"""
pass
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/timezones HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetTimezones xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetTimezonesResponse 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>
<Timezones xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPI.ServiceModel">
<d2p1:DataListItems>
<d2p1:DataListItemModel>
<d2p1:_x003C_ExtraValues_x003E_k__BackingField xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:anyType />
</d2p1:_x003C_ExtraValues_x003E_k__BackingField>
<d2p1:_x003C_ListItemId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_ListItemId_x003E_k__BackingField>
<d2p1:_x003C_Name_x003E_k__BackingField>String</d2p1:_x003C_Name_x003E_k__BackingField>
<d2p1:_x003C_Order_x003E_k__BackingField>0</d2p1:_x003C_Order_x003E_k__BackingField>
<d2p1:_x003C_OwnerContactId_x003E_k__BackingField>00000000-0000-0000-0000-000000000000</d2p1:_x003C_OwnerContactId_x003E_k__BackingField>
<d2p1:_x003C_PrimaryImagePath_x003E_k__BackingField>String</d2p1:_x003C_PrimaryImagePath_x003E_k__BackingField>
<d2p1:_x003C_RecordStatus_x003E_k__BackingField>String</d2p1:_x003C_RecordStatus_x003E_k__BackingField>
<d2p1:_x003C_ShortName_x003E_k__BackingField>String</d2p1:_x003C_ShortName_x003E_k__BackingField>
</d2p1:DataListItemModel>
</d2p1:DataListItems>
<d2p1:ListId>00000000-0000-0000-0000-000000000000</d2p1:ListId>
<d2p1:Name>String</d2p1:Name>
<d2p1:OwnerContactId>00000000-0000-0000-0000-000000000000</d2p1:OwnerContactId>
</Timezones>
</GetTimezonesResponse>