Platform API

GetTimezones

Get a list of timezones

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get a list of timezones
*/
@Api(Description="Get a list of timezones")
open class GetTimezones
{
}

@ApiResponse(Description="List of timezones matching the criteria")
open class GetTimezonesResponse
{
    open var Timezones:DataListModel? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DataListModel
{
    /**
    * Guid of the List PKID.
    */
    @ApiMember(DataType="Guid", Description="Guid of the List PKID.", IsRequired=true, Name="ListId", ParameterType="query")
    open var ListId:UUID? = null

    /**
    * Name of the list.
    */
    @ApiMember(DataType="String", Description="Name of the list.", Name="Name", ParameterType="query")
    open var Name:String? = null

    /**
    * The owner of this item.
    */
    @ApiMember(DataType="Guid", Description="The owner of this item.", Name="OwnerContactId", ParameterType="query")
    open var OwnerContactId:UUID? = null

    /**
    * List Items in the list.
    */
    @ApiMember(DataType="List<DataListItemModel>", Description="List Items in the list.", Name="ListItems", ParameterType="query")
    open var DataListItems:ArrayList<DataListItemModel>? = null
}

open class DataListItemModel
{
    /**
    * Guid of the list item PKID.
    */
    @ApiMember(DataType="Guid", Description="Guid of the list item PKID.", IsRequired=true, Name="ListItemId", ParameterType="query")
    open var ListItemId:UUID? = null

    /**
    * Name of the list item.
    */
    @ApiMember(DataType="string", Description="Name of the list item.", Name="Name", ParameterType="query")
    open var Name:String? = null

    /**
    * Short Version Name of the list item.
    */
    @ApiMember(DataType="string", Description="Short Version Name of the list item.", Name="ShortName", ParameterType="query")
    open var ShortName:String? = null

    /**
    * The primary image url
    */
    @ApiMember(DataType="string", Description="The primary image url", Name="PrimaryImagePath", ParameterType="query")
    open var PrimaryImagePath:String? = null

    /**
    * Record Status of the List Item (A=Active, I=Inactive, D=Deleted).
    */
    @ApiMember(DataType="string", Description="Record Status of the List Item (A=Active, I=Inactive, D=Deleted).", Name="RecordStatus", ParameterType="query")
    open var RecordStatus:String? = null

    /**
    * The order (if any) of this item in the list.
    */
    @ApiMember(DataType="int", Description="The order (if any) of this item in the list.", Name="Order", ParameterType="query")
    open var Order:Int? = null

    /**
    * The owner of this item.
    */
    @ApiMember(DataType="Guid", Description="The owner of this item.", Name="OwnerContactId", ParameterType="query")
    open var OwnerContactId:UUID? = null

    open var ExtraValues:ArrayList<Object>? = null
}

Kotlin GetTimezones 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 /api/timezones HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Timezones: 
	{
		Name: String,
		DataListItems: 
		[
			{
				Name: String,
				ShortName: String,
				PrimaryImagePath: String,
				RecordStatus: String,
				Order: 0,
				ExtraValues: 
				[
					{
						
					}
				]
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}