| GET | /homepage/scheduler/settings | Get homepage scheduler settings |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class HomepageSchedulerSettingsQuery : ICompany, ICompanyRequest
{
/**
* Enter the company you want to see news for, if blank and you are an admin, your company id will be used
*/
@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")
var CompanyId:UUID? = null
/**
* If you want to include the services that is connected
*/
@ApiMember(DataType="boolean", Description="If you want to include the services that is connected", ParameterType="query")
var IncludeServices:Boolean? = null
/**
* If you want to include the resources that is connected
*/
@ApiMember(DataType="boolean", Description="If you want to include the resources that is connected", ParameterType="query")
var IncludeResources:Boolean? = null
/**
* If you want to include the scheduler fields that is connected
*/
@ApiMember(DataType="boolean", Description="If you want to include the scheduler fields that is connected", ParameterType="query")
var IncludeFields:Boolean? = null
/**
* If you want to include the service to select from
*/
@ApiMember(DataType="boolean", Description="If you want to include the service to select from", ParameterType="query")
var IncludeServiceOptions:Boolean? = null
/**
* If you want to include the resources to select from
*/
@ApiMember(DataType="boolean", Description="If you want to include the resources to select from", ParameterType="query")
var IncludeResourceOptions:Boolean? = null
/**
* If you want to include the scheduler fields to select from
*/
@ApiMember(DataType="boolean", Description="If you want to include the scheduler fields to select from", ParameterType="query")
var IncludeFieldOptions:Boolean? = null
/**
* If you want to include the schedule views to select from
*/
@ApiMember(DataType="boolean", Description="If you want to include the schedule views to select from", ParameterType="query")
var IncludeScheduleViewOptions:Boolean? = null
/**
* The homeage sitepath.
*/
@ApiMember(Description="The homeage sitepath.")
var SitePath:String? = null
}
open class HomepageSchedulerSettingsQueryResponse
{
/**
* The company id.
*/
@ApiMember(Description="The company id.")
var CompanyId:UUID? = null
/**
* If the user schedule is activated.
*/
@ApiMember(Description="If the user schedule is activated.")
var Active:Boolean? = null
/**
* If the user schedule views id.
*/
@ApiMember(Description="If the user schedule views id.")
var ScheduleViewId:Int? = null
/**
* If the user schedule time slots in minutes.
*/
@ApiMember(Description="If the user schedule time slots in minutes.")
var ScheduleTimeSlotMinutes:Int? = null
/**
* If the user schedule time start time.
*/
@ApiMember(Description="If the user schedule time start time.")
var StartTime:TimeSpan? = null
/**
* If the user schedule time end time.
*/
@ApiMember(Description="If the user schedule time end time.")
var EndTime:TimeSpan? = null
/**
* If the user schedule should contain time exceptions.
*/
@ApiMember(Description="If the user schedule should contain time exceptions.")
var ShowTimeExceptions:Boolean? = null
/**
* If allow booking in the scheduler.
*/
@ApiMember(Description="If allow booking in the scheduler.")
var EnableBooking:Boolean? = null
/**
* The homepage schedule services that are selected
*/
@ApiMember(Description="The homepage schedule services that are selected")
var Services:ArrayList<HomepageSchedulerServiceResponse> = ArrayList<HomepageSchedulerServiceResponse>()
/**
* The homepage schedule resources that are selected
*/
@ApiMember(Description="The homepage schedule resources that are selected")
var Resources:ArrayList<HomepageSchedulerResourceResponse> = ArrayList<HomepageSchedulerResourceResponse>()
/**
* The homepage schedule fields that are selected
*/
@ApiMember(Description="The homepage schedule fields that are selected")
var Fields:ArrayList<HomepageSchedulerFieldResponse> = ArrayList<HomepageSchedulerFieldResponse>()
/**
* The homepage schedule fields select from
*/
@ApiMember(Description="The homepage schedule fields select from")
var FieldOptions:ArrayList<HomepageSchedulerFieldOptionsResponse> = ArrayList<HomepageSchedulerFieldOptionsResponse>()
/**
* The available schedule view options to choose from
*/
@ApiMember(Description="The available schedule view options to choose from")
var ScheduleViewOptions:ArrayList<ScheduleViewResponse> = ArrayList<ScheduleViewResponse>()
}
open class HomepageSchedulerServiceResponse
{
/**
* The service id.
*/
@ApiMember(Description="The service id.")
var Id:Int? = null
/**
* The service name.
*/
@ApiMember(Description="The service name.")
var Name:String? = null
/**
* The service description.
*/
@ApiMember(Description="The service description.")
var Description:String? = null
/**
* The service image url.
*/
@ApiMember(Description="The service image url.")
var ImageUrl:Uri? = null
}
open class HomepageSchedulerResourceResponse
{
/**
* The resource id.
*/
@ApiMember(Description="The resource id.")
var Id:Int? = null
/**
* The resource name.
*/
@ApiMember(Description="The resource name.")
var Name:String? = null
/**
* The resource description.
*/
@ApiMember(Description="The resource description.")
var Description:String? = null
/**
* The resource image url.
*/
@ApiMember(Description="The resource image url.")
var ImageUrl:Uri? = null
}
open class HomepageSchedulerFieldResponse
{
/**
* The field id.
*/
@ApiMember(Description="The field id.")
var Id:Int? = null
/**
* If the field should be shown on booking.
*/
@ApiMember(Description="If the field should be shown on booking.")
var ShowOnBooking:Boolean? = null
/**
* If the field should be shown on tooltip.
*/
@ApiMember(Description="If the field should be shown on tooltip.")
var ShowOnTooltip:Boolean? = null
}
open class HomepageSchedulerFieldOptionsResponse
{
/**
* The field id.
*/
@ApiMember(Description="The field id.")
var Id:Int? = null
/**
* The field name.
*/
@ApiMember(Description="The field name.")
var Name:String? = null
/**
* The field description.
*/
@ApiMember(Description="The field description.")
var Description:String? = null
/**
* The field sort order when listing.
*/
@ApiMember(Description="The field sort order when listing.")
var SortOrder:Int? = null
}
open class ScheduleViewResponse
{
var Id:Int? = null
var Name:String? = null
}
Kotlin 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>