Platform API

GetTimezones

Get a list of timezones

The following routes are available for this service:
All Verbs	/api/timezones

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eros.Subtle.Canvara.WebAPIModel.ServiceModel
Imports Eros.Saguna.Common.WebAPI.ServiceModel

Namespace Global

    Namespace Eros.Saguna.Common.WebAPI.ServiceModel

        Public Partial Class DataListItemModel
            '''<Summary>
            '''Guid of the list item PKID.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the list item PKID.", IsRequired:=true, Name:="ListItemId", ParameterType:="query")>
            Public Overridable Property ListItemId As Guid

            '''<Summary>
            '''Name of the list item.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Name of the list item.", Name:="Name", ParameterType:="query")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Short Version Name of the list item.
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Short Version Name of the list item.", Name:="ShortName", ParameterType:="query")>
            Public Overridable Property ShortName As String

            '''<Summary>
            '''The primary image url
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The primary image url", Name:="PrimaryImagePath", ParameterType:="query")>
            Public Overridable Property PrimaryImagePath As String

            '''<Summary>
            '''Record Status of the List Item (A=Active, I=Inactive, D=Deleted).
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Record Status of the List Item (A=Active, I=Inactive, D=Deleted).", Name:="RecordStatus", ParameterType:="query")>
            Public Overridable Property RecordStatus As String

            '''<Summary>
            '''The order (if any) of this item in the list.
            '''</Summary>
            <ApiMember(DataType:="int", Description:="The order (if any) of this item in the list.", Name:="Order", ParameterType:="query")>
            Public Overridable Property Order As Integer

            '''<Summary>
            '''The owner of this item.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="The owner of this item.", Name:="OwnerContactId", ParameterType:="query")>
            Public Overridable Property OwnerContactId As Guid

            Public Overridable Property ExtraValues As List(Of Object)
        End Class

        Public Partial Class DataListModel
            '''<Summary>
            '''Guid of the List PKID.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="Guid of the List PKID.", IsRequired:=true, Name:="ListId", ParameterType:="query")>
            Public Overridable Property ListId As Guid

            '''<Summary>
            '''Name of the list.
            '''</Summary>
            <ApiMember(DataType:="String", Description:="Name of the list.", Name:="Name", ParameterType:="query")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The owner of this item.
            '''</Summary>
            <ApiMember(DataType:="Guid", Description:="The owner of this item.", Name:="OwnerContactId", ParameterType:="query")>
            Public Overridable Property OwnerContactId As Guid

            '''<Summary>
            '''List Items in the list.
            '''</Summary>
            <ApiMember(DataType:="List<DataListItemModel>", Description:="List Items in the list.", Name:="ListItems", ParameterType:="query")>
            Public Overridable Property DataListItems As List(Of DataListItemModel)
        End Class
    End Namespace

    Namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

        '''<Summary>
        '''Get a list of timezones
        '''</Summary>
        <Api(Description:="Get a list of timezones")>
        Public Partial Class GetTimezones
        End Class

        <ApiResponse(Description:="List of timezones matching the criteria")>
        Public Partial Class GetTimezonesResponse
            Public Overridable Property Timezones As DataListModel
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetTimezones 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 /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>