BokaMera.API.Host

<back to all web services

GroupedBookingQuery

Requires Authentication
The following routes are available for this service:
GET/bookings/groupedFind booked events for currently logged in user grouped by booking from dateThis service is used to get bookings for the current user, the result will grouped by the bookings fromm date and paged if the query returns a to large set of values.
GroupedBookingQuery Parameters:
NameParameterData TypeRequiredDescription
BookingResourceRelationResourceIdsqueryint[]NoQuery for specific Booked Resources, default is all resources
BookingResourceRelationResourceTypeIdsqueryint[]NoQuery for specific Booked Resource types, default is all resource types
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
Idpathint?NoId of the booking
BookingStartquerydateTimeNoStart of interval to query for bookings. UTC+0 and parameter as defined by date-time - RFC3339
BookingEndquerydateTimeNoEnd of interval to query for bookings. UTC+0 and parameter as defined by date-time - RFC3339
CompanyBookingsquerybooleanNoSet to true if you want to include all bookings for the company. Only administrators are allowed to do this.
IncludeStatusesqueryint[]NoQuery for specific booking statuses. Valid statuses are TimeBooked = 1, TimeUnbooked = 2, TimeReserved = 3, TimeCanceled = 4. Default is 1,3 for active statuses.
IncludeCustomFieldsquerybooleanNoIf you want to include the connected resourcetypes and resources
IncludeCustomFieldValuesquerybooleanNoIf you want to include the connected custom fields
IncludePriceInformationquerybooleanNoIf you want to include the price information on the booking
IncludeStatusInformationquerybooleanNoIf you want to include booking status information
IncludePaymentLogquerybooleanNoIf you want to include the payment log on the booking
IncludeCheckoutsquerybooleanNoIf you want to include the checkouts for payson
IncludeBookedResourceTypesquerybooleanNoIf you want to include the booked resourcetypes and it's booked resources
IncludeCompanyInformationquerybooleanNoIf you want to include the company information for the booking
IncludeCustomerInformationquerybooleanNoIf you want to include the customer information for the booking
CreatedFromquerydateTimeNoStart of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
CreatedToquerydateTimeNoEnd of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
StatusIdsqueryint[]NoQuery for specific booking statuses. Valid statuses are TimeBooked = 1, TimeUnbooked = 2, TimeReserved = 3, TimeCanceled = 4, AwaitingPayment = 5, AwaitingPaymentNoTimeLimit = 6, BookedAndPayed = 7, 8 = AwaitingPaymentRequestFromAdmin, 9 = AwaitingPaymentFromProvider. Default is all.
CustomerIdqueryGuid?NoQuery for specific customer
MaxLimitqueryintNoThe max limit of records you want to retrieve, default is 100
ResponseStatusqueryResponseStatusNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
Booking Parameters:
NameParameterData TypeRequiredDescription
CustomerformCustomerNo
ServiceformServiceNo
CalendarExportformCalendarExportNo
LogformList<BookingLog>No
PaymentLogformList<PaymentLog>No
CheckoutLogsformList<PaymentDetails>No
PricesformList<BookingPrice>No
StatusformBookingStatusEnumNo
isReservedformboolNo
StatusNameformstringNo
CompanyformCompanyNo
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
BookingStatusformBookingStatusNo
TotalPriceformdouble?No
TotalSpotsformint?No
ResourcesformIList<Resource>No
ExternalReferencesformIList<ExternalReference>No
BookedResourcesformIList<BookedResourceType>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
ActiveformboolNo
LastTimeToUnBookformDateTime?No
PriceMappingsformList<PriceMapping>No
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
CompanyIdformGuidYes
IdformintNo
CustomerIdformGuidYes
ServiceIdformintYes
StatusIdformintYes
UnbookedOnformDateTime?No
UnbookedCommentsformstringNo
BookedCommentsformstringNo
BookedByformstringYes
UnBookedByformstringNo
SendSmsReminderformboolYes
SendEmailReminderformboolYes
SendSmsConfirmationformboolYes
RebateCodeformstringNo
CommentsformstringNo
IpAddressformstringNo
NumberOfBookedSpotsformintYes
CommentsToCustomerformstringNo
PaymentExpirationformDateTime?No
PriceVatformdecimal?No
SendEmailConfirmationformboolYes
CancellationCodeformstringNo
ModifiedDateformDateTimeOffset?No
RatingCodeformstringNo
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
FromformDateTimeYes
ToformDateTimeYes
Customer Parameters:
NameParameterData TypeRequiredDescription
IdentityIdformintNo
IdformGuidNo
CustomerIdformGuidNo
AccessKeysformIList<UserAccessKeys>No
EmailformstringNo
ExternalReferencesformIList<ExternalReference>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
CommentsformIList<CustomerComment>No
FirstnameformstringNo
ImageUrlformstringNo
ActiveformboolYes
FacebookUsernameformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
IpAddressformstringNo
PinCodeformstringNo
CardIdformstringNo
ModifiedDateformDateTimeOffset?No
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
UserIdformGuidNo
LastnameformstringNo
PhoneformstringNo
CompanyIdformGuidYes
SubscribedToNewsletterformboolNo
UserAccessKeys Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
AccessKeyTypeIdformintYes
ValueformstringYes
CustomerIdformGuidYes
DescriptionformstringNo
IdformGuidYes
ExternalReference Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformGuidYes
OwnerIdformGuidYes
ReferenceTypeformstringYes
ExternalDataformstringNo
CreatedByformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
CustomFieldConfig Parameters:
NameParameterData TypeRequiredDescription
ValuesformList<CustomFieldValue>No
CustomFieldformCustomFieldNo
RegExformRegExNo
ServicesformList<Service>No
CustomFieldServiceRelationformList<CustomFieldServiceRelation>No
CompanyIdformGuidYes
IdformintNo
GroupIdformint?No
FieldIdformintYes
IconIdformintYes
RegExIdformint?No
NameformstringYes
DescriptionformstringYes
DatatypeformstringYes
MaxLengthformintYes
IsPublicformboolYes
IsHiddenformboolYes
IsMandatoryformboolYes
DefaultValueformstringNo
RegExErrorMessageformstringNo
MandatoryErrorMessageformstringNo
Widthformint?No
MultipleLineTextformboolYes
ModifiedDateformDateTimeOffset?No
CustomFieldValue Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
ValueformstringYes
ActiveformboolYes
SortOrderformshort?No
ModifiedDateformDateTimeOffset?No
CustomField Parameters:
NameParameterData TypeRequiredDescription
TableformstringYes
ColumnformstringYes
DataTypeformstringYes
DescriptionformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
RegEx Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
RegExCodeformstringYes
ErrorMessageformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
Service Parameters:
NameParameterData TypeRequiredDescription
ResourceTypesformList<ResourceType>No
ResourcesformIEnumerable<Resource>No
TotalPriceformTotalPriceInformationNo
PricesformList<ServicePrice>No
BookingStatusOptionsformList<BookingStatusOptions>No
IsGroupBookingformboolNo
IsMultipleResourceformboolNo
SettingsformBookingSettingsNo
PaymentSettingformPaymentSettingNo
BookingCustomFieldsConfigformIList<CustomFieldConfig>No
CustomerCustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
SchedulesformIList<ISchedule>No
CustomerActiveBookingsformIList<Booking>No
ScheduleTypeformScheduleTypeNo
LastTimeToUnbookThresholdformTimeSpanNo
LastTimeToBookThresholdformTimeSpanNo
RatingScoreformAverageRatingScoreNo
RatingsformList<Rating>No
CompanyIdformGuidYes
IdformintNo
NameformstringYes
DescriptionformstringYes
GroupformstringNo
ActiveformboolYes
SortOrderformintYes
PauseAfterBookingformintYes
UnbookBeforeDaysformintYes
UnbookBeforeHoursformintYes
UnbookBeforeMinutesformintYes
BookBeforeDaysformintYes
BookBeforeHoursformintYes
BookBeforeMinutesformintYes
Durationformint?No
TotalSpotsformint?No
ImageUrlformstringNo
ScheduleTypeIdformintYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
OnlyVisibleByAdminformboolYes
MaxNumberOfSpotsPerBookingformintYes
MinNumberOfResourcesToBookformintYes
MaxNumberOfResourcesToBookformintYes
IsPaymentEnabledformboolYes
MaxPaymentTimeformintYes
LockSpotsToBookingformboolYes
EnableBookingQueueformboolYes
ModifiedDateformDateTimeOffset?No
BookingStatusIdformintYes
EnableCodeLockSyncformboolYes
EnableCustomerManualPaymentformboolYes
PriceViewTypeIdformint?No
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
ResourceType Parameters:
NameParameterData TypeRequiredDescription
SelectableByUserformboolNo
ResourcesformList<Resource>No
CompanyIdformGuidYes
IdformintNo
NameformstringYes
DescriptionformstringNo
ActiveformboolYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
Resource Parameters:
NameParameterData TypeRequiredDescription
PriorityformintNo
SchedulesformIList<ISchedule>No
ExceptionsformIList<ITimeException>No
BookingsformIList<IBookedTime>No
ActiveBookingsformIList<IBookedTime>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
CompanyIdformGuidYes
IdformintNo
NameformstringYes
ActiveformboolYes
DescriptionformstringNo
ImageUrlformstringNo
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ColorformstringYes
EmailformstringNo
MobilePhoneformstringNo
EmailNotificationformbool?No
SMSNotificationformbool?No
SendSMSReminderformboolYes
SendEmailReminderformboolYes
ModifiedDateformDateTimeOffset?No
AccessGroupformstringNo
TextField1formstringNo
TextField2formstringNo
TextField3formstringNo
TextField4formstringNo
TextField5formstringNo
TextField6formstringNo
TextField7formstringNo
TextField8formstringNo
TextField9formstringNo
TextField10formstringNo
TextField11formstringNo
TextField12formstringNo
TextField13formstringNo
TextField14formstringNo
TextField15formstringNo
TextField16formstringNo
TextField17formstringNo
TextField18formstringNo
TextField19formstringNo
TextField20formstringNo
ISchedule Parameters:
NameParameterData TypeRequiredDescription
ResourcesformIList<Resource>No
TypeformScheduleTypeNo
ActiveformboolNo
IsResourceSpecificformboolNo
ScheduleType Enum:
NotDefined
RecurringSchedule
DateSchedule
ITimeException Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ReasonTextformstringNo
IsBlockformboolNo
ReasonTextPublicformstringNo
IsRecurringformboolNo
ResourceIdsformint[]No
IBookedTime Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ServiceIdformintNo
BookedSpotsformintNo
TotalSpotsformintNo
PauseAfterInMinutesformintNo
StatusformBookingStatusEnumNo
StatusIdformintNo
CustomerformBookedCustomerNo
BookingStatusEnum Enum:
NameValue
Booked1
Unbooked2
Reserved3
Canceled4
AwaitingPayment5
AwaitingPaymentNoTimeLimit6
Payed7
AwaitingPaymentRequestFromAdmin8
AwaitingPaymentFromProvider9
BookedCustomer Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
PhoneformstringNo
FacebookUserNameformstringNo
ImageUrlformstringNo
CustomFieldDataResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ColumnformstringNo
NameformstringNo
DescriptionformstringNo
ValueformstringNo
DataTypeformstringNoData field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
TotalPriceInformation Parameters:
NameParameterData TypeRequiredDescription
TotalPriceformdoubleNo
TotalVATAmountformdoubleNo
TotalRebateformdoubleNo
TotalPriceBeforeRebateformdoubleNo
AppliedCodesformList<AppliedRebateCodes>No
CurrencyIdformstringNo
VATformdecimalNo
AppliedRebateCodes Parameters:
NameParameterData TypeRequiredDescription
RebateCodeIdformintNo
RebateCodeSignformstringNo
RebateCodeValueformintNo
RebateAmountformdoubleNo
RebateCodeTypeformRebateCodeTypeNo
RebateCodeType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
ServicePrice Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
ServiceformServiceNo
PriceMappingsformList<PriceMapping>No
isTimeSpecificformboolNo
isDaysOfWeekSpecificformboolNo
DayOfWeeksformList<ServicePriceDayOfWeekRelation>No
PriceBeforeRebateformdouble?No
RebateCodesAppliedformList<RebateCode>No
PriceTextformstringNo
IsWeightedformboolNo
OverlappingPricesformList<ServicePrice>No
CompanyIdformGuidYes
IdformintNo
ServiceIdformintYes
Priceformdouble?No
UpdatedformDateTimeYes
CreatedformDateTimeYes
FromTimeformTimeSpanYes
ToTimeformTimeSpanYes
VATformdecimalYes
CategoryformstringNo
ModifiedDateformDateTimeOffset?No
FromformDateTimeYes
ToformDateTimeYes
Currency Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
CurrencySignformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformstringYes
PriceMapping Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformGuidYes
PriceIdformintYes
ReferenceTypeformstringNo
ExternalReferenceformstringNo
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
ServicePriceDayOfWeekRelation Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformBokaMeraDayOfWeekNo
CompanyIdformGuidYes
ServicePriceIdformintYes
DayOfWeekIdformintYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BokaMeraDayOfWeek Enum:
NameValue
Monday1
Tuesday2
Wednesday3
Thursday4
Friday5
Saturday6
Sunday7
RebateCode Parameters:
NameParameterData TypeRequiredDescription
RebateCodeTypeIdformintNo
RebateCodeTypeInfoformRebateCodeTypeNo
RebateCodeStatusIdformintNo
RebateCodeStatusInfoformRebateCodeTypeNo
ServicesformList<Service>No
RebateCodeDayOfWeekRelationformList<RebateCodeDayOfWeekRelation>No
RebateCodeServiceRelationformList<RebateCodeServiceRelation>No
RebateCodeBookingPriceRelationformList<RebateCodeBookingPriceRelation>No
RebateCodeCustomerRelationformList<RebateCodeCustomerRelation>No
DaysOfWeekformList<DaysOfWeek>No
CustomersformList<Customer>No
RebateCodeStatusformRebateCodeStatusNo
RebateCodeTypeformRebateCodeTypeNo
CurrentNumberOfUsesPerCustomerformintNo
IsSpecificByDayOfWeekformboolNo
ActiveformboolNo
CompanyIdformGuidNo
ValidFromformDateTimeYes
ValidToformDateTimeYes
RebateCodeSignformstringYes
RebateCodeValueformintYes
MaxNumberOfUsesformintYes
MaxNumberOfUsesPerCustomerformintYes
NumberOfUsesUsedformintYes
PersonalNoteformstringNo
CreatedByformstringYes
CreatedformDateTimeYes
UpdatedByformstringYes
UpdatedformDateTimeYes
FromTimeformTimeSpanYes
ToTimeformTimeSpanYes
ModifiedDateformDateTimeOffset?No
IdformintNo
RebateCodeDayOfWeekRelation Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformBokaMeraDayOfWeekNo
DayOfWeekIdformintYes
RebateCodeIdformintYes
CompanyIdformGuidYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
ServiceIdformintYes
RebateCodeIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeBookingPriceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
PriceIdformintYes
RebateCodeIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
RebateCodeCustomerRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
CustomerIdformGuidYes
RebateCodeIdformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
DaysOfWeek Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformstringYes
DayOfWeekTranslationformstringYes
DayOfWeekActiveformbool?No
DayOfWeekSortOrderformshort?No
ModifiedDateformDateTimeOffset?No
IdformintNo
RebateCodeStatus Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
BookingStatusOptions Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
BookingSettings Parameters:
NameParameterData TypeRequiredDescription
FreeSpotTextsIdformintNo
SendEmailConfirmationformboolNo
ScheduleViewOptionsformList<ScheduleView>No
WeekNumberSettingOptionsformList<WeekNumberSetting>No
BookingTemplateOptionsformList<BookingTemplate>No
CalendarTypeOptionsformList<CalendarType>No
FreeSpotTextOptionsformList<FreeSpotTexts>No
BookingStatusOptionsformList<BookingStatusOptions>No
FreeSpotTextsInfoformFreeSpotTextsNo
FreeSpotsTextSingularformstringNo
FreeSpotsTextPluralformstringNo
BookingStatusIdformintYes
ScheduleViewIdformintYes
BookingTemplateIdformintYes
CalendarTypeIdformintYes
AllowBookingOnUnbookedTimesformboolYes
SendEmailReminderformboolYes
SendSmsReminderformboolYes
SendSmsConfirmationformboolYes
EmailReminderTimeformintYes
SmsReminderTimeformintYes
MaxActiveBookingsformintYes
SendNotificationsformboolYes
SendNotificationsEmailformstringNo
EnableMobileAppformboolYes
ScheduleStartTimeformTimeSpan?No
ScheduleEndTimeformTimeSpan?No
ReceiptTemplateformstringNo
ScheduleTimeSlotMinutesformintYes
ShowFreeTimesLeftformboolYes
EnableICalGroupBookingsformboolYes
AgreementTemplateformstringNo
ScheduleShowTimeExeptionsformboolYes
EnableBookingsOnSameTimeformboolYes
ShowWeekNumberSettingIdformintYes
EnableShowBookedTimesformboolYes
EnableSendFollowUpMessageformboolYes
FollowUpMessageTimeformintYes
MessageTextformstringNo
ScheduleGroupResourcesformboolYes
BookSpotUserResponseMinutesformintYes
IsBookSpotDirectlyformboolYes
BookSpotDirectlyTimeLeftMinutesformintYes
SendEmailNotificationQueueformboolYes
SendSMSNotificationQueueformboolYes
SchedulerDisableHorizontalScrollingformboolYes
BookOnlyOnExistingCustomersformboolYes
AutoGenerateUniquePinCodeformboolYes
WeightedPricesformboolYes
ModifiedDateformDateTimeOffset?No
AutoCreateUserProfileformboolYes
ShowMultipleResourcesAsOneformboolNo
ShowMultiDayAsTimeformboolNo
IdformGuidYes
ScheduleView Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
WeekNumberSetting Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
BookingTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
UsedByApplicationformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
CalendarType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
FreeSpotTexts Parameters:
NameParameterData TypeRequiredDescription
TextSingularformstringYes
TextPluralformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
PaymentSetting Parameters:
NameParameterData TypeRequiredDescription
AdminPaymentOptionformAdminPaymentOptionsNo
AdminPaymentOptionsformList<AdminPaymentOptions>No
PaymentProviderOptionsformList<PaymentProviders>No
EnabledformboolYes
InvoiceFeeformintYes
AllowCreditCardPaymentformboolYes
AllowInvoicePaymentformboolYes
AllowBankPaymentformboolYes
GuaranteeOfferedformboolYes
RefundOnCancelBookingformboolYes
DefaultPaymentOptionIdformint?No
PaymentProviderIdformintYes
SendPaymentRequestDirectlyformboolYes
ModifiedDateformDateTimeOffset?No
IdformGuidYes
AdminPaymentOptions Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
PaymentProviders Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CategoryformstringYes
UrlformstringNo
ActiveformboolYes
ModifiedDateformDateTimeOffset?No
IdformintYes
AverageRatingScore Parameters:
NameParameterData TypeRequiredDescription
AverageScoreformdoubleNo
Score1CountformintNo
Score2CountformintNo
Score3CountformintNo
Score4CountformintNo
Score5CountformintNo
CountformintNo
Rating Parameters:
NameParameterData TypeRequiredDescription
ReviewIdformGuid?No
ReviewformReviewNo
CompanyIdformGuidYes
BookingIdformintYes
RatingScoreformintYes
StatusformintYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
Review Parameters:
NameParameterData TypeRequiredDescription
ReviewIdformGuidNo
CompanyIdformGuidYes
TitleformstringYes
DescriptionformstringYes
AuthorformstringYes
StatusformintYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
ReviewAnswerformstringNo
CustomFieldServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomFieldConfigIdformintYes
ServiceIdformintYes
ModifiedDateformDateTimeOffset?No
CustomerComment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomerIdformGuidYes
CommentsformstringYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
ImageUrlformstringNo
ModifiedDateformDateTimeOffset?No
CalendarExport Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
BookingIdformintYes
ExceptionIdformintYes
CalendarSyncformbool?No
CalendarIdformstringNo
IsExceptionDeletedformbool?No
ModifiedDateformDateTimeOffset?No
IdformintNo
BookingLog Parameters:
NameParameterData TypeRequiredDescription
EventTypeIdformintNo
EventTypeformBookingLogEventTypeNo
CompanyIdformGuidYes
BookingIdformintYes
IdformintNo
CommentsformstringNo
UserIdformstringNo
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
BookingLogEventType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
PaymentLog Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
CompanyIdformGuidYes
IdformintNo
BookingIdformintYes
PaymentReferenceIdformstringNo
PaymentProviderIdformint?No
OrderItemReferenceIdformstringNo
Amountformdouble?No
VATformdecimal?No
AmountCreditedformdouble?No
CommentsformstringNo
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
QvicklyCheckoutSerializedformQvicklyCheckoutResponseNo
Payson2CheckoutSerializedformPayson2CheckoutResponseNo
CompanyIdformGuidYes
BookingIdformintYes
ExternalResponseDataformstringYes
ExternalResponseReferenceformstringYes
PaymentProviderIdformintYes
IsPaymentformboolYes
CreatedDateformDateTimeYes
UpdatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
QvicklyCheckoutResponse Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
StatusformstringNo
OrderIdformstringNo
UrlformstringNo
Payson2CheckoutResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
ExpirationTimeformDateTime?No
SnippetformstringNo
StatusformPayson2CheckoutStatusNo
CustomerformCustomerNo
OrderformOrderNo
MerchantformMerchantNo
GuiformGuiNo
HistoryformHistoryNo
PurchaseIdformint?No
Payson2CheckoutStatus Enum:
None
Created
FormsFilled
ReadyToPay
ProcessingPayment
ReadyToShip
Shipped
PaidToAccount
Canceled
Credited
Expired
Denied
Customer Parameters:
NameParameterData TypeRequiredDescription
CityformstringNo
CountryCodeformstringNo
IdentityNumberformstringNo
EmailformstringNo
FirstNameformstringNo
LastNameformstringNo
PhoneformstringNo
PostalCodeformstringNo
StreetformstringNo
ReferenceformstringNo
TypeformCustomerTypeNo
CustomerType Enum:
Person
Business
Order Parameters:
NameParameterData TypeRequiredDescription
CurrencyformCurrencyNo
TotalFeeExcludingTaxformdecimalNo
TotalFeeIncludingTaxformdecimalNo
TotalPriceExcludingTaxformdecimalNo
TotalPriceIncludingTaxformdecimalNo
TotalTaxAmountformdecimalNo
TotalCreditedAmountformdecimalNo
ItemsformIList<Item>No
Currency Enum:
NameValue
SEK1
EUR2
Item Parameters:
NameParameterData TypeRequiredDescription
ItemIdformGuidNo
DiscountRateformdecimalNo
EanformstringNo
ImageUriformUriNo
NameformstringNo
QuantityformdecimalNo
ReferenceformstringNo
TaxRateformdecimalNo
TotalPriceExcludingTaxformdecimalNo
TotalPriceIncludingTaxformdecimalNo
TotalTaxAmountformdecimalNo
CreditedAmountformdecimalNo
TypeformItemTypeNo
UnitPriceformdecimalNo
UriformUriNo
ItemType Enum:
Physical
Service
Fee
Discount
Merchant Parameters:
NameParameterData TypeRequiredDescription
CheckoutUriformUriNo
ConfirmationUriformUriNo
NotificationUriformUriNo
ValidationUriformUriNo
TermsUriformUriNo
ReferenceformstringNo
PartnerIdformstringNo
Gui Parameters:
NameParameterData TypeRequiredDescription
ColorSchemeformColorSchemeNo
LocaleformstringNo
RequestPhoneformboolNo
PhoneOptionalformboolNo
ColorScheme Enum:
White
Blue
Gray
GrayTextLogos
BlueTextLogos
WhiteTextLogos
WhiteNoFooter
GrayNoFooter
BlueNoFooter
History Parameters:
NameParameterData TypeRequiredDescription
CreatedformDateTime?No
ReadyToPayformDateTime?No
ReadyToShipformDateTime?No
ShippedformDateTime?No
PaidToAccountformDateTime?No
CanceledformDateTime?No
ExpiredformDateTime?No
DeniedformDateTime?No
BookingPrice Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
PriceIdformint?No
CurrencyInfoformCurrencyNo
PriceTextformstringNo
AppliedCodesformList<AppliedRebateCodes>No
IsRebateformboolNo
IsRebateCalculatedformboolNo
CompanyIdformGuidYes
BookingIdformintYes
QuantityformintYes
Priceformdouble?No
VATformdecimal?No
CategoryformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
InvoicedformboolYes
OccupiesSpotformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
Company Parameters:
NameParameterData TypeRequiredDescription
StatusformCompanyStatusNo
ActiveformboolNo
CustomerCustomFieldsConfigformIList<CustomFieldConfig>No
BookingAgreementsformstringNo
BookingSettingsformBookingSettingsNo
CompanyTypeformCompanyTypeNo
CodeLockSettingsformCodeLockSettingNo
PaymentSettingsformPaymentSettingNo
SettingsformCompanySettingNo
WidgetSettingsformHomepageWidgetSettingNo
HomepageSettingsformHomepageSettingNo
RatingScoreformAverageRatingScoreNo
RatingsformList<Rating>No
Distanceformdouble?No
LicensesformList<License>No
ActiveLicensesformList<License>No
CurrentLicenseformLicenseNo
IsFreeAccountformboolNo
DefaultLanguageformCultureInfoNo
CategoryformCompanyCategoryNo
LatformdoubleNo
LonformdoubleNo
IsFavoriteformboolNo
ExternalReferencesformIList<ExternalReference>No
OrganisationNumberformstringYes
StatusIdformintYes
CategoryIdformintYes
SitePathformstringYes
NameformstringYes
Street1formstringNo
Street2formstringNo
ZipCodeformstringNo
CityformstringNo
OpeningHoursformstringNo
FaxNumberformstringNo
EmailformstringYes
PhoneformstringNo
DetailsformstringNo
LogoTypeformstringNo
ApprovedByAdminformboolYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
IpAddressformstringNo
HomepageformstringNo
DomainNameformstringNo
CountryIdformstringYes
CompanyOwnerIdformintYes
TypeIdformint?No
ModifiedDateformDateTimeOffset?No
IdformGuidYes
CompanyStatus Enum:
NameValue
Registered1
AwaitingApproval2
Approved3
Inactive4
ClosedDown5
NotApproved6
CompanyType Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
CodeLockSetting Parameters:
NameParameterData TypeRequiredDescription
CodeLockSystemOptionsformList<CodeLockSystem>No
ActiveformboolYes
CodeLockSystemsIdformintYes
ValidBeforeMinutesformintYes
ValidAfterMinutesformintYes
DeleteOldByScheduleformboolYes
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
SendEmailNotificationformboolYes
SendSMSNotificationformboolYes
EmailNotificationTimeformshortYes
SMSNotificationTimeformshortYes
IdformGuidYes
CodeLockSystem Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
SupplierformstringYes
LogoTypeformstringNo
DescriptionformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
CompanySetting Parameters:
NameParameterData TypeRequiredDescription
LanguagesformList<LanguageResponse>No
ActiveformboolYes
InactiveMessageformstringNo
SearchableformboolYes
GATrackingIdformstringNo
FacebookPixelIdformstringNo
MultiLanguageformboolYes
EnableAPITranslationformboolYes
DefaultLanguageformstringYes
ModifiedDateformDateTimeOffset?No
GTMTrackingIdformstringNo
ShowOnMarketPlaceformboolYes
GoogleAdsConversionIdformstringNo
LinkedinTagIdformstringNo
GoogleAdsConversionLabelformstringNo
IdformGuidYes
LanguageResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
HomepageWidgetSetting Parameters:
NameParameterData TypeRequiredDescription
WidgetServiceLayoutOptionsformList<WidgetServiceLayouts>No
WidgetTimeLayoutOptionsformList<WidgetTimeLayouts>No
WidgetBookingLayoutOptionsformList<WidgetBookingLayouts>No
WidgetBookingMethodOptionsformList<WidgetBookingMethods>No
ServiceLayoutIdformintYes
TimeLayoutIdformintYes
BookingLayoutIdformintYes
PrimaryColorformstringYes
ShowServiceImageformboolYes
ShowNextAvailableTimeformboolYes
ShowEndTimeformboolYes
BookedTimeSlotTextformstringNo
DarkThemeformboolYes
ShowRebateCodeFieldformboolYes
ModifiedDateformDateTimeOffset?No
EnableCreateAccountformboolYes
EnableLoginformboolYes
EnableDirectBookingformboolYes
EnableFacebookLoginformboolYes
IdformGuidYes
WidgetServiceLayouts Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
WidgetTimeLayouts Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
WidgetBookingLayouts Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
WidgetBookingMethods Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
CodeformstringYes
ModifiedDateformDateTimeOffset?No
IdformintYes
HomepageSetting Parameters:
NameParameterData TypeRequiredDescription
HomepageTemplateOptionsformList<HomepageTemplate>No
HomepageHeroSectionStyleOptionsformList<HeroSectionStyle>No
CompanyIdformGuid?No
WelcomePageHeadingformstringNo
WelcomePageBodyformstringNo
AboutUsPageHeadingformstringNo
AboutUsPageBodyformstringNo
HomePageTemplateIdformintYes
ImageUrlformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
HomepageHeadingformstringNo
HeroSectionStyleIdformintYes
ModifiedDateformDateTimeOffset?No
ShowRatingformboolYes
EnableHomepageformboolYes
IdformGuidYes
HomepageTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ImageUrlformUriNo
PremiumformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
HeroSectionStyle Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintYes
License Parameters:
NameParameterData TypeRequiredDescription
TypeformLicenseTypeNo
CompanyIdformGuidYes
IdformintNo
TypeIdformintYes
ValidFromformDateTimeYes
ValidToformDateTimeYes
ActiveformboolYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
MetaDataformstringNo
LicenseType Parameters:
NameParameterData TypeRequiredDescription
LicenseItemsformIList<LicenseTypeItem>No
PricesformIList<LicensePrice>No
PeriodOfNoticeDaysformintNo
NextLicenseOptionformLicenseTypeNo
NameformstringYes
DescriptionformstringYes
ExtraLicenseOptionformboolYes
ModifiedDateformDateTimeOffset?No
IdformintNo
LicenseTypeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
LicenseTypesIdformintYes
LicenseItemsIdformintYes
NumberOfItemsformintYes
IdformintNo
ModifiedDateformDateTimeOffset?No
LicensePrice Parameters:
NameParameterData TypeRequiredDescription
CountryformCountryNo
MonthlyPaymentformboolNo
LicenseTypeIdformintYes
CountryIdformstringYes
PriceformintYes
ModifiedDateformDateTimeOffset?No
Country Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
NameformstringYes
CultureformstringNo
TimeZoneformstringNo
ModifiedDateformDateTimeOffset?No
IdformstringYes
CompanyCategory Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
HeaderformstringYes
DescriptionformstringYes
ImageUrlformUriNo
ActiveformboolYes
SortOrderformint?No
ModifiedDateformDateTimeOffset?No
IdformintNo
BookingStatus Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringYes
ColorformstringYes
IconformstringYes
ModifiedDateformDateTimeOffset?No
IdformintNo
BookedResourceType Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource type id
NameformstringNoThe resource type name
ResourcesformList<BookedResource>NoThe resources inside resource type
BookedResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
ColorformstringNo
ImageUrlformUriNo
EmailformstringNo
MobilePhoneformstringNo
AccessGroupformstringNo
EmailNotificationformboolNo
SMSNotificationformboolNo
EmailReminderformboolNo
SMSReminderformboolNo
GroupedBookingQueryResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
DateformDateTimeNo
BookingsformList<BookingQueryResponse>No
BookingQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CompanyIdformGuidNo
FromformDateTimeNo
ToformDateTimeNo
StatusformBookingStatusEnumNo
StatusIdformintNo
StatusNameformstringNo
StatusInfoformBookingStatusQueryResponseNo
SendEmailReminderformboolNo
SendSmsReminderformboolNo
SendSmsConfirmationformboolNo
SendEmailConfirmationformboolNo
LastTimeToUnBookformDateTime?No
CustomFieldsformList<CustomFieldConfigData>No
CustomFieldValuesformList<CustomFieldDataResponse>No
BookedResourceTypesformList<BookedResourceType>No
CompanyformBookedCompanyNo
CustomerformBookedCustomerNo
QuantitiesformList<BookedQuantity>No
ServiceformServiceInfoResponseNo
PaymentExpirationformDateTime?No
LogformList<BookingLogQueryResponse>No
PaymentLogformList<BookingPaymentLogQueryResponse>No
CheckoutLogformList<BookingCheckoutQueryResponse>No
ExternalReferenceformList<ExternalReferenceResponse>No
ResponseStatusformResponseStatusNo
CalendarExportStatusformBookingCalendarExportStatusNo
LengthInMinutesformint?No
BookedByformstringNo
BookedCommentsformstringNo
UnbookedCommentsformstringNo
CommentsToCustomerformstringNo
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo
UnbookedOnformDateTime?No
CancellationCodeformstringNo
RatingCodeformstringNo
BookingStatusQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
IconformstringNo
ColorformstringNo
CustomFieldConfigData Parameters:
NameParameterData TypeRequiredDescription
IdformintNoCustom field id
NameformstringNoConfiguration name. Example: 'Number of persons'.
DescriptionformstringNoCustom field description. Example: 'For how many persons is this booking?'
Widthformint?NoField width. Example: 20 for 20px
DataTypeformstringNoData field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
DefaultValueformstringNoDefault value of the field. Example: '3'
IsMandatoryformboolNoDetermines if the field is required to have a value or not
MandatoryErrorMessageformstringNoError message shown to the user if the field data is required but not entered
MaxLengthformintNoMax lenght of the field
MultipleLineTextformboolNoIf the field should have multiple lines
RegExformstringNoRegular expression used for validation of the field
RegExErrorMessageformstringNoError message shown if the regular expression validation failed
ValuesformList<CustomFieldValueResponse>NoThe values to select from if Datatype is DropDown for this custom field
CustomFieldValueResponse Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
BookedCompany Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
LogoTypeformUriNo
CategoryformstringNo
Street1formstringNo
Street2formstringNo
ZipCodeformstringNo
CityformstringNo
CountryIdformstringNo
LongitudeformstringNo
LatitudeformstringNo
PhoneformstringNo
EmailformstringNo
HomePageformstringNo
SitePathformstringNo
IsFavoriteformboolNo
PaymentProviderIdformint?No
BookedQuantity Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe quantity Id
QuantityformintNoThe quantity for booked on this price category
Priceformdouble?NoThe price
PriceBeforeRebateformdouble?NoThe price bofore rebate codes
CurrencyIdformstringNoThe price currency
PriceSignformstringNoThe price sign
CategoryformstringNoThe price category
VATformdecimal?NoThe price VAT in percent
PriceTextformstringNoThe price text to display
OccupiesSpotformboolNoIf the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.
ServiceInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ImageUrlformUriNo
LengthInMinutesformint?No
MaxNumberOfSpotsPerBookingformintNo
GroupBookingformGroupBookingSettingsNo
MultipleResourceformMultipleResourceSettingsNo
IsGroupBookingformboolNo
IsPaymentEnabledformboolNo
GroupBookingSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
MultipleResourceSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
BookingLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe booking log id
BookingIdformintNoThe booking id
EventTypeIdformintNoThe type of event
EventTypeformBookingLogEventTypeResponseNoThe type of event
CommentsformstringNoComments that could be added to the event log item
UserNameformstringNoThe user created the event
CreatedformDateTimeNoThen date when the event occured
BookingLogEventTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe event type id
NameformstringNoThe event type name
DescriptionformstringNoThe event type description
BookingPaymentLogQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe booking payment log id
BookingIdformintNoThe booking id
PaymentReferenceIdformstringNoThe payment reference id
OrderItemReferenceIdformstringNoThe payment order item reference id
PaymentProviderIdformint?NoThe payment reference id
AmountformdoubleNoThe payment amount
VATformdecimalNoThe payment VAT in percent
AmountCreditedformdoubleNoThe payment amount that is credited
CurrencyIdformstringNoThe payment currency id
CurrencyInfoformCurrencyInfoResponseNoThe payment currency info
CommentsformstringNoComments that could be added to the event log item
CreatedformDateTimeNoThe date when the payment items was created
UpdatedformDateTimeNoThe date when the payment items was update
CurrencyInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNoThe currency id
NameformstringNoThe currency id
CurrencySignformstringNoThe currency id
BookingCheckoutQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe checkout id
BookingIdformintNoThe booking id
PurchaseIdformint?NoThe purchase id
ExpirationTimeformDateTime?NoThe payment checkout expiration datetime
SnippetformstringNoThe payment snippet code
StatusformstringNoThe payment status
MessageformstringNoLog message
CreatedformDateTimeNoWhen the checkout log item was created
UpdatedformDateTimeNoWhen the checkout log item was updated
ExternalReferenceResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformGuidNo
OwnerIdformGuidNo
ReferenceTypeformstringNo
ExternalDataformstringNo
CreatedByformstringNo
UpdatedformDateTimeNo
CreatedformDateTimeNo
BookingCalendarExportStatus Parameters:
NameParameterData TypeRequiredDescription
CalendarIdformstringNo
BookingIdformintNo
Syncedformbool?No
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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

HTTP + XML

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

GET /bookings/grouped HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfGroupedBookingQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:GroupedBookingQueryResponse>
      <d2p1:Bookings>
        <d2p1:BookingQueryResponse>
          <d2p1:BookedBy>String</d2p1:BookedBy>
          <d2p1:BookedComments>String</d2p1:BookedComments>
          <d2p1:BookedResourceTypes>
            <d2p1:BookedResourceType>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Resources>
                <d2p1:BookedResource>
                  <d2p1:AccessGroup>String</d2p1:AccessGroup>
                  <d2p1:Color>String</d2p1:Color>
                  <d2p1:Email>String</d2p1:Email>
                  <d2p1:EmailNotification>false</d2p1:EmailNotification>
                  <d2p1:EmailReminder>false</d2p1:EmailReminder>
                  <d2p1:Id>0</d2p1:Id>
                  <d2p1:ImageUrl i:nil="true" />
                  <d2p1:MobilePhone>String</d2p1:MobilePhone>
                  <d2p1:Name>String</d2p1:Name>
                  <d2p1:SMSNotification>false</d2p1:SMSNotification>
                  <d2p1:SMSReminder>false</d2p1:SMSReminder>
                </d2p1:BookedResource>
              </d2p1:Resources>
            </d2p1:BookedResourceType>
          </d2p1:BookedResourceTypes>
          <d2p1:CalendarExportStatus>
            <d2p1:BookingId>0</d2p1:BookingId>
            <d2p1:CalendarId>String</d2p1:CalendarId>
            <d2p1:Synced>false</d2p1:Synced>
          </d2p1:CalendarExportStatus>
          <d2p1:CancellationCode>String</d2p1:CancellationCode>
          <d2p1:CheckoutLog>
            <d2p1:BookingCheckoutQueryResponse>
              <d2p1:BookingId>0</d2p1:BookingId>
              <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
              <d2p1:ExpirationTime>0001-01-01T00:00:00</d2p1:ExpirationTime>
              <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
              <d2p1:Message>String</d2p1:Message>
              <d2p1:PurchaseId>0</d2p1:PurchaseId>
              <d2p1:Snippet>String</d2p1:Snippet>
              <d2p1:Status>String</d2p1:Status>
              <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
            </d2p1:BookingCheckoutQueryResponse>
          </d2p1:CheckoutLog>
          <d2p1:CommentsToCustomer>String</d2p1:CommentsToCustomer>
          <d2p1:Company>
            <d2p1:Category>String</d2p1:Category>
            <d2p1:City>String</d2p1:City>
            <d2p1:CountryId>String</d2p1:CountryId>
            <d2p1:Email>String</d2p1:Email>
            <d2p1:HomePage>String</d2p1:HomePage>
            <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
            <d2p1:IsFavorite>false</d2p1:IsFavorite>
            <d2p1:Latitude>String</d2p1:Latitude>
            <d2p1:LogoType i:nil="true" />
            <d2p1:Longitude>String</d2p1:Longitude>
            <d2p1:Name>String</d2p1:Name>
            <d2p1:PaymentProviderId>0</d2p1:PaymentProviderId>
            <d2p1:Phone>String</d2p1:Phone>
            <d2p1:SitePath>String</d2p1:SitePath>
            <d2p1:Street1>String</d2p1:Street1>
            <d2p1:Street2>String</d2p1:Street2>
            <d2p1:ZipCode>String</d2p1:ZipCode>
          </d2p1:Company>
          <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
          <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
          <d2p1:CustomFieldValues>
            <d2p1:CustomFieldDataResponse>
              <d2p1:Column>String</d2p1:Column>
              <d2p1:DataType>String</d2p1:DataType>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:Value>String</d2p1:Value>
            </d2p1:CustomFieldDataResponse>
          </d2p1:CustomFieldValues>
          <d2p1:CustomFields>
            <d2p1:CustomFieldConfigData>
              <d2p1:DataType>String</d2p1:DataType>
              <d2p1:DefaultValue>String</d2p1:DefaultValue>
              <d2p1:Description>String</d2p1:Description>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:IsMandatory>false</d2p1:IsMandatory>
              <d2p1:MandatoryErrorMessage>String</d2p1:MandatoryErrorMessage>
              <d2p1:MaxLength>0</d2p1:MaxLength>
              <d2p1:MultipleLineText>false</d2p1:MultipleLineText>
              <d2p1:Name>String</d2p1:Name>
              <d2p1:RegEx>String</d2p1:RegEx>
              <d2p1:RegExErrorMessage>String</d2p1:RegExErrorMessage>
              <d2p1:Values>
                <d2p1:CustomFieldValueResponse>
                  <d2p1:Value>String</d2p1:Value>
                </d2p1:CustomFieldValueResponse>
              </d2p1:Values>
              <d2p1:Width>0</d2p1:Width>
            </d2p1:CustomFieldConfigData>
          </d2p1:CustomFields>
          <d2p1:Customer>
            <d2p1:Email>String</d2p1:Email>
            <d2p1:FacebookUserName>String</d2p1:FacebookUserName>
            <d2p1:Firstname>String</d2p1:Firstname>
            <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
            <d2p1:ImageUrl>String</d2p1:ImageUrl>
            <d2p1:Lastname>String</d2p1:Lastname>
            <d2p1:Phone>String</d2p1:Phone>
          </d2p1:Customer>
          <d2p1:ExternalReference>
            <d2p1:ExternalReferenceResponse>
              <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
              <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
              <d2p1:CreatedBy>String</d2p1:CreatedBy>
              <d2p1:ExternalData>String</d2p1:ExternalData>
              <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
              <d2p1:OwnerId>00000000-0000-0000-0000-000000000000</d2p1:OwnerId>
              <d2p1:ReferenceType>String</d2p1:ReferenceType>
              <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
            </d2p1:ExternalReferenceResponse>
          </d2p1:ExternalReference>
          <d2p1:From>0001-01-01T00:00:00</d2p1:From>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:LastTimeToUnBook>0001-01-01T00:00:00</d2p1:LastTimeToUnBook>
          <d2p1:LengthInMinutes>0</d2p1:LengthInMinutes>
          <d2p1:Log>
            <d2p1:BookingLogQueryResponse>
              <d2p1:BookingId>0</d2p1:BookingId>
              <d2p1:Comments>String</d2p1:Comments>
              <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
              <d2p1:EventType>
                <d2p1:Description>String</d2p1:Description>
                <d2p1:Id>0</d2p1:Id>
                <d2p1:Name>String</d2p1:Name>
              </d2p1:EventType>
              <d2p1:EventTypeId>0</d2p1:EventTypeId>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:UserName>String</d2p1:UserName>
            </d2p1:BookingLogQueryResponse>
          </d2p1:Log>
          <d2p1:PaymentExpiration>0001-01-01T00:00:00</d2p1:PaymentExpiration>
          <d2p1:PaymentLog>
            <d2p1:BookingPaymentLogQueryResponse>
              <d2p1:Amount>0</d2p1:Amount>
              <d2p1:AmountCredited>0</d2p1:AmountCredited>
              <d2p1:BookingId>0</d2p1:BookingId>
              <d2p1:Comments>String</d2p1:Comments>
              <d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
              <d2p1:CurrencyId>String</d2p1:CurrencyId>
              <d2p1:CurrencyInfo>
                <d2p1:CurrencySign>String</d2p1:CurrencySign>
                <d2p1:Id>String</d2p1:Id>
                <d2p1:Name>String</d2p1:Name>
              </d2p1:CurrencyInfo>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:OrderItemReferenceId>String</d2p1:OrderItemReferenceId>
              <d2p1:PaymentProviderId>0</d2p1:PaymentProviderId>
              <d2p1:PaymentReferenceId>String</d2p1:PaymentReferenceId>
              <d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
              <d2p1:VAT>0</d2p1:VAT>
            </d2p1:BookingPaymentLogQueryResponse>
          </d2p1:PaymentLog>
          <d2p1:Quantities>
            <d2p1:BookedQuantity>
              <d2p1:Category>String</d2p1:Category>
              <d2p1:CurrencyId>String</d2p1:CurrencyId>
              <d2p1:Id>0</d2p1:Id>
              <d2p1:OccupiesSpot>false</d2p1:OccupiesSpot>
              <d2p1:Price>0</d2p1:Price>
              <d2p1:PriceBeforeRebate>0</d2p1:PriceBeforeRebate>
              <d2p1:PriceSign>String</d2p1:PriceSign>
              <d2p1:PriceText>String</d2p1:PriceText>
              <d2p1:Quantity>0</d2p1:Quantity>
              <d2p1:VAT>0</d2p1:VAT>
            </d2p1:BookedQuantity>
          </d2p1:Quantities>
          <d2p1:RatingCode>String</d2p1:RatingCode>
          <d2p1:ResponseStatus>
            <ErrorCode>String</ErrorCode>
            <Message>String</Message>
            <StackTrace>String</StackTrace>
            <Errors>
              <ResponseError>
                <ErrorCode>String</ErrorCode>
                <FieldName>String</FieldName>
                <Message>String</Message>
                <Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                  <d9p1:KeyValueOfstringstring>
                    <d9p1:Key>String</d9p1:Key>
                    <d9p1:Value>String</d9p1:Value>
                  </d9p1:KeyValueOfstringstring>
                </Meta>
              </ResponseError>
            </Errors>
            <Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </Meta>
          </d2p1:ResponseStatus>
          <d2p1:SendEmailConfirmation>false</d2p1:SendEmailConfirmation>
          <d2p1:SendEmailReminder>false</d2p1:SendEmailReminder>
          <d2p1:SendSmsConfirmation>false</d2p1:SendSmsConfirmation>
          <d2p1:SendSmsReminder>false</d2p1:SendSmsReminder>
          <d2p1:Service>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:GroupBooking>
              <d2p1:Active>false</d2p1:Active>
              <d2p1:Max>0</d2p1:Max>
              <d2p1:Min>0</d2p1:Min>
            </d2p1:GroupBooking>
            <d2p1:Id>0</d2p1:Id>
            <d2p1:ImageUrl i:nil="true" />
            <d2p1:IsGroupBooking>false</d2p1:IsGroupBooking>
            <d2p1:IsPaymentEnabled>false</d2p1:IsPaymentEnabled>
            <d2p1:LengthInMinutes>0</d2p1:LengthInMinutes>
            <d2p1:MaxNumberOfSpotsPerBooking>0</d2p1:MaxNumberOfSpotsPerBooking>
            <d2p1:MultipleResource>
              <d2p1:Active>false</d2p1:Active>
              <d2p1:Max>0</d2p1:Max>
              <d2p1:Min>0</d2p1:Min>
            </d2p1:MultipleResource>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:Service>
          <d2p1:Status>Booked</d2p1:Status>
          <d2p1:StatusId>0</d2p1:StatusId>
          <d2p1:StatusInfo>
            <d2p1:Color>String</d2p1:Color>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:Icon>String</d2p1:Icon>
            <d2p1:Id>0</d2p1:Id>
            <d2p1:Name>String</d2p1:Name>
          </d2p1:StatusInfo>
          <d2p1:StatusName>String</d2p1:StatusName>
          <d2p1:To>0001-01-01T00:00:00</d2p1:To>
          <d2p1:UnbookedComments>String</d2p1:UnbookedComments>
          <d2p1:UnbookedOn>0001-01-01T00:00:00</d2p1:UnbookedOn>
          <d2p1:UpdatedDate>0001-01-01T00:00:00</d2p1:UpdatedDate>
        </d2p1:BookingQueryResponse>
      </d2p1:Bookings>
      <d2p1:CompanyId>00000000-0000-0000-0000-000000000000</d2p1:CompanyId>
      <d2p1:Date>0001-01-01T00:00:00</d2p1:Date>
    </d2p1:GroupedBookingQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfGroupedBookingQueryResponseWg5EthtI>