Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /homepage/scheduler/settings | Update homepage scheduler settings | Update homepage scheduler settings on the company of the currently logged in user, only administrators are allowed to update homepage menu. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Active | body | bool? | No | If the user schedule is activated. |
ScheduleViewId | body | int? | No | If the user schedule views id. |
ScheduleTimeSlotMinutes | body | int? | No | If the user schedule time slots in minutes. |
StartTime | body | TimeSpan? | No | If the user schedule time start time. |
EndTime | body | TimeSpan? | No | If the user schedule time end time. |
ShowTimeExceptions | body | bool? | No | If the user schedule should contain time exceptions. |
EnableBooking | body | bool? | No | If allow booking in the scheduler. |
Resources | body | List<HomepageSchedulerResource> | No | What resources you want to be shown in scheduler. |
Services | body | List<HomepageSchedulerService> | No | What services you want to be shown in scheduler. |
Fields | body | List<HomepageScheduleField> | No | What fields you want to be shown in scheduler. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The resource id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The service id. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | Yes | The field id. |
ShowOnBooking | form | bool | Yes | If the field showed on the booking. |
ShowOnTooltip | form | bool | Yes | If the field showed on the bookings tooltip. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | No | The company id. |
Active | form | bool | No | If the user schedule is activated. |
ScheduleViewId | form | int | No | If the user schedule views id. |
ScheduleTimeSlotMinutes | form | int | No | If the user schedule time slots in minutes. |
StartTime | form | TimeSpan? | No | If the user schedule time start time. |
EndTime | form | TimeSpan? | No | If the user schedule time end time. |
ShowTimeExceptions | form | bool | No | If the user schedule should contain time exceptions. |
EnableBooking | form | bool | No | If allow booking in the scheduler. |
Services | form | List<HomepageSchedulerServiceResponse> | No | The homepage schedule services that are selected |
Resources | form | List<HomepageSchedulerResourceResponse> | No | The homepage schedule resources that are selected |
Fields | form | List<HomepageSchedulerFieldResponse> | No | The homepage schedule fields that are selected |
FieldOptions | form | List<HomepageSchedulerFieldOptionsResponse> | No | The homepage schedule fields select from |
ScheduleViewOptions | form | List<ScheduleViewResponse> | No | The available schedule view options to choose from |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The service id. |
Name | form | string | No | The service name. |
Description | form | string | No | The service description. |
ImageUrl | form | Uri | No | The service image url. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The resource id. |
Name | form | string | No | The resource name. |
Description | form | string | No | The resource description. |
ImageUrl | form | Uri | No | The resource image url. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The field id. |
ShowOnBooking | form | bool | No | If the field should be shown on booking. |
ShowOnTooltip | form | bool | No | If the field should be shown on tooltip. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | The field id. |
Name | form | string | No | The field name. |
Description | form | string | No | The field description. |
SortOrder | form | int | No | The field sort order when listing. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | No |
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.
PUT /homepage/scheduler/settings HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateHomepageSchedulerSettings 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>
<Fields>
<HomepageScheduleField>
<Id>0</Id>
<ShowOnBooking>false</ShowOnBooking>
<ShowOnTooltip>false</ShowOnTooltip>
</HomepageScheduleField>
</Fields>
<Resources>
<HomepageSchedulerResource>
<Id>0</Id>
</HomepageSchedulerResource>
</Resources>
<ScheduleTimeSlotMinutes>0</ScheduleTimeSlotMinutes>
<ScheduleViewId>0</ScheduleViewId>
<Services>
<HomepageSchedulerService>
<Id>0</Id>
</HomepageSchedulerService>
</Services>
<ShowTimeExceptions>false</ShowTimeExceptions>
<StartTime>PT0S</StartTime>
</UpdateHomepageSchedulerSettings>
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>