| 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. |
|---|
export class ScheduleViewResponse
{
public Id: number;
public Name: string;
public constructor(init?: Partial<ScheduleViewResponse>) { (Object as any).assign(this, init); }
}
export class WeekNumberSettingResponse
{
public Id: number;
public Name: string;
public Description: string;
public constructor(init?: Partial<WeekNumberSettingResponse>) { (Object as any).assign(this, init); }
}
export class BookingTemplateResponse
{
public Id: number;
public Name: string;
public Description: string;
public UsedByApplication: string;
public constructor(init?: Partial<BookingTemplateResponse>) { (Object as any).assign(this, init); }
}
export class CalendarTypeResponse
{
public Id: number;
public Name: string;
public Description: string;
public Active: boolean;
public constructor(init?: Partial<CalendarTypeResponse>) { (Object as any).assign(this, init); }
}
export class BookingStatusOptions
{
public Id: number;
public Name: string;
public Description: string;
public constructor(init?: Partial<BookingStatusOptions>) { (Object as any).assign(this, init); }
}
export class FreeSpotTextsResponse
{
public Id: number;
public TextSingular: string;
public TextPlural: string;
public constructor(init?: Partial<FreeSpotTextsResponse>) { (Object as any).assign(this, init); }
}
export class SettingResponse
{
public CompanyId: string;
/** @description */
// @ApiMember(DataType="int", Description="")
public BookingStatusId: number;
/** @description */
// @ApiMember(DataType="int", Description="")
public ScheduleViewId: number;
/** @description */
// @ApiMember(DataType="int", Description="")
public BookingTemplateId: number;
/** @description */
// @ApiMember(DataType="int", Description="")
public CalendarTypeId: number;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public AllowBookingOnUnbookedTimes: boolean;
/** @description */
// @DataMember(Name="SendEmailReminder")
// @ApiMember(DataType="boolean", Description="")
public SendEmailReminder: boolean;
/** @description */
// @DataMember(Name="SendSmsReminder")
// @ApiMember(DataType="boolean", Description="")
public SendSmsReminder: boolean;
/** @description */
// @DataMember(Name="SendEmailConfirmation")
// @ApiMember(DataType="boolean", Description="")
public SendEmailConfirmation: boolean;
/** @description */
// @DataMember(Name="SendSmsConfirmation")
// @ApiMember(DataType="boolean", Description="")
public SendSmsConfirmation: boolean;
/** @description 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 MessageText: string;
/** @description */
// @ApiMember(DataType="int", Description="")
public EmailReminderTime: number;
/** @description */
// @ApiMember(DataType="int", Description="")
public SmsReminderTime: number;
/** @description */
// @ApiMember(DataType="int", Description="")
public MaxActiveBookings: number;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public SendNotifications: boolean;
/** @description */
// @ApiMember(DataType="string", Description="")
public SendNotificationsEmail: string;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public EnableMobileApp: boolean;
/** @description */
// @ApiMember(Description="")
public ScheduleStartTime?: string;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public ScheduleEndTime?: string;
/** @description 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 ScheduleGroupResources: boolean;
/** @description 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 SchedulerDisableHorizontalScrolling: boolean;
/** @description */
// @ApiMember(DataType="string", Description="")
public ReceiptTemplate: string;
/** @description */
// @ApiMember(DataType="int", Description="")
public ScheduleTimeSlotMinutes: number;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public ShowFreeTimesLeft: boolean;
/** @description */
// @ApiMember(DataType="int", Description="")
public FreeSpotTextsId: number;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public EnableICalGroupBookings: boolean;
/** @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# */
// @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 AgreementTemplate: string;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public ScheduleShowTimeExeptions: boolean;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public EnableBookingsOnSameTime: boolean;
/** @description */
// @ApiMember(DataType="int", Description="")
public ShowWeekNumberSettingId: number;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public EnableShowBookedTimes: boolean;
/** @description */
// @ApiMember(DataType="", Description="")
public BookSpotUserResponseMinutes?: number;
/** @description */
// @ApiMember(DataType="", Description="")
public IsBookSpotDirectly: boolean;
/** @description */
// @ApiMember(DataType="", Description="")
public BookSpotDirectlyTimeLeftMinutes: number;
/** @description */
// @ApiMember(DataType="", Description="")
public SendEmailNotificationQueue?: boolean;
/** @description */
// @ApiMember(DataType="", Description="")
public SendSMSNotificationQueue?: boolean;
/** @description */
// @ApiMember(Description="")
public EnableSendFollowUpMessage: boolean;
/** @description 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 FollowUpMessageTime: number;
/** @description 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 BookOnlyOnExistingCustomers: boolean;
/** @description 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 AutoGenerateUniquePinCode: boolean;
/** @description 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 AutoCreateUserProfile: boolean;
/** @description The available schedule view options to choose from */
// @ApiMember(Description="The available schedule view options to choose from")
public ScheduleViewOptions: ScheduleViewResponse[];
/** @description The available week number options to choose from */
// @ApiMember(Description="The available week number options to choose from")
public WeekNumberOptions: WeekNumberSettingResponse[];
/** @description The booking template options to choose from */
// @ApiMember(Description="The booking template options to choose from")
public BookingTemplateOptions: BookingTemplateResponse[];
/** @description The calendar type options to choose from */
// @ApiMember(Description="The calendar type options to choose from")
public CalendarTypeOptions: CalendarTypeResponse[];
/** @description The booking status options to choose from */
// @ApiMember(Description="The booking status options to choose from")
public BookingStatusOptions: BookingStatusOptions[];
/** @description The free spot text options to choose from */
// @ApiMember(Description="The free spot text options to choose from")
public FreeSpotTextOptions: FreeSpotTextsResponse[];
/** @description 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 WeightedPrices: boolean;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public ShowMultiDayAsTime: boolean;
/** @description */
// @ApiMember(DataType="boolean", Description="")
public ShowMultipleResourcesAsOne: boolean;
public constructor(init?: Partial<SettingResponse>) { (Object as any).assign(this, init); }
}
// @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")
export class SettingQuery
{
/** @description 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 IncludeScheduleViewOptions: boolean;
/** @description 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 IncludeWeekNumberOptions: boolean;
/** @description 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 IncludeBookingTemplateOptions: boolean;
/** @description 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 IncludeCalendarTypeOptions: boolean;
/** @description 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 IncludeBookingStatusOptions: boolean;
/** @description 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 IncludeFreeSpotTextOptions: boolean;
public constructor(init?: Partial<SettingQuery>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /settings HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}