BokaMera.API.Host

<back to all web services

ServiceQuery

The following routes are available for this service:
GET/services
ServiceQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoCompany to show services for
Idqueryint?NoIf you only want to get a specific service
ActivequerybooleanNoService status
IncludeResourcesquerybooleanNoIf you want to include the connected resource types and resources
IncludeSchedulesquerybooleanNoIf you want to include the connected schedules
IncludeCustomFieldsquerybooleanNoIf you want to include the connected custom fields
IncludeCustomFieldValuesquerybooleanNoIf you want to include the connected custom fields selectable values
IncludeBookingCustomFieldsquerybooleanNoIf you want to include the connected custom fields needs to be entered when booking a new time on the service
IncludeCustomerCustomFieldsquerybooleanNoIf you want to include the connected custom fields for the customers
IncludePricesquerybooleanNoIf you want to include the service prices
PriceDatequerydateTimeNoIf you have selected to include the prices, here you can set the date to show the prices for
PriceTimequerytimeSpanNoIf you have selected to include the prices, here you can set the datetime to show the exact price
RebateCodeIdsqueryList<int>NoIf you have selected to include the prices, here you can include the rebate codes
QuantitiesqueryList<QuantityToBook>NoIf you have selected to include the prices, here you can include the quantities to book to get the correct total price.
IncludeBookingStatusOptionsquerybooleanNoIf you want to include the booking status options to select from
IncludeRatingReviewsquerybooleanNoIf you want to include the rating reviews
IncludeRatingSummaryquerybooleanNoIf you want to include the rating summary
IncludePricesFromOtherDaysquerybooleanNoIf you want to filter out prices which or not active for the day
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
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
DurationTypeIdformintNo
MinDurationformint?No
MaxDurationformint?No
DurationIntervalformint?No
TotalSpotsformint?No
ImageUrlformstringNo
ScheduleTypeIdformintYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
OnlyVisibleByAdminformboolYes
MinNumberOfSpotsPerBookingformintYes
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
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
Invoiced10
BookedCustomer Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
PhoneformstringNo
FacebookUserNameformstringNo
ImageUrlformstringNo
CorporateIdentityNumberformstringNo
InvoiceAddress1formstringNo
InvoiceAddress2formstringNo
InvoiceCityformstringNo
InvoicePostalCodeformstringNo
InvoiceCountryCodeformstringNo
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
CustomFieldServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomFieldConfigIdformintYes
ServiceIdformintYes
ModifiedDateformDateTimeOffset?No
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
PriceSignformstringNo
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
OverlappingPricesformList<ServicePrice>No
CompanyIdformGuidYes
IdformintNo
ServiceIdformintYes
Priceformdouble?No
UpdatedformDateTimeYes
CreatedformDateTimeYes
FromTimeformTimeSpanYes
ToTimeformTimeSpanYes
VATformdecimalYes
CategoryformstringNo
ModifiedDateformDateTimeOffset?No
FromformDateTimeYes
ToformDateTimeYes
CalculationTypeIdformintYes
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
RebateCodeStatusInfoformRebateCodeStatusNo
ArticleformArticleNo
ServicesformList<Service>No
RebateCodeDayOfWeekRelationformList<RebateCodeDayOfWeekRelation>No
RebateCodeServiceRelationformList<RebateCodeServiceRelation>No
RebateCodeBookingPriceRelationformList<RebateCodeBookingPriceRelation>No
RebateCodeCustomerRelationformList<RebateCodeCustomerRelation>No
ServicesNamesformstringNo
DaysOfWeekformList<DaysOfWeek>No
RebateCodeStatusformRebateCodeStatusNo
RebateCodeTypeformRebateCodeTypeNo
TransactionsformList<RebateCodeTransaction>No
RemainingAmountformdouble?No
RemainingUsageformint?No
CurrentNumberOfUsesPerCustomerformintNo
IsSpecificByDayOfWeekformboolNo
ActiveformboolNo
ActiveByStatusformboolNo
RebateCodeCurrencySignformstringNo
CurrencyInfoformCurrencyNo
PaymentReceivedformboolNo
InternalReferenceIdformstringNo
ValidFromformDateTimeYes
ValidToformDateTimeYes
RebateCodeSignformstringYes
RebateCodeValueformintYes
MaxNumberOfUsesformintYes
MaxNumberOfUsesPerCustomerformintYes
NumberOfUsesUsedformintYes
PersonalNoteformstringNo
CreatedByformstringYes
CreatedformDateTimeYes
UpdatedByformstringYes
UpdatedDateformDateTimeYes
FromTimeformTimeSpanYes
ToTimeformTimeSpanYes
ModifiedDateformDateTimeOffset?No
IdformintNo
ArticleIdformint?No
PayableEntity Parameters:
NameParameterData TypeRequiredDescription
DbFactoryformIDbConnectionFactoryNo
QvicklyPaymentManagerformIBokameraPaymentManager<InitCheckoutRequestBody, QvicklyCheckoutResponse, QvicklyPaymentResponse>No
Payson2PaymentManagerformIBokameraPaymentManager<Payson2CheckoutResponse, Payson2CheckoutResponse, Payson2CheckoutResponse>No
PaysonPaymentCheckout1formIPaysonPaymentCheckout1No
LoggerformILogger<PayableEntity>No
InternalReferenceIdformstringNo
PaymentLogformList<PaymentLog>No
CompanyIdformGuidNo
PriceVatformdecimal?No
CurrencyIdformstringNo
CustomerformCustomerNo
CustomersformList<Customer>No
CompanyformCompanyNo
InitCheckoutRequestBody Parameters:
NameParameterData TypeRequiredDescription
credentialsformCredentialsNo
dataformInitCheckoutDataNo
functionformstringNo
Credentials Parameters:
NameParameterData TypeRequiredDescription
hashformstringNo
idformstringNo
versionformstringNo
clientformstringNo
serverdataformServerDataNo
timeformstringNo
testformstringNo
languageformstringNo
ServerData Parameters:
NameParameterData TypeRequiredDescription
HTTP_HOSTformstringNo
HTTP_CONNECTIONformstringNo
HTTP_CACHE_CONTROLformstringNo
HTTP_ACCEPTformstringNo
HTTP_USER_AGENTformstringNo
HTTP_ACCEPT_ENCODINGformstringNo
HTTP_ACCEPT_LANGUAGEformstringNo
PATHformstringNo
SERVER_SOFTWAREformstringNo
SERVER_NAMEformstringNo
SERVER_ADDRformstringNo
SERVER_PORTformstringNo
REMOTE_ADDRformstringNo
REMOTE_PORTformstringNo
GATEWAY_INTERFACEformstringNo
SERVER_PROTOCOLformstringNo
REQUEST_METHODformstringNo
QUERY_STRINGformstringNo
REQUEST_TIMEformstringNo
InitCheckoutData Parameters:
NameParameterData TypeRequiredDescription
CheckoutDataformCheckoutDataNo
PaymentDataformCheckoutPaymentDataNo
PaymentInfoformPaymentInfoNo
ArticlesformQvicklyArticle[]No
CartformCartNo
QvicklyCustomerformQvicklyCustomerNo
CheckoutData Parameters:
NameParameterData TypeRequiredDescription
termsformUriNo
privacyPolicyformUriNo
redirectOnSuccessformstringNo
CheckoutPaymentData Parameters:
NameParameterData TypeRequiredDescription
currencyformstringNo
languageformstringNo
countryformstringNo
autoactivateformstringNo
orderidformstringNo
returnmethodformstringNo
accepturlformUriNo
cancelurlformUriNo
callbackurlformUriNo
PaymentInfo Parameters:
NameParameterData TypeRequiredDescription
paymentdateformstringNo
paymenttermsformstringNo
yourreferenceformstringNo
ourreferenceformstringNo
projectnameformstringNo
deliverymethodformstringNo
deliverytermsformstringNo
QvicklyArticle Parameters:
NameParameterData TypeRequiredDescription
artnrformstringNo
titleformstringNo
quantityformintNo
apriceformintNo
taxformintNo
discountformintNo
withouttaxformintNo
taxrateformintNo
Cart Parameters:
NameParameterData TypeRequiredDescription
HandlingformCartHandlingNo
TotalformCartTotalNo
ShippingformShippingNo
CartHandling Parameters:
NameParameterData TypeRequiredDescription
withouttaxformstringNo
taxrateformstringNo
CartTotal Parameters:
NameParameterData TypeRequiredDescription
roundingformstringNo
withouttaxformstringNo
taxformstringNo
withtaxformstringNo
Shipping Parameters:
NameParameterData TypeRequiredDescription
firstnameformstringNo
lastnameformstringNo
companyformstringNo
streetformstringNo
street2formstringNo
zipformstringNo
cityformstringNo
countryformstringNo
phoneformstringNo
withouttaxformstringNo
taxrateformstringNo
QvicklyCustomer Parameters:
NameParameterData TypeRequiredDescription
nrformstringNo
pnoformstringNo
BillingformCustomerBillingNo
CustomerBilling Parameters:
NameParameterData TypeRequiredDescription
firstnameformstringNo
lastnameformstringNo
companyformstringNo
streetformstringNo
street2formstringNo
zipformstringNo
cityformstringNo
countryformstringNo
phoneformstringNo
emailformstringNo
QvicklyCheckoutResponse Parameters:
NameParameterData TypeRequiredDescription
NumberformintNo
StatusformstringNo
OrderIdformstringNo
UrlformstringNo
QvicklyPaymentResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentDataformQvikclyPaymentDataNo
PaymentInfoformPaymentInfoNo
CardformCardNo
SettlementformSettlementNo
QvicklyCustomerformQvicklyCustomerNo
ArticlesformQvicklyArticle[]No
CartformCartNo
QvikclyPaymentData Parameters:
NameParameterData TypeRequiredDescription
methodformstringNo
paymentplanidformstringNo
currencyformstringNo
countryformstringNo
languageformstringNo
autoactivateformstringNo
orderidformstringNo
statusformstringNo
paymentid_relatedformstringNo
urlformstringNo
Card Parameters:
NameParameterData TypeRequiredDescription
promptnameformstringNo
recurringformstringNo
recurringnrformstringNo
accepturlformstringNo
cancelurlformstringNo
callbackurlformstringNo
returnmethodformstringNo
Settlement Parameters:
NameParameterData TypeRequiredDescription
numberformstringNo
dateformstringNo
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
PaymentLog Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
CurrencyInfoformCurrencyNo
CompanyIdformGuidYes
IdformintNo
InternalReferenceIdformstringYes
ArticleTypeIdformintYes
PaymentReferenceIdformstringNo
PaymentProviderIdformint?No
OrderItemReferenceIdformstringNo
Amountformdouble?No
VATformdecimal?No
AmountCreditedformdouble?No
CommentsformstringNo
CreatedformDateTimeYes
UpdatedformDateTimeYes
ModifiedDateformDateTimeOffset?No
Customer Parameters:
NameParameterData TypeRequiredDescription
IdentityIdformintNo
IdformGuidNo
CustomerIdformGuidNo
AccessKeysformIList<UserAccessKeys>No
EmailformstringNo
ExternalReferencesformIList<ExternalReference>No
CompanyformCompanyNo
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
CommentsformIList<CustomerComment>No
RebateCodesformIList<RebateCode>No
FirstnameformstringNo
ImageUrlformstringNo
ActiveformboolYes
FacebookUsernameformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
IpAddressformstringNo
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
CorporateIdentityNumberformstringNo
InvoiceAddress1formstringNo
InvoiceAddress2formstringNo
InvoiceCityformstringNo
InvoicePostalCodeformstringNo
InvoiceCountryCodeformstringNo
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
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
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
BookingStatusOptions Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
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
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
CompanySetting Parameters:
NameParameterData TypeRequiredDescription
LanguagesformList<LanguageResponse>No
ActiveformboolYes
InactiveMessageformstringNo
SearchableformboolYes
GATrackingIdformstringNo
FacebookPixelIdformstringNo
MultiLanguageformboolYes
EnableAPITranslationformboolYes
DefaultLanguageformstringYes
ModifiedDateformDateTimeOffset?No
GTMTrackingIdformstringNo
ShowOnMarketPlaceformboolYes
GoogleAdsConversionIdformstringNo
LinkedinTagIdformstringNo
GoogleAdsConversionLabelformstringNo
SendCustomerInformationToExternalProvidersformboolNo
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
ShowSubscribeToNewsletterformboolYes
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
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
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
ActiveformboolNo
IdformintNo
LicenseTypeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
LicenseTypeformLicenseTypeNo
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
CustomerComment Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
CustomerIdformGuidYes
CommentsformstringYes
UpdatedformDateTimeYes
CreatedformDateTimeYes
ImageUrlformstringNo
ModifiedDateformDateTimeOffset?No
RebateCodeStatus Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
DescriptionformstringNo
ModifiedDateformDateTimeOffset?No
IdformintNo
Article Parameters:
NameParameterData TypeRequiredDescription
CompanyformCompanyNo
CurrencyInfoformCurrencyNo
ArticleServiceRelationsformList<ArticleServiceRelation>No
ServiceIdsformList<int>No
ArticleTypeformArticleTypeEnumNo
ArticleTypeNameformstringNo
CompanyIdformGuidYes
IdformintNo
NameformstringYes
ArticleTypeIdformintYes
DescriptionformstringNo
ImageUrlformstringNo
ActiveformboolYes
AmountformintYes
PriceformdoubleYes
CurrencyIdformstringYes
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
ArticleServiceRelation Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
ServiceIdformintYes
ArticleIdformintYes
ArticleTypeEnum Enum:
NameValue
ServiceArticle1
StandAloneArticle2
RebateCodePunchTicketArticle3
RebateCodeGiftCardArticle4
RebateCodeValueCardArticle5
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
RebateCodeEmailSentToCustomerformboolNo
MessageToReceiverformstringNo
BuyerformboolNo
DaysOfWeek Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformstringYes
DayOfWeekTranslationformstringYes
DayOfWeekActiveformbool?No
DayOfWeekSortOrderformshort?No
ModifiedDateformDateTimeOffset?No
IdformintNo
RebateCodeTransaction Parameters:
NameParameterData TypeRequiredDescription
BookingformBookingNo
RebateCodeformRebateCodeNo
CustomerformCustomerNo
IdformintNo
CompanyIdformGuidNo
NoteformstringNo
RebateCodeIdformintYes
AmountformdoubleYes
UsageformintYes
BookingIdformint?No
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
Booking Parameters:
NameParameterData TypeRequiredDescription
ServiceformServiceNo
CalendarExportformCalendarExportNo
LogformList<BookingLog>No
CheckoutLogsformList<PaymentDetails>No
PricesformList<BookingPrice>No
StatusformBookingStatusEnumNo
IsReservedformboolNo
StatusNameformstringNo
CurrencyInfoformCurrencyNo
BookingStatusformBookingStatusNo
TotalPriceformdouble?No
TotalSpotsformint?No
ResourcesformIList<Resource>No
ExternalReferencesformIList<ExternalReference>No
BookedResourcesformIList<BookedResourceType>No
CustomFieldsConfigformIList<CustomFieldConfig>No
CustomFieldsDataformIList<CustomFieldDataResponse>No
DeterministicIdformGuidNo
ActiveformboolNo
LastTimeToUnBookformDateTime?No
PriceMappingsformList<PriceMapping>No
InternalReferenceIdformstringNo
UpdatedDateformDateTimeYes
CreatedDateformDateTimeYes
IdformintNo
CustomerIdformGuidYes
ServiceIdformintYes
StatusIdformintYes
UnbookedOnformDateTime?No
UnbookedCommentsformstringNo
BookedCommentsformstringNo
BookedByformstringYes
UnBookedByformstringNo
SendSmsReminderformboolYes
SendEmailReminderformboolYes
SendSmsConfirmationformboolYes
RebateCodeformstringNo
CommentsformstringNo
IpAddressformstringNo
NumberOfBookedSpotsformintYes
CommentsToCustomerformstringNo
PaymentExpirationformDateTime?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
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
PaymentDetails Parameters:
NameParameterData TypeRequiredDescription
QvicklyCheckoutSerializedformQvicklyCheckoutResponseNo
Payson2CheckoutSerializedformPayson2CheckoutResponseNo
CompanyIdformGuidYes
InternalReferenceIdformstringYes
ArticleTypeIdformintYes
ExternalResponseDataformstringYes
ExternalResponseReferenceformstringYes
PaymentProviderIdformintYes
CreatedDateformDateTimeYes
UpdatedDateformDateTimeYes
ModifiedDateformDateTimeOffset?No
BookingPrice Parameters:
NameParameterData TypeRequiredDescription
CurrencyIdformstringNo
PriceIdformint?No
CurrencyInfoformCurrencyNo
PriceTextformstringNo
AppliedCodesformList<AppliedRebateCodes>No
IsRebateformboolNo
CompanyIdformGuidYes
BookingIdformintYes
QuantityformintYes
Priceformdouble?No
VATformdecimal?No
CategoryformstringNo
UpdatedformDateTimeYes
CreatedformDateTimeYes
InvoicedformboolYes
OccupiesSpotformboolYes
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
ServiceQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ImageUrlformUriNo
TotalSpotsformintNo
LockSpotsToBookingformbool?NoIf this setting is turned on the remaining spots (if Totalspots > 1) is locked from be booked by another customer.
MinNumberOfSpotsPerBookingformintNo
MaxNumberOfSpotsPerBookingformintNo
MinNumberOfResourcesToBookformintNo
MaxNumberOfResourcesToBookformintNo
UnbookBeforeDaysformintNo
UnbookBeforeHoursformintNo
UnbookBeforeMinutesformintNo
ScheduleTypeformScheduleTypeNoWhat type of schedule is connected to the service. RecurringSchedule = 1, DateSchedule = 2
ScheduleTypeIdformintNoWhat type of schedule is connected to the service. RecurringSchedule = 1, DateSchedule = 2
BookBeforeDaysformintNo
BookBeforeHoursformintNo
BookBeforeMinutesformintNo
GroupformstringNo
EnableBookingQueueformboolNo
EnableCodeLockSyncformboolNo
EnableCustomerManualPaymentformboolNo
SortOrderformintNo
ActiveformboolNo
IsGroupBookingformboolNo
GroupBookingformGroupBookingSettingsNo
MultipleResourceformMultipleResourceSettingsNo
IsPaymentEnabledformboolNo
MaxPaymentTimeformintNoMaximum numbers of minutes the booking payment must be completed before automatically unbooked
BookingStatusIdformintNoIf the booking should be either 1 = Booked) or 3 = Reserved. Default is 1 = Booked.
OnlyVisibleByAdminformboolNo
LengthInMinutesformint?No
DurationTypeIdformintNo
Durationformint?No
MinDurationformint?No
MaxDurationformint?No
DurationIntervalformint?No
PauseAfterBookingformintNo
CustomFieldsformList<CustomFieldConfigData>No
CustomFieldValuesformList<CustomFieldDataResponse>No
BookingCustomFieldsformList<CustomFieldConfigData>No
CustomerCustomFieldsformList<CustomFieldConfigData>No
BookingStatusOptionsformList<BookingStatusOptionsResponse>NoThe booking status options to choose from
PricesformList<ServicePriceResponse>No
SchedulesformServiceSchedulesNo
RatingSummaryformCompanyRatingSummaryNo
ReviewsformList<RatingReviewResponse>No
ResourceTypesformList<ServiceResourceTypeResponse>No
ResponseStatusformResponseStatusNo
PriceViewTypeIdformint?No
GroupBookingSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
MultipleResourceSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
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
BookingStatusOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ServicePriceResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNoThe company id
IdformintNoThe price id
ServiceIdformintNoThe service id
PriceformdoubleNoThe price
CalculationTypeIdformintNoThe price calculation type id, 1 = Normal, price is for the service total duration, 2 = Price is per minute, 3 = Price is per hour, 4= Price is per day
CurrencyIdformstringNoThe price currency
PriceSignformstringNoThe price sign
VATformdecimalNoThe price VAT in percent
CategoryformstringNoThe price category if price has a category
PriceTextformstringNoThe price text to display
FromformDateTimeNoThe valid from date for the price.
ToformDateTimeNoThe valid to date for the price.
DaysOfWeekformList<DayOfWeekDto>NoIf the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
FromTimeformTimeSpan?NoIf the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
ToTimeformTimeSpan?NoIf the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
ServiceformServiceInfoResponseNo
IsTimeSpecificformboolNoIf the price is only valid for a specific time span
IsDaysOfWeekSpecificformboolNoIf the price is only valid for specific days of week
DayOfWeekDto Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekIdformintNo
DotNetDayOfWeekIdformintNo
DayOfWeekformstringNo
ServiceInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ImageUrlformUriNo
LengthInMinutesformint?No
MaxNumberOfSpotsPerBookingformintNo
MinNumberOfSpotsPerBookingformintNo
GroupBookingformGroupBookingSettingsNo
MultipleResourceformMultipleResourceSettingsNo
IsGroupBookingformboolNo
IsPaymentEnabledformboolNo
ServiceSchedules Parameters:
NameParameterData TypeRequiredDescription
ScheduleTypeformScheduleTypeNo
RecurringSchedulesformList<ISchedule>No
DateSchedulesformList<ISchedule>No
CompanyRatingSummary Parameters:
NameParameterData TypeRequiredDescription
AverageScoreformdoubleNoThe average rating score
RatingScore1CountformintNoThe number of ratings of score 1
RatingScore2CountformintNoThe number of ratings of score 2
RatingScore3CountformintNoThe number of ratings of score 3
RaingScore4CountformintNoThe number of ratings of score 4
RatingScore5CountformintNoThe number of ratings of score 5
CountformintNoThe number of ratings
RatingReviewResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNoThe title for the review
DescriptionformstringNoThe description for the review
RatingScoreformintNoThe rating score
AuthorformstringNoThe review author
CreatedformDateTimeNoThe created date
ReviewAnswerformstringNoThe review answer from the company
ServiceResourceTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resourcetype id
SelectableByUserformboolNoThe resourcetype is selectable by customer
NameformstringNoThe resourcetype name
DescriptionformstringNoThe resourcetype description
ResourcesformList<ServiceResourceTypeResource>NoThe resources in the resourcetype. Only shows active resources if not admin.
ServiceResourceTypeResource Parameters:
NameParameterData TypeRequiredDescription
IdformintNoThe resource id
NameformstringNoThe resource name
DescriptionformstringNoThe resource description
EmailformstringNoThe resource email
PhoneformstringNoThe resource phone
ColorformstringNoThe resource color
ImageUrlformUriNoThe resource image
PriorityformintNoThe priority of the resource
EmailNotificationformboolNoIf the resource want to receive email notifications
SMSNotificationformboolNoIf the resource want to receive sms notifications
EmailReminderformboolNoIf the resource want to receive email reminders
SMSReminderformboolNoIf the resource want to receive sms reminders
QuantityToBook Parameters:
NameParameterData TypeRequiredDescription
PriceIdformintYesIf service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)
QuantityformintYesSet the number of spots or resources you want to book on the specific price category
OccupiesSpotformboolNoIf the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.
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 .jsv suffix or ?format=jsv

HTTP + JSV

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

GET /services HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			TotalSpots: 0,
			LockSpotsToBooking: False,
			MinNumberOfSpotsPerBooking: 0,
			MaxNumberOfSpotsPerBooking: 0,
			MinNumberOfResourcesToBook: 0,
			MaxNumberOfResourcesToBook: 0,
			UnbookBeforeDays: 0,
			UnbookBeforeHours: 0,
			UnbookBeforeMinutes: 0,
			ScheduleType: NotDefined,
			ScheduleTypeId: 0,
			BookBeforeDays: 0,
			BookBeforeHours: 0,
			BookBeforeMinutes: 0,
			Group: String,
			EnableBookingQueue: False,
			EnableCodeLockSync: False,
			EnableCustomerManualPayment: False,
			SortOrder: 0,
			Active: False,
			IsGroupBooking: False,
			GroupBooking: 
			{
				Active: False,
				Min: 0,
				Max: 0
			},
			MultipleResource: 
			{
				Active: False,
				Min: 0,
				Max: 0
			},
			IsPaymentEnabled: False,
			MaxPaymentTime: 0,
			BookingStatusId: 0,
			OnlyVisibleByAdmin: False,
			LengthInMinutes: 0,
			DurationTypeId: 0,
			Duration: 0,
			MinDuration: 0,
			MaxDuration: 0,
			DurationInterval: 0,
			PauseAfterBooking: 0,
			CustomFields: 
			[
				{
					"Id": 0,
					"Name": "String",
					"Description": "String",
					"Width": 0,
					"DataType": "String",
					"DefaultValue": "String",
					"IsMandatory": false,
					"MandatoryErrorMessage": "String",
					"MaxLength": 0,
					"MultipleLineText": false,
					"RegEx": "String",
					"RegExErrorMessage": "String",
					"Values": 
					[
						{
							"Value": "String"
						}
					]
				}
			],
			CustomFieldValues: 
			[
				{
					Id: 0,
					Column: String,
					Name: String,
					Description: String,
					Value: String,
					DataType: String
				}
			],
			BookingCustomFields: 
			[
				{
					"Id": 0,
					"Name": "String",
					"Description": "String",
					"Width": 0,
					"DataType": "String",
					"DefaultValue": "String",
					"IsMandatory": false,
					"MandatoryErrorMessage": "String",
					"MaxLength": 0,
					"MultipleLineText": false,
					"RegEx": "String",
					"RegExErrorMessage": "String",
					"Values": 
					[
						{
							"Value": "String"
						}
					]
				}
			],
			CustomerCustomFields: 
			[
				{
					"Id": 0,
					"Name": "String",
					"Description": "String",
					"Width": 0,
					"DataType": "String",
					"DefaultValue": "String",
					"IsMandatory": false,
					"MandatoryErrorMessage": "String",
					"MaxLength": 0,
					"MultipleLineText": false,
					"RegEx": "String",
					"RegExErrorMessage": "String",
					"Values": 
					[
						{
							"Value": "String"
						}
					]
				}
			],
			BookingStatusOptions: 
			[
				{
					Id: 0,
					Name: String,
					Description: String
				}
			],
			Prices: 
			[
				{
					Id: 0,
					ServiceId: 0,
					Price: 0,
					CalculationTypeId: 0,
					CurrencyId: String,
					PriceSign: String,
					VAT: 0,
					Category: String,
					PriceText: String,
					DaysOfWeek: 
					[
						{
							DayOfWeekId: 0,
							DotNetDayOfWeekId: 0,
							DayOfWeek: String
						}
					],
					FromTime: PT0S,
					ToTime: PT0S,
					Service: 
					{
						Id: 0,
						Name: String,
						Description: String,
						LengthInMinutes: 0,
						MaxNumberOfSpotsPerBooking: 0,
						MinNumberOfSpotsPerBooking: 0,
						GroupBooking: 
						{
							Active: False,
							Min: 0,
							Max: 0
						},
						MultipleResource: 
						{
							Active: False,
							Min: 0,
							Max: 0
						},
						IsGroupBooking: False,
						IsPaymentEnabled: False
					},
					IsTimeSpecific: False,
					IsDaysOfWeekSpecific: False
				}
			],
			Schedules: 
			{
				ScheduleType: NotDefined,
				RecurringSchedules: 
				[
					{
						
					}
				],
				DateSchedules: 
				[
					{
						
					}
				]
			},
			RatingSummary: 
			{
				AverageScore: 0,
				RatingScore1Count: 0,
				RatingScore2Count: 0,
				RatingScore3Count: 0,
				RaingScore4Count: 0,
				RatingScore5Count: 0,
				Count: 0
			},
			Reviews: 
			[
				{
					Title: String,
					Description: String,
					RatingScore: 0,
					Author: String,
					ReviewAnswer: String
				}
			],
			ResourceTypes: 
			[
				{
					Id: 0,
					SelectableByUser: False,
					Name: String,
					Description: String,
					Resources: 
					[
						{
							Id: 0,
							Name: String,
							Description: String,
							Email: String,
							Phone: String,
							Color: String,
							Priority: 0,
							EmailNotification: False,
							SMSNotification: False,
							EmailReminder: False,
							SMSReminder: False
						}
					]
				}
			],
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			},
			PriceViewTypeId: 0
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}