| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /settings | Get settings for the currently logged in user | Get settings for the currently logged in user. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@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")
open class SettingQuery
{
/**
* 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")
var IncludeScheduleViewOptions:Boolean? = null
/**
* 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")
var IncludeWeekNumberOptions:Boolean? = null
/**
* 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")
var IncludeBookingTemplateOptions:Boolean? = null
/**
* 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")
var IncludeCalendarTypeOptions:Boolean? = null
/**
* 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")
var IncludeBookingStatusOptions:Boolean? = null
/**
* 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")
var IncludeFreeSpotTextOptions:Boolean? = null
}
open class SettingResponse
{
var CompanyId:UUID? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var BookingStatusId:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var ScheduleViewId:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var BookingTemplateId:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var CalendarTypeId:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var AllowBookingOnUnbookedTimes:Boolean? = null
/**
*
*/
@DataMember(Name="SendEmailReminder")
@SerializedName("SendEmailReminder")
@ApiMember(DataType="boolean", Description="")
var SendEmailReminder:Boolean? = null
/**
*
*/
@DataMember(Name="SendSmsReminder")
@SerializedName("SendSmsReminder")
@ApiMember(DataType="boolean", Description="")
var SendSmsReminder:Boolean? = null
/**
*
*/
@DataMember(Name="SendEmailConfirmation")
@SerializedName("SendEmailConfirmation")
@ApiMember(DataType="boolean", Description="")
var SendEmailConfirmation:Boolean? = null
/**
*
*/
@DataMember(Name="SendSmsConfirmation")
@SerializedName("SendSmsConfirmation")
@ApiMember(DataType="boolean", Description="")
var SendSmsConfirmation:Boolean? = null
/**
* 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].")
var MessageText:String? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var EmailReminderTime:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var SmsReminderTime:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var MaxActiveBookings:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var SendNotifications:Boolean? = null
/**
*
*/
@ApiMember(DataType="string", Description="")
var SendNotificationsEmail:String? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var EnableMobileApp:Boolean? = null
/**
*
*/
@ApiMember(Description="")
var ScheduleStartTime:TimeSpan? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var ScheduleEndTime:TimeSpan? = null
/**
* 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")
var ScheduleGroupResources:Boolean? = null
/**
* 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")
var SchedulerDisableHorizontalScrolling:Boolean? = null
/**
*
*/
@ApiMember(DataType="string", Description="")
var ReceiptTemplate:String? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var ScheduleTimeSlotMinutes:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var ShowFreeTimesLeft:Boolean? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var FreeSpotTextsId:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var EnableICalGroupBookings:Boolean? = null
/**
* 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#")
var AgreementTemplate:String? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var ScheduleShowTimeExeptions:Boolean? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var EnableBookingsOnSameTime:Boolean? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
var ShowWeekNumberSettingId:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var EnableShowBookedTimes:Boolean? = null
/**
*
*/
@ApiMember(DataType="", Description="")
var BookSpotUserResponseMinutes:Int? = null
/**
*
*/
@ApiMember(DataType="", Description="")
var IsBookSpotDirectly:Boolean? = null
/**
*
*/
@ApiMember(DataType="", Description="")
var BookSpotDirectlyTimeLeftMinutes:Int? = null
/**
*
*/
@ApiMember(DataType="", Description="")
var SendEmailNotificationQueue:Boolean? = null
/**
*
*/
@ApiMember(DataType="", Description="")
var SendSMSNotificationQueue:Boolean? = null
/**
*
*/
@ApiMember(Description="")
var EnableSendFollowUpMessage:Boolean? = null
/**
* 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.")
var FollowUpMessageTime:Int? = null
/**
* If it's only allowed for existing customers to book
*/
@ApiMember(DataType="boolean", Description="If it's only allowed for existing customers to book")
var BookOnlyOnExistingCustomers:Boolean? = null
/**
* 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")
var AutoGenerateUniquePinCode:Boolean? = null
/**
* 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.")
var AutoCreateUserProfile:Boolean? = null
/**
* The available schedule view options to choose from
*/
@ApiMember(Description="The available schedule view options to choose from")
var ScheduleViewOptions:ArrayList<ScheduleViewResponse> = ArrayList<ScheduleViewResponse>()
/**
* The available week number options to choose from
*/
@ApiMember(Description="The available week number options to choose from")
var WeekNumberOptions:ArrayList<WeekNumberSettingResponse> = ArrayList<WeekNumberSettingResponse>()
/**
* The booking template options to choose from
*/
@ApiMember(Description="The booking template options to choose from")
var BookingTemplateOptions:ArrayList<BookingTemplateResponse> = ArrayList<BookingTemplateResponse>()
/**
* The calendar type options to choose from
*/
@ApiMember(Description="The calendar type options to choose from")
var CalendarTypeOptions:ArrayList<CalendarTypeResponse> = ArrayList<CalendarTypeResponse>()
/**
* The booking status options to choose from
*/
@ApiMember(Description="The booking status options to choose from")
var BookingStatusOptions:ArrayList<BookingStatusOptions> = ArrayList<BookingStatusOptions>()
/**
* The free spot text options to choose from
*/
@ApiMember(Description="The free spot text options to choose from")
var FreeSpotTextOptions:ArrayList<FreeSpotTextsResponse> = ArrayList<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.")
var WeightedPrices:Boolean? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var ShowMultiDayAsTime:Boolean? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
var ShowMultipleResourcesAsOne:Boolean? = null
}
open class ScheduleViewResponse
{
var Id:Int? = null
var Name:String? = null
}
open class WeekNumberSettingResponse
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
}
open class BookingTemplateResponse
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
var UsedByApplication:String? = null
}
open class CalendarTypeResponse
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
var Active:Boolean? = null
}
open class BookingStatusOptions
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
}
open class FreeSpotTextsResponse
{
var Id:Int? = null
var TextSingular:String? = null
var TextPlural:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}