| All Verbs | /api/timezones |
|---|
namespace Eros.Saguna.Common.WebAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type 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")>]
member val ListItemId:Guid = new Guid() with get,set
///<summary>
///Name of the list item.
///</summary>
[<ApiMember(DataType="string", Description="Name of the list item.", Name="Name", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///Short Version Name of the list item.
///</summary>
[<ApiMember(DataType="string", Description="Short Version Name of the list item.", Name="ShortName", ParameterType="query")>]
member val ShortName:String = null with get,set
///<summary>
///The primary image url
///</summary>
[<ApiMember(DataType="string", Description="The primary image url", Name="PrimaryImagePath", ParameterType="query")>]
member val PrimaryImagePath:String = null with get,set
///<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")>]
member val RecordStatus:String = null with get,set
///<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")>]
member val Order:Int32 = new Int32() with get,set
///<summary>
///The owner of this item.
///</summary>
[<ApiMember(DataType="Guid", Description="The owner of this item.", Name="OwnerContactId", ParameterType="query")>]
member val OwnerContactId:Guid = new Guid() with get,set
member val ExtraValues:ResizeArray<Object> = null with get,set
[<AllowNullLiteral>]
type DataListModel() =
///<summary>
///Guid of the List PKID.
///</summary>
[<ApiMember(DataType="Guid", Description="Guid of the List PKID.", IsRequired=true, Name="ListId", ParameterType="query")>]
member val ListId:Guid = new Guid() with get,set
///<summary>
///Name of the list.
///</summary>
[<ApiMember(DataType="String", Description="Name of the list.", Name="Name", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///The owner of this item.
///</summary>
[<ApiMember(DataType="Guid", Description="The owner of this item.", Name="OwnerContactId", ParameterType="query")>]
member val OwnerContactId:Guid = new Guid() with get,set
///<summary>
///List Items in the list.
///</summary>
[<ApiMember(DataType="List<DataListItemModel>", Description="List Items in the list.", Name="ListItems", ParameterType="query")>]
member val DataListItems:ResizeArray<DataListItemModel> = null with get,set
[<ApiResponse(Description="List of timezones matching the criteria")>]
[<AllowNullLiteral>]
type GetTimezonesResponse() =
member val Timezones:DataListModel = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
///<summary>
///Get a list of timezones
///</summary>
[<Api(Description="Get a list of timezones")>]
[<AllowNullLiteral>]
type GetTimezones() =
class end
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>