BokaMera.API.Host

<back to all web services

HomepageSchedulerSettingsQuery

The following routes are available for this service:
GET/homepage/scheduler/settingsGet homepage scheduler settings
import Foundation
import ServiceStack

public class HomepageSchedulerSettingsQuery : ICompany, ICompanyRequest, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * 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 var includeServices:Bool

    /**
    * 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 var includeResources:Bool

    /**
    * 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 var includeFields:Bool

    /**
    * 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 var includeServiceOptions:Bool

    /**
    * 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 var includeResourceOptions:Bool

    /**
    * 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 var includeFieldOptions:Bool

    /**
    * 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 var includeScheduleViewOptions:Bool

    /**
    * The homeage sitepath.
    */
    // @ApiMember(Description="The homeage sitepath.")
    public var sitePath:String

    required public init(){}
}

public class HomepageSchedulerSettingsQueryResponse : Codable
{
    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.")
    public var companyId:String

    /**
    * If the user schedule is activated.
    */
    // @ApiMember(Description="If the user schedule is activated.")
    public var active:Bool

    /**
    * If the user schedule views id.
    */
    // @ApiMember(Description="If the user schedule views id.")
    public var scheduleViewId:Int

    /**
    * If the user schedule time slots in minutes.
    */
    // @ApiMember(Description="If the user schedule time slots in minutes.")
    public var scheduleTimeSlotMinutes:Int

    /**
    * If the user schedule time start time.
    */
    // @ApiMember(Description="If the user schedule time start time.")
    @TimeSpan public var startTime:TimeInterval?

    /**
    * If the user schedule time end time.
    */
    // @ApiMember(Description="If the user schedule time end time.")
    @TimeSpan public var endTime:TimeInterval?

    /**
    * If the user schedule should contain time exceptions.
    */
    // @ApiMember(Description="If the user schedule should contain time exceptions.")
    public var showTimeExceptions:Bool

    /**
    * If allow booking in the scheduler.
    */
    // @ApiMember(Description="If allow booking in the scheduler.")
    public var enableBooking:Bool

    /**
    * The homepage schedule services that are selected
    */
    // @ApiMember(Description="The homepage schedule services that are selected")
    public var services:[HomepageSchedulerServiceResponse] = []

    /**
    * The homepage schedule resources that are selected
    */
    // @ApiMember(Description="The homepage schedule resources that are selected")
    public var resources:[HomepageSchedulerResourceResponse] = []

    /**
    * The homepage schedule fields that are selected
    */
    // @ApiMember(Description="The homepage schedule fields that are selected")
    public var fields:[HomepageSchedulerFieldResponse] = []

    /**
    * The homepage schedule fields select from
    */
    // @ApiMember(Description="The homepage schedule fields select from")
    public var fieldOptions:[HomepageSchedulerFieldOptionsResponse] = []

    /**
    * The available schedule view options to choose from
    */
    // @ApiMember(Description="The available schedule view options to choose from")
    public var scheduleViewOptions:[ScheduleViewResponse] = []

    required public init(){}
}

public class HomepageSchedulerServiceResponse : Codable
{
    /**
    * The service id.
    */
    // @ApiMember(Description="The service id.")
    public var id:Int

    /**
    * The service name.
    */
    // @ApiMember(Description="The service name.")
    public var name:String

    /**
    * The service description.
    */
    // @ApiMember(Description="The service description.")
    public var Description:String

    /**
    * The service image url.
    */
    // @ApiMember(Description="The service image url.")
    public var imageUrl:Uri

    required public init(){}
}

public class HomepageSchedulerResourceResponse : Codable
{
    /**
    * The resource id.
    */
    // @ApiMember(Description="The resource id.")
    public var id:Int

    /**
    * The resource name.
    */
    // @ApiMember(Description="The resource name.")
    public var name:String

    /**
    * The resource description.
    */
    // @ApiMember(Description="The resource description.")
    public var Description:String

    /**
    * The resource image url.
    */
    // @ApiMember(Description="The resource image url.")
    public var imageUrl:Uri

    required public init(){}
}

public class HomepageSchedulerFieldResponse : Codable
{
    /**
    * The field id.
    */
    // @ApiMember(Description="The field id.")
    public var id:Int

    /**
    * If the field should be shown on booking.
    */
    // @ApiMember(Description="If the field should be shown on booking.")
    public var showOnBooking:Bool

    /**
    * If the field should be shown on tooltip.
    */
    // @ApiMember(Description="If the field should be shown on tooltip.")
    public var showOnTooltip:Bool

    required public init(){}
}

public class HomepageSchedulerFieldOptionsResponse : Codable
{
    /**
    * The field id.
    */
    // @ApiMember(Description="The field id.")
    public var id:Int

    /**
    * The field name.
    */
    // @ApiMember(Description="The field name.")
    public var name:String

    /**
    * The field description.
    */
    // @ApiMember(Description="The field description.")
    public var Description:String

    /**
    * The field sort order when listing.
    */
    // @ApiMember(Description="The field sort order when listing.")
    public var sortOrder:Int

    required public init(){}
}

public class ScheduleViewResponse : Codable
{
    public var id:Int
    public var name:String

    required public init(){}
}


Swift HomepageSchedulerSettingsQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + 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: api.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"}]}