| GET | /homepage/scheduler/settings | Get homepage scheduler settings |
|---|
export class HomepageSchedulerServiceResponse
{
/** @description The service id. */
// @ApiMember(Description="The service id.")
public Id: number;
/** @description The service name. */
// @ApiMember(Description="The service name.")
public Name: string;
/** @description The service description. */
// @ApiMember(Description="The service description.")
public Description: string;
/** @description The service image url. */
// @ApiMember(Description="The service image url.")
public ImageUrl: string;
public constructor(init?: Partial<HomepageSchedulerServiceResponse>) { (Object as any).assign(this, init); }
}
export class HomepageSchedulerResourceResponse
{
/** @description The resource id. */
// @ApiMember(Description="The resource id.")
public Id: number;
/** @description The resource name. */
// @ApiMember(Description="The resource name.")
public Name: string;
/** @description The resource description. */
// @ApiMember(Description="The resource description.")
public Description: string;
/** @description The resource image url. */
// @ApiMember(Description="The resource image url.")
public ImageUrl: string;
public constructor(init?: Partial<HomepageSchedulerResourceResponse>) { (Object as any).assign(this, init); }
}
export class HomepageSchedulerFieldResponse
{
/** @description The field id. */
// @ApiMember(Description="The field id.")
public Id: number;
/** @description If the field should be shown on booking. */
// @ApiMember(Description="If the field should be shown on booking.")
public ShowOnBooking: boolean;
/** @description If the field should be shown on tooltip. */
// @ApiMember(Description="If the field should be shown on tooltip.")
public ShowOnTooltip: boolean;
public constructor(init?: Partial<HomepageSchedulerFieldResponse>) { (Object as any).assign(this, init); }
}
export class HomepageSchedulerFieldOptionsResponse
{
/** @description The field id. */
// @ApiMember(Description="The field id.")
public Id: number;
/** @description The field name. */
// @ApiMember(Description="The field name.")
public Name: string;
/** @description The field description. */
// @ApiMember(Description="The field description.")
public Description: string;
/** @description The field sort order when listing. */
// @ApiMember(Description="The field sort order when listing.")
public SortOrder: number;
public constructor(init?: Partial<HomepageSchedulerFieldOptionsResponse>) { (Object as any).assign(this, init); }
}
export class ScheduleViewResponse
{
public Id: number;
public Name: string;
public constructor(init?: Partial<ScheduleViewResponse>) { (Object as any).assign(this, init); }
}
export class HomepageSchedulerSettingsQueryResponse
{
/** @description The company id. */
// @ApiMember(Description="The company id.")
public CompanyId: string;
/** @description If the user schedule is activated. */
// @ApiMember(Description="If the user schedule is activated.")
public Active: boolean;
/** @description If the user schedule views id. */
// @ApiMember(Description="If the user schedule views id.")
public ScheduleViewId: number;
/** @description If the user schedule time slots in minutes. */
// @ApiMember(Description="If the user schedule time slots in minutes.")
public ScheduleTimeSlotMinutes: number;
/** @description If the user schedule time start time. */
// @ApiMember(Description="If the user schedule time start time.")
public StartTime?: string;
/** @description If the user schedule time end time. */
// @ApiMember(Description="If the user schedule time end time.")
public EndTime?: string;
/** @description If the user schedule should contain time exceptions. */
// @ApiMember(Description="If the user schedule should contain time exceptions.")
public ShowTimeExceptions: boolean;
/** @description If allow booking in the scheduler. */
// @ApiMember(Description="If allow booking in the scheduler.")
public EnableBooking: boolean;
/** @description The homepage schedule services that are selected */
// @ApiMember(Description="The homepage schedule services that are selected")
public Services: HomepageSchedulerServiceResponse[];
/** @description The homepage schedule resources that are selected */
// @ApiMember(Description="The homepage schedule resources that are selected")
public Resources: HomepageSchedulerResourceResponse[];
/** @description The homepage schedule fields that are selected */
// @ApiMember(Description="The homepage schedule fields that are selected")
public Fields: HomepageSchedulerFieldResponse[];
/** @description The homepage schedule fields select from */
// @ApiMember(Description="The homepage schedule fields select from")
public FieldOptions: HomepageSchedulerFieldOptionsResponse[];
/** @description The available schedule view options to choose from */
// @ApiMember(Description="The available schedule view options to choose from")
public ScheduleViewOptions: ScheduleViewResponse[];
public constructor(init?: Partial<HomepageSchedulerSettingsQueryResponse>) { (Object as any).assign(this, init); }
}
export class HomepageSchedulerSettingsQuery implements ICompany, ICompanyRequest
{
/** @description 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")
public CompanyId?: string;
/** @description 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")
public IncludeServices: boolean;
/** @description 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")
public IncludeResources: boolean;
/** @description 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")
public IncludeFields: boolean;
/** @description 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")
public IncludeServiceOptions: boolean;
/** @description 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")
public IncludeResourceOptions: boolean;
/** @description 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")
public IncludeFieldOptions: boolean;
/** @description 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")
public IncludeScheduleViewOptions: boolean;
/** @description The homeage sitepath. */
// @ApiMember(Description="The homeage sitepath.")
public SitePath: string;
public constructor(init?: Partial<HomepageSchedulerSettingsQuery>) { (Object as any).assign(this, init); }
}
TypeScript 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>