| 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 java.io.InputStream
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 privileges to call this service", StatusCode=403)
@ValidateRequest(Validator="IsAuthenticated")
open class BookingSettingQuery
{
/**
* 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")
open 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")
open 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")
open 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")
open 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")
open 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")
open var IncludeFreeSpotTextOptions:Boolean? = null
}
open class BookingSettingResponse
{
open var CompanyId:UUID? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var BookingStatusId:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var ScheduleViewId:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var BookingTemplateId:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var CalendarTypeId:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var AllowBookingOnUnbookedTimes:Boolean? = null
/**
*
*/
@DataMember(Name="SendEmailReminder")
@SerializedName("SendEmailReminder")
@ApiMember(DataType="boolean", Description="")
open var SendEmailReminder:Boolean? = null
/**
*
*/
@DataMember(Name="SendSmsReminder")
@SerializedName("SendSmsReminder")
@ApiMember(DataType="boolean", Description="")
open var SendSmsReminder:Boolean? = null
/**
*
*/
@DataMember(Name="SendEmailConfirmation")
@SerializedName("SendEmailConfirmation")
@ApiMember(DataType="boolean", Description="")
open var SendEmailConfirmation:Boolean? = null
/**
*
*/
@DataMember(Name="SendSmsConfirmation")
@SerializedName("SendSmsConfirmation")
@ApiMember(DataType="boolean", Description="")
open var SendSmsConfirmation:Boolean? = null
/**
* If the customer should receive Push notification when booked
*/
@ApiMember(DataType="boolean", Description="If the customer should receive Push notification when booked")
open var SendPushNotification:Boolean? = null
/**
* If the customer should receive Push notification reminders on bookings
*/
@ApiMember(DataType="boolean", Description="If the customer should receive Push notification reminders on bookings")
open var SendPushNotificationReminder:Boolean? = null
/**
* How many minutes before booking starts the customer should receive the notification
*/
@ApiMember(DataType="int", Description="How many minutes before booking starts the customer should receive the notification")
open var PushNotificationReminderTime:Int? = 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].")
open var MessageText:String? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var EmailReminderTime:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var SmsReminderTime:Int? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var MaxActiveBookings:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var SendNotifications:Boolean? = null
/**
*
*/
@ApiMember(DataType="string", Description="")
open var SendNotificationsEmail:String? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var EnableMobileApp:Boolean? = null
/**
*
*/
@ApiMember(Description="")
open var ScheduleStartTime:TimeSpan? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var ScheduleEndTime:TimeSpan? = null
/**
* The admin scheduler if each resources should be shown in a separate group
*/
@ApiMember(DataType="boolean", Description="The admin scheduler if each resources should be shown in a separate group")
open 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")
open var SchedulerDisableHorizontalScrolling:Boolean? = null
/**
*
*/
@ApiMember(DataType="string", Description="")
open var ReceiptTemplate:String? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var ScheduleTimeSlotMinutes:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var ShowFreeTimesLeft:Boolean? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var FreeSpotTextsId:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open 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#")
open var AgreementTemplate:String? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var ScheduleShowTimeExeptions:Boolean? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var EnableBookingsOnSameTime:Boolean? = null
/**
*
*/
@ApiMember(DataType="int", Description="")
open var ShowWeekNumberSettingId:Int? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var EnableShowBookedTimes:Boolean? = null
/**
*
*/
@ApiMember(DataType="", Description="")
open var BookSpotUserResponseMinutes:Int? = null
/**
*
*/
@ApiMember(DataType="", Description="")
open var IsBookSpotDirectly:Boolean? = null
/**
*
*/
@ApiMember(DataType="", Description="")
open var BookSpotDirectlyTimeLeftMinutes:Int? = null
/**
*
*/
@ApiMember(DataType="", Description="")
open var SendEmailNotificationQueue:Boolean? = null
/**
*
*/
@ApiMember(DataType="", Description="")
open var SendSMSNotificationQueue:Boolean? = null
/**
*
*/
@ApiMember(Description="")
open 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.")
open 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")
open 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")
open 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.")
open var AutoCreateUserProfile:Boolean? = null
/**
* The available schedule view options to choose from
*/
@ApiMember(Description="The available schedule view options to choose from")
open var ScheduleViewOptions:ArrayList<ScheduleViewResponse>? = null
/**
* The available week number options to choose from
*/
@ApiMember(Description="The available week number options to choose from")
open var WeekNumberOptions:ArrayList<WeekNumberSettingResponse>? = null
/**
* The booking template options to choose from
*/
@ApiMember(Description="The booking template options to choose from")
open var BookingTemplateOptions:ArrayList<BookingTemplateResponse>? = null
/**
* The calendar type options to choose from
*/
@ApiMember(Description="The calendar type options to choose from")
open var CalendarTypeOptions:ArrayList<CalendarTypeResponse>? = null
/**
* The booking status options to choose from
*/
@ApiMember(Description="The booking status options to choose from")
open var BookingStatusOptions:ArrayList<BookingStatusOptions>? = null
/**
* The free spot text options to choose from
*/
@ApiMember(Description="The free spot text options to choose from")
open var FreeSpotTextOptions:ArrayList<FreeSpotTextsResponse>? = null
/**
* 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.")
open var WeightedPrices:Boolean? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var ShowMultiDayAsTime:Boolean? = null
/**
*
*/
@ApiMember(DataType="boolean", Description="")
open var ShowMultipleResourcesAsOne:Boolean? = null
/**
* If booking should be restricted by a pin code
*/
@ApiMember(Description="If booking should be restricted by a pin code")
open var BookingPinCodeRestriction:String? = null
/**
* If checked customer invoice will be required when creating booking
*/
@ApiMember(Description="If checked customer invoice will be required when creating booking")
open var CustomerInvoiceAdressRequired:Boolean? = null
}
open class ScheduleViewResponse
{
open var Id:Int? = null
open var Name:String? = null
}
open class WeekNumberSettingResponse
{
open var Id:Int? = null
open var Name:String? = null
open var Description:String? = null
}
open class BookingTemplateResponse
{
open var Id:Int? = null
open var Name:String? = null
open var Description:String? = null
open var UsedByApplication:String? = null
}
open class CalendarTypeResponse
{
open var Id:Int? = null
open var Name:String? = null
open var Description:String? = null
open var Active:Boolean? = null
}
open class BookingStatusOptions
{
open var Id:Int? = null
open var Name:String? = null
open var Description:String? = null
}
open class FreeSpotTextsResponse
{
open var Id:Int? = null
open var TextSingular:String? = null
open var TextPlural:String? = null
}
Kotlin BookingSettingQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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.bookmore.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BookingSettingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AgreementTemplate>String</AgreementTemplate>
<AllowBookingOnUnbookedTimes>false</AllowBookingOnUnbookedTimes>
<AutoCreateUserProfile>false</AutoCreateUserProfile>
<AutoGenerateUniquePinCode>false</AutoGenerateUniquePinCode>
<BookOnlyOnExistingCustomers>false</BookOnlyOnExistingCustomers>
<BookSpotDirectlyTimeLeftMinutes>0</BookSpotDirectlyTimeLeftMinutes>
<BookSpotUserResponseMinutes>0</BookSpotUserResponseMinutes>
<BookingPinCodeRestriction>String</BookingPinCodeRestriction>
<BookingStatusId>0</BookingStatusId>
<BookingStatusOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d2p1:BookingStatusOptions>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:BookingStatusOptions>
</BookingStatusOptions>
<BookingTemplateId>0</BookingTemplateId>
<BookingTemplateOptions>
<BookingTemplateResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
<UsedByApplication>String</UsedByApplication>
</BookingTemplateResponse>
</BookingTemplateOptions>
<CalendarTypeId>0</CalendarTypeId>
<CalendarTypeOptions>
<CalendarTypeResponse>
<Active>false</Active>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</CalendarTypeResponse>
</CalendarTypeOptions>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CustomerInvoiceAdressRequired>false</CustomerInvoiceAdressRequired>
<EmailReminderTime>0</EmailReminderTime>
<EnableBookingsOnSameTime>false</EnableBookingsOnSameTime>
<EnableICalGroupBookings>false</EnableICalGroupBookings>
<EnableMobileApp>false</EnableMobileApp>
<EnableSendFollowUpMessage>false</EnableSendFollowUpMessage>
<EnableShowBookedTimes>false</EnableShowBookedTimes>
<FollowUpMessageTime>0</FollowUpMessageTime>
<FreeSpotTextOptions>
<FreeSpotTextsResponse>
<Id>0</Id>
<TextPlural>String</TextPlural>
<TextSingular>String</TextSingular>
</FreeSpotTextsResponse>
</FreeSpotTextOptions>
<FreeSpotTextsId>0</FreeSpotTextsId>
<IsBookSpotDirectly>false</IsBookSpotDirectly>
<MaxActiveBookings>0</MaxActiveBookings>
<MessageText>String</MessageText>
<PushNotificationReminderTime>0</PushNotificationReminderTime>
<ReceiptTemplate>String</ReceiptTemplate>
<ScheduleEndTime>PT0S</ScheduleEndTime>
<ScheduleGroupResources>false</ScheduleGroupResources>
<ScheduleShowTimeExeptions>false</ScheduleShowTimeExeptions>
<ScheduleStartTime>PT0S</ScheduleStartTime>
<ScheduleTimeSlotMinutes>0</ScheduleTimeSlotMinutes>
<ScheduleViewId>0</ScheduleViewId>
<ScheduleViewOptions>
<ScheduleViewResponse>
<Id>0</Id>
<Name>String</Name>
</ScheduleViewResponse>
</ScheduleViewOptions>
<SchedulerDisableHorizontalScrolling>false</SchedulerDisableHorizontalScrolling>
<SendEmailConfirmation>false</SendEmailConfirmation>
<SendEmailNotificationQueue>false</SendEmailNotificationQueue>
<SendEmailReminder>false</SendEmailReminder>
<SendNotifications>false</SendNotifications>
<SendNotificationsEmail>String</SendNotificationsEmail>
<SendPushNotification>false</SendPushNotification>
<SendPushNotificationReminder>false</SendPushNotificationReminder>
<SendSMSNotificationQueue>false</SendSMSNotificationQueue>
<SendSmsConfirmation>false</SendSmsConfirmation>
<SendSmsReminder>false</SendSmsReminder>
<ShowFreeTimesLeft>false</ShowFreeTimesLeft>
<ShowMultiDayAsTime>false</ShowMultiDayAsTime>
<ShowMultipleResourcesAsOne>false</ShowMultipleResourcesAsOne>
<ShowWeekNumberSettingId>0</ShowWeekNumberSettingId>
<SmsReminderTime>0</SmsReminderTime>
<WeekNumberOptions>
<WeekNumberSettingResponse>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</WeekNumberSettingResponse>
</WeekNumberOptions>
<WeightedPrices>false</WeightedPrices>
</BookingSettingResponse>