BokaMera.API.Host

<back to all web services

SettingQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/settingsGet settings for the currently logged in userGet settings for the currently logged in user.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
public class SettingQuery : Codable
{
    /**
    * 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

    /**
    * If you want to include the week number settings to select from
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the week number settings to select from", ParameterType="query")
    public var includeWeekNumberOptions:Bool

    /**
    * If you want to include the booking template options to select from
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the booking template options to select from", ParameterType="query")
    public var includeBookingTemplateOptions:Bool

    /**
    * If you want to include the calendar type options to select from
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the calendar type options to select from", ParameterType="query")
    public var includeCalendarTypeOptions:Bool

    /**
    * If you want to include the booking status options to select from
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the booking status options to select from", ParameterType="query")
    public var includeBookingStatusOptions:Bool

    /**
    * If you want to include the Free spot text options to select from
    */
    // @ApiMember(DataType="boolean", Description="If you want to include the Free spot text options to select from", ParameterType="query")
    public var includeFreeSpotTextOptions:Bool

    required public init(){}
}

public class SettingResponse : Codable
{
    public var companyId:String
    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var bookingStatusId:Int

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var scheduleViewId:Int

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var bookingTemplateId:Int

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var calendarTypeId:Int

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var allowBookingOnUnbookedTimes:Bool

    /**
    * 
    */
    // @DataMember(Name="SendEmailReminder")
    // @ApiMember(DataType="boolean", Description="")
    public var SendEmailReminder:Bool

    /**
    * 
    */
    // @DataMember(Name="SendSmsReminder")
    // @ApiMember(DataType="boolean", Description="")
    public var SendSmsReminder:Bool

    /**
    * 
    */
    // @DataMember(Name="SendEmailConfirmation")
    // @ApiMember(DataType="boolean", Description="")
    public var SendEmailConfirmation:Bool

    /**
    * 
    */
    // @DataMember(Name="SendSmsConfirmation")
    // @ApiMember(DataType="boolean", Description="")
    public var SendSmsConfirmation:Bool

    /**
    * Message text field that could be used inside message templates using [MessageText].
    */
    // @ApiMember(DataType="string", Description="Message text field that could be used inside message templates using [MessageText].")
    public var messageText:String

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var emailReminderTime:Int

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var smsReminderTime:Int

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var maxActiveBookings:Int

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var sendNotifications:Bool

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="")
    public var sendNotificationsEmail:String

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var enableMobileApp:Bool

    /**
    * 
    */
    // @ApiMember(Description="")
    @TimeSpan public var scheduleStartTime:TimeInterval?

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    @TimeSpan public var scheduleEndTime:TimeInterval?

    /**
    * The admin scheduler if each resources should be shown in a seperate group
    */
    // @ApiMember(DataType="boolean", Description="The admin scheduler if each resources should be shown in a seperate group")
    public var scheduleGroupResources:Bool

    /**
    * The admin scheduler if the horizontal scrolling should be turned off
    */
    // @ApiMember(DataType="boolean", Description="The admin scheduler if the horizontal scrolling should be turned off")
    public var schedulerDisableHorizontalScrolling:Bool

    /**
    * 
    */
    // @ApiMember(DataType="string", Description="")
    public var receiptTemplate:String

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var scheduleTimeSlotMinutes:Int

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var showFreeTimesLeft:Bool

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var freeSpotTextsId:Int

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var enableICalGroupBookings:Bool

    /**
    * Booking agreement text. All html needs to entered using markup. Read about markup here https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet. Use this editor to create markup https://stackedit.io/app#
    */
    // @ApiMember(DataType="string", Description="Booking agreement text. All html needs to entered using markup. Read about markup here https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet. Use this editor to create markup https://stackedit.io/app#")
    public var agreementTemplate:String

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var scheduleShowTimeExeptions:Bool

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var enableBookingsOnSameTime:Bool

    /**
    * 
    */
    // @ApiMember(DataType="int", Description="")
    public var showWeekNumberSettingId:Int

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var enableShowBookedTimes:Bool

    /**
    * 
    */
    // @ApiMember(DataType="", Description="")
    public var bookSpotUserResponseMinutes:Int?

    /**
    * 
    */
    // @ApiMember(DataType="", Description="")
    public var isBookSpotDirectly:Bool

    /**
    * 
    */
    // @ApiMember(DataType="", Description="")
    public var bookSpotDirectlyTimeLeftMinutes:Int

    /**
    * 
    */
    // @ApiMember(DataType="", Description="")
    public var sendEmailNotificationQueue:Bool?

    /**
    * 
    */
    // @ApiMember(DataType="", Description="")
    public var sendSMSNotificationQueue:Bool?

    /**
    * 
    */
    // @ApiMember(Description="")
    public var enableSendFollowUpMessage:Bool

    /**
    * When follow up message should be sent in hours after the booking.
    */
    // @ApiMember(Description="When follow up message should be sent in hours after the booking.")
    public var followUpMessageTime:Int

    /**
    * If it's only allowed for existing customers to book
    */
    // @ApiMember(DataType="boolean", Description="If it's only allowed for existing customers to book")
    public var bookOnlyOnExistingCustomers:Bool

    /**
    * If a unique pin code should be generated for the customer
    */
    // @ApiMember(DataType="boolean", Description="If a unique pin code should be generated for the customer")
    public var autoGenerateUniquePinCode:Bool

    /**
    * If a user profile should be created when customer is booking time. With the property customer can login.
    */
    // @ApiMember(DataType="boolean", Description="If a user profile should be created when customer is booking time. With the property customer can login.")
    public var autoCreateUserProfile:Bool

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

    /**
    * The available week number options to choose from
    */
    // @ApiMember(Description="The available week number options to choose from")
    public var weekNumberOptions:[WeekNumberSettingResponse] = []

    /**
    * The booking template options to choose from
    */
    // @ApiMember(Description="The booking template options to choose from")
    public var bookingTemplateOptions:[BookingTemplateResponse] = []

    /**
    * The calendar type options to choose from
    */
    // @ApiMember(Description="The calendar type options to choose from")
    public var calendarTypeOptions:[CalendarTypeResponse] = []

    /**
    * The booking status options to choose from
    */
    // @ApiMember(Description="The booking status options to choose from")
    public var bookingStatusOptions:[BookingStatusOptions] = []

    /**
    * The free spot text options to choose from
    */
    // @ApiMember(Description="The free spot text options to choose from")
    public var freeSpotTextOptions:[FreeSpotTextsResponse] = []

    /**
    * If you have different prices over different times per day and want it to calculate the weighted price for the booked time.
    */
    // @ApiMember(DataType="boolean", Description="If you have different prices over different times per day and want it to calculate the weighted price for the booked time.")
    public var weightedPrices:Bool

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var showMultiDayAsTime:Bool

    /**
    * 
    */
    // @ApiMember(DataType="boolean", Description="")
    public var showMultipleResourcesAsOne:Bool

    required public init(){}
}

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

    required public init(){}
}

public class WeekNumberSettingResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String

    required public init(){}
}

public class BookingTemplateResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String
    public var usedByApplication:String

    required public init(){}
}

public class CalendarTypeResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String
    public var active:Bool

    required public init(){}
}

public class BookingStatusOptions : Codable
{
    public var id:Int
    public var name:String
    public var Description:String

    required public init(){}
}

public class FreeSpotTextsResponse : Codable
{
    public var id:Int
    public var textSingular:String
    public var textPlural:String

    required public init(){}
}


Swift SettingQuery 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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BookingStatusId":0,"ScheduleViewId":0,"BookingTemplateId":0,"CalendarTypeId":0,"AllowBookingOnUnbookedTimes":false,"SendEmailReminder":false,"SendSmsReminder":false,"SendEmailConfirmation":false,"SendSmsConfirmation":false,"MessageText":"String","EmailReminderTime":0,"SmsReminderTime":0,"MaxActiveBookings":0,"SendNotifications":false,"SendNotificationsEmail":"String","EnableMobileApp":false,"ScheduleStartTime":"00:00:00","ScheduleEndTime":"00:00:00","ScheduleGroupResources":false,"SchedulerDisableHorizontalScrolling":false,"ReceiptTemplate":"String","ScheduleTimeSlotMinutes":0,"ShowFreeTimesLeft":false,"FreeSpotTextsId":0,"EnableICalGroupBookings":false,"AgreementTemplate":"String","ScheduleShowTimeExeptions":false,"EnableBookingsOnSameTime":false,"ShowWeekNumberSettingId":0,"EnableShowBookedTimes":false,"BookSpotUserResponseMinutes":0,"IsBookSpotDirectly":false,"BookSpotDirectlyTimeLeftMinutes":0,"SendEmailNotificationQueue":false,"SendSMSNotificationQueue":false,"EnableSendFollowUpMessage":false,"FollowUpMessageTime":0,"BookOnlyOnExistingCustomers":false,"AutoGenerateUniquePinCode":false,"AutoCreateUserProfile":false,"ScheduleViewOptions":[{"Id":0,"Name":"String"}],"WeekNumberOptions":[{"Id":0,"Name":"String","Description":"String"}],"BookingTemplateOptions":[{"Id":0,"Name":"String","Description":"String","UsedByApplication":"String"}],"CalendarTypeOptions":[{"Id":0,"Name":"String","Description":"String","Active":false}],"BookingStatusOptions":[{"Id":0,"Name":"String","Description":"String"}],"FreeSpotTextOptions":[{"Id":0,"TextSingular":"String","TextPlural":"String"}],"WeightedPrices":false,"ShowMultiDayAsTime":false,"ShowMultipleResourcesAsOne":false}