| GET | /homepage/scheduler/settings | Get homepage scheduler settings |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | No | Enter the company you want to see news for, if blank and you are an admin, your company id will be used |
| IncludeServices | query | boolean | No | If you want to include the services that is connected |
| IncludeResources | query | boolean | No | If you want to include the resources that is connected |
| IncludeFields | query | boolean | No | If you want to include the scheduler fields that is connected |
| IncludeServiceOptions | query | boolean | No | If you want to include the service to select from |
| IncludeResourceOptions | query | boolean | No | If you want to include the resources to select from |
| IncludeFieldOptions | query | boolean | No | If you want to include the scheduler fields to select from |
| IncludeScheduleViewOptions | query | boolean | No | If you want to include the schedule views to select from |
| SitePath | query | string | No | The homeage sitepath. |
| 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 .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Active":false,"ScheduleViewId":0,"ScheduleTimeSlotMinutes":0,"StartTime":"00:00:00","EndTime":"00:00:00","ShowTimeExceptions":false,"EnableBooking":false,"Services":[{"Id":0,"Name":"String","Description":"String"}],"Resources":[{"Id":0,"Name":"String","Description":"String"}],"Fields":[{"Id":0,"ShowOnBooking":false,"ShowOnTooltip":false}],"FieldOptions":[{"Id":0,"Name":"String","Description":"String","SortOrder":0}],"ScheduleViewOptions":[{"Id":0,"Name":"String"}]}