| GET | /homepage/scheduler/settings | Get homepage scheduler settings |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type HomepageSchedulerServiceResponse() =
///<summary>
///The service id.
///</summary>
[<ApiMember(Description="The service id.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The service name.
///</summary>
[<ApiMember(Description="The service name.")>]
member val Name:String = null with get,set
///<summary>
///The service description.
///</summary>
[<ApiMember(Description="The service description.")>]
member val Description:String = null with get,set
///<summary>
///The service image url.
///</summary>
[<ApiMember(Description="The service image url.")>]
member val ImageUrl:Uri = null with get,set
[<AllowNullLiteral>]
type HomepageSchedulerResourceResponse() =
///<summary>
///The resource id.
///</summary>
[<ApiMember(Description="The resource id.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The resource name.
///</summary>
[<ApiMember(Description="The resource name.")>]
member val Name:String = null with get,set
///<summary>
///The resource description.
///</summary>
[<ApiMember(Description="The resource description.")>]
member val Description:String = null with get,set
///<summary>
///The resource image url.
///</summary>
[<ApiMember(Description="The resource image url.")>]
member val ImageUrl:Uri = null with get,set
[<AllowNullLiteral>]
type HomepageSchedulerFieldResponse() =
///<summary>
///The field id.
///</summary>
[<ApiMember(Description="The field id.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///If the field should be shown on booking.
///</summary>
[<ApiMember(Description="If the field should be shown on booking.")>]
member val ShowOnBooking:Boolean = new Boolean() with get,set
///<summary>
///If the field should be shown on tooltip.
///</summary>
[<ApiMember(Description="If the field should be shown on tooltip.")>]
member val ShowOnTooltip:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type HomepageSchedulerFieldOptionsResponse() =
///<summary>
///The field id.
///</summary>
[<ApiMember(Description="The field id.")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The field name.
///</summary>
[<ApiMember(Description="The field name.")>]
member val Name:String = null with get,set
///<summary>
///The field description.
///</summary>
[<ApiMember(Description="The field description.")>]
member val Description:String = null with get,set
///<summary>
///The field sort order when listing.
///</summary>
[<ApiMember(Description="The field sort order when listing.")>]
member val SortOrder:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type ScheduleViewResponse() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
[<AllowNullLiteral>]
type HomepageSchedulerSettingsQueryResponse() =
///<summary>
///The company id.
///</summary>
[<ApiMember(Description="The company id.")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///If the user schedule is activated.
///</summary>
[<ApiMember(Description="If the user schedule is activated.")>]
member val Active:Boolean = new Boolean() with get,set
///<summary>
///If the user schedule views id.
///</summary>
[<ApiMember(Description="If the user schedule views id.")>]
member val ScheduleViewId:Int32 = new Int32() with get,set
///<summary>
///If the user schedule time slots in minutes.
///</summary>
[<ApiMember(Description="If the user schedule time slots in minutes.")>]
member val ScheduleTimeSlotMinutes:Int32 = new Int32() with get,set
///<summary>
///If the user schedule time start time.
///</summary>
[<ApiMember(Description="If the user schedule time start time.")>]
member val StartTime:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
///<summary>
///If the user schedule time end time.
///</summary>
[<ApiMember(Description="If the user schedule time end time.")>]
member val EndTime:Nullable<TimeSpan> = new Nullable<TimeSpan>() with get,set
///<summary>
///If the user schedule should contain time exceptions.
///</summary>
[<ApiMember(Description="If the user schedule should contain time exceptions.")>]
member val ShowTimeExceptions:Boolean = new Boolean() with get,set
///<summary>
///If allow booking in the scheduler.
///</summary>
[<ApiMember(Description="If allow booking in the scheduler.")>]
member val EnableBooking:Boolean = new Boolean() with get,set
///<summary>
///The homepage schedule services that are selected
///</summary>
[<ApiMember(Description="The homepage schedule services that are selected")>]
member val Services:ResizeArray<HomepageSchedulerServiceResponse> = new ResizeArray<HomepageSchedulerServiceResponse>() with get,set
///<summary>
///The homepage schedule resources that are selected
///</summary>
[<ApiMember(Description="The homepage schedule resources that are selected")>]
member val Resources:ResizeArray<HomepageSchedulerResourceResponse> = new ResizeArray<HomepageSchedulerResourceResponse>() with get,set
///<summary>
///The homepage schedule fields that are selected
///</summary>
[<ApiMember(Description="The homepage schedule fields that are selected")>]
member val Fields:ResizeArray<HomepageSchedulerFieldResponse> = new ResizeArray<HomepageSchedulerFieldResponse>() with get,set
///<summary>
///The homepage schedule fields select from
///</summary>
[<ApiMember(Description="The homepage schedule fields select from")>]
member val FieldOptions:ResizeArray<HomepageSchedulerFieldOptionsResponse> = new ResizeArray<HomepageSchedulerFieldOptionsResponse>() with get,set
///<summary>
///The available schedule view options to choose from
///</summary>
[<ApiMember(Description="The available schedule view options to choose from")>]
member val ScheduleViewOptions:ResizeArray<ScheduleViewResponse> = new ResizeArray<ScheduleViewResponse>() with get,set
[<AllowNullLiteral>]
type HomepageSchedulerSettingsQuery() =
///<summary>
///Enter the company you want to see news for, if blank and you are an admin, your company id will be used
///</summary>
[<ApiMember(Description="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType="query")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///If you want to include the services that is connected
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the services that is connected", ParameterType="query")>]
member val IncludeServices:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the resources that is connected
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the resources that is connected", ParameterType="query")>]
member val IncludeResources:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the scheduler fields that is connected
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the scheduler fields that is connected", ParameterType="query")>]
member val IncludeFields:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the service to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the service to select from", ParameterType="query")>]
member val IncludeServiceOptions:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the resources to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the resources to select from", ParameterType="query")>]
member val IncludeResourceOptions:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the scheduler fields to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the scheduler fields to select from", ParameterType="query")>]
member val IncludeFieldOptions:Boolean = new Boolean() with get,set
///<summary>
///If you want to include the schedule views to select from
///</summary>
[<ApiMember(DataType="boolean", Description="If you want to include the schedule views to select from", ParameterType="query")>]
member val IncludeScheduleViewOptions:Boolean = new Boolean() with get,set
///<summary>
///The homeage sitepath.
///</summary>
[<ApiMember(Description="The homeage sitepath.")>]
member val SitePath:String = null with get,set
F# HomepageSchedulerSettingsQuery DTOs
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.
GET /homepage/scheduler/settings HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<HomepageSchedulerSettingsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Active>false</Active>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<EnableBooking>false</EnableBooking>
<EndTime>PT0S</EndTime>
<FieldOptions>
<HomepageSchedulerFieldOptionsResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
<SortOrder>0</SortOrder>
</HomepageSchedulerFieldOptionsResponse>
</FieldOptions>
<Fields>
<HomepageSchedulerFieldResponse>
<Id>0</Id>
<ShowOnBooking>false</ShowOnBooking>
<ShowOnTooltip>false</ShowOnTooltip>
</HomepageSchedulerFieldResponse>
</Fields>
<Resources>
<HomepageSchedulerResourceResponse>
<Description>String</Description>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Name>String</Name>
</HomepageSchedulerResourceResponse>
</Resources>
<ScheduleTimeSlotMinutes>0</ScheduleTimeSlotMinutes>
<ScheduleViewId>0</ScheduleViewId>
<ScheduleViewOptions>
<ScheduleViewResponse>
<Id>0</Id>
<Name>String</Name>
</ScheduleViewResponse>
</ScheduleViewOptions>
<Services>
<HomepageSchedulerServiceResponse>
<Description>String</Description>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Name>String</Name>
</HomepageSchedulerServiceResponse>
</Services>
<ShowTimeExceptions>false</ShowTimeExceptions>
<StartTime>PT0S</StartTime>
</HomepageSchedulerSettingsQueryResponse>