| GET | /homepage/scheduler/settings | Get homepage scheduler settings |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class HomepageSchedulerFieldOptionsResponse
'''<Summary>
'''The field id.
'''</Summary>
<ApiMember(Description:="The field id.")>
Public Overridable Property Id As Integer
'''<Summary>
'''The field name.
'''</Summary>
<ApiMember(Description:="The field name.")>
Public Overridable Property Name As String
'''<Summary>
'''The field description.
'''</Summary>
<ApiMember(Description:="The field description.")>
Public Overridable Property Description As String
'''<Summary>
'''The field sort order when listing.
'''</Summary>
<ApiMember(Description:="The field sort order when listing.")>
Public Overridable Property SortOrder As Integer
End Class
Public Partial Class HomepageSchedulerFieldResponse
'''<Summary>
'''The field id.
'''</Summary>
<ApiMember(Description:="The field id.")>
Public Overridable Property Id As Integer
'''<Summary>
'''If the field should be shown on booking.
'''</Summary>
<ApiMember(Description:="If the field should be shown on booking.")>
Public Overridable Property ShowOnBooking As Boolean
'''<Summary>
'''If the field should be shown on tooltip.
'''</Summary>
<ApiMember(Description:="If the field should be shown on tooltip.")>
Public Overridable Property ShowOnTooltip As Boolean
End Class
Public Partial Class HomepageSchedulerResourceResponse
'''<Summary>
'''The resource id.
'''</Summary>
<ApiMember(Description:="The resource id.")>
Public Overridable Property Id As Integer
'''<Summary>
'''The resource name.
'''</Summary>
<ApiMember(Description:="The resource name.")>
Public Overridable Property Name As String
'''<Summary>
'''The resource description.
'''</Summary>
<ApiMember(Description:="The resource description.")>
Public Overridable Property Description As String
'''<Summary>
'''The resource image url.
'''</Summary>
<ApiMember(Description:="The resource image url.")>
Public Overridable Property ImageUrl As Uri
End Class
Public Partial Class HomepageSchedulerServiceResponse
'''<Summary>
'''The service id.
'''</Summary>
<ApiMember(Description:="The service id.")>
Public Overridable Property Id As Integer
'''<Summary>
'''The service name.
'''</Summary>
<ApiMember(Description:="The service name.")>
Public Overridable Property Name As String
'''<Summary>
'''The service description.
'''</Summary>
<ApiMember(Description:="The service description.")>
Public Overridable Property Description As String
'''<Summary>
'''The service image url.
'''</Summary>
<ApiMember(Description:="The service image url.")>
Public Overridable Property ImageUrl As Uri
End Class
Public Partial Class HomepageSchedulerSettingsQuery
Implements ICompany
Implements ICompanyRequest
'''<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")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<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")>
Public Overridable Property IncludeServices As Boolean
'''<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")>
Public Overridable Property IncludeResources As Boolean
'''<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")>
Public Overridable Property IncludeFields As Boolean
'''<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")>
Public Overridable Property IncludeServiceOptions As Boolean
'''<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")>
Public Overridable Property IncludeResourceOptions As Boolean
'''<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")>
Public Overridable Property IncludeFieldOptions As Boolean
'''<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")>
Public Overridable Property IncludeScheduleViewOptions As Boolean
'''<Summary>
'''The homeage sitepath.
'''</Summary>
<ApiMember(Description:="The homeage sitepath.")>
Public Overridable Property SitePath As String
End Class
Public Partial Class HomepageSchedulerSettingsQueryResponse
Public Sub New()
Services = New List(Of HomepageSchedulerServiceResponse)
Resources = New List(Of HomepageSchedulerResourceResponse)
Fields = New List(Of HomepageSchedulerFieldResponse)
FieldOptions = New List(Of HomepageSchedulerFieldOptionsResponse)
ScheduleViewOptions = New List(Of ScheduleViewResponse)
End Sub
'''<Summary>
'''The company id.
'''</Summary>
<ApiMember(Description:="The company id.")>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''If the user schedule is activated.
'''</Summary>
<ApiMember(Description:="If the user schedule is activated.")>
Public Overridable Property Active As Boolean
'''<Summary>
'''If the user schedule views id.
'''</Summary>
<ApiMember(Description:="If the user schedule views id.")>
Public Overridable Property ScheduleViewId As Integer
'''<Summary>
'''If the user schedule time slots in minutes.
'''</Summary>
<ApiMember(Description:="If the user schedule time slots in minutes.")>
Public Overridable Property ScheduleTimeSlotMinutes As Integer
'''<Summary>
'''If the user schedule time start time.
'''</Summary>
<ApiMember(Description:="If the user schedule time start time.")>
Public Overridable Property StartTime As Nullable(Of TimeSpan)
'''<Summary>
'''If the user schedule time end time.
'''</Summary>
<ApiMember(Description:="If the user schedule time end time.")>
Public Overridable Property EndTime As Nullable(Of TimeSpan)
'''<Summary>
'''If the user schedule should contain time exceptions.
'''</Summary>
<ApiMember(Description:="If the user schedule should contain time exceptions.")>
Public Overridable Property ShowTimeExceptions As Boolean
'''<Summary>
'''If allow booking in the scheduler.
'''</Summary>
<ApiMember(Description:="If allow booking in the scheduler.")>
Public Overridable Property EnableBooking As Boolean
'''<Summary>
'''The homepage schedule services that are selected
'''</Summary>
<ApiMember(Description:="The homepage schedule services that are selected")>
Public Overridable Property Services As List(Of HomepageSchedulerServiceResponse)
'''<Summary>
'''The homepage schedule resources that are selected
'''</Summary>
<ApiMember(Description:="The homepage schedule resources that are selected")>
Public Overridable Property Resources As List(Of HomepageSchedulerResourceResponse)
'''<Summary>
'''The homepage schedule fields that are selected
'''</Summary>
<ApiMember(Description:="The homepage schedule fields that are selected")>
Public Overridable Property Fields As List(Of HomepageSchedulerFieldResponse)
'''<Summary>
'''The homepage schedule fields select from
'''</Summary>
<ApiMember(Description:="The homepage schedule fields select from")>
Public Overridable Property FieldOptions As List(Of HomepageSchedulerFieldOptionsResponse)
'''<Summary>
'''The available schedule view options to choose from
'''</Summary>
<ApiMember(Description:="The available schedule view options to choose from")>
Public Overridable Property ScheduleViewOptions As List(Of ScheduleViewResponse)
End Class
Public Partial Class ScheduleViewResponse
Public Overridable Property Id As Integer
Public Overridable Property Name As String
End Class
End Namespace
End Namespace
VB.NET HomepageSchedulerSettingsQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}]}