BokaMera.API.Host

<back to all web services

CurrentUserQuery

Requires Authentication
The following routes are available for this service:
GET/usersGet user informationGet information about the currently logged in user
CurrentUserQuery Parameters:
NameParameterData TypeRequiredDescription
IncludeFavoritesquerybooleanNoIf you want to include the users favorites
IncludeCompanyCustomersqueryboolNo
CurrentUserQueryResponse Parameters:
NameParameterData TypeRequiredDescription
UserIdformGuidNoThe user id for your profile.
FavoritesformList<UserFavorites>No
UserProfileformUserProfileResponseNo
CustomerProfileformUserProfileResponseNo
AdminProfileformAdminProfileNo
CompanyCustomersformList<CompanyCustomerResponse>No
UserFavorites Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
CompanyformCompanyQueryResponseNo
CompanyQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
OrganisationNumberformstringNoThe organisation number will only be visible if your owner to the company
TypeIdformintNoWhat type of company. If it's used for personal use or as a company.
DetailsformstringNo
CategoryIdformintNo
CategoryformstringNo
LogoTypeformUriNo
CoverImageformUriNo
Street1formstringNo
Street2formstringNo
ZipCodeformstringNo
CityformstringNo
CountryIdformstringNo
LongitudeformstringNo
LatitudeformstringNo
Distanceformdouble?No
PhoneformstringNo
EmailformstringNo
HomepageformstringNo
SitePathformstringNo
ActiveformboolNo
CodeLockSystemformCodeLockSystemType?No
IsFreeAccountformboolNo
UpdatedformdatetimeNoWill show when the company was updated, note it will only be shown if your logged in as admin for the company.
CreatedformdatetimeNoWill show when the company was created, note it will only be shown if your logged in as admin for the company.
StatusIdformintNo
IsFavoriteformbooleanNoIf the company is marked as favourite for the logged in user
BookingAgreementsformstringNo
BookingSettingsformCompanyBookingSettingsNo
SystemSettingsformCompanySystemSettingsNo
WidgetSettingsformCompanyWidgetSettingsNo
HomepageSettingsformHomepageSettingsResponseNo
RatingSummaryformCompanyRatingSummaryNo
ReviewsformList<RatingReviewResponse>No
CustomerCustomFieldsformList<CustomFieldConfigData>No
ResponseStatusformResponseStatusNo
CodeLockSystemType Enum:
Sample
RcoM5
AxemaVaka
VanderbiltOmnis
ParakeyParakey
AmidoDax
TelkeyTelkey
TechSolutionsSiedle
Accessy
Zesec
Enabla
CompanyBookingSettings Parameters:
NameParameterData TypeRequiredDescription
EnableMobileAppformboolNo
BookingReceiptMessageformstringNo
ShowFreeTimesLeftformboolNo
EnableShowBookedTimesformboolNo
BookingAgreementformstringNo
WeekNumberSettingformintNoThe settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber
ShowBookedTimesformboolNo
PaymentProviderIdformintNoThe payment provider id. 1 = Payson Checkout 1.0, 2= Payson Checkout 2.0 ... To get the full payment provider for the company call GET /payment/settings
BookOnlyOnExistingCustomersformbooleanNoIf it's only allowed for existing customers to book
PaymentEnabledformbooleanNoIf payment is enabled
CompanySystemSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNoIf the booking is active or not
InactiveMessageformstringNoIf the booking is not active, what message to show to the customers
SearchableformboolNoIf the company should be visible in search results on hompage
GATrackingIdformstringNoIf you have a google analytics account and want to track your customers behaviors.
GoogleAdsConversionIdformstringNoIf you have a google Ads Conversion Id account and want to track your customers behaviors.
LinkedinTagIdformstringNoIf you have a LinkedIn account and want to track your customers behaviors.
GoogleAdsConversionLabelformstringNoIf you have a Google Ads Conversion Label and want to track your customers behaviors.
FacebookPixelIdformstringNoIf you have a facebook account and want to track your customers behaviors.
MultiLanguageformboolNoIf you want your customers to be albe to change language on your homepage
ShowOnMarketplaceformboolNoIf the company should be visible on the marketplace
EnableAPITranslationformboolNoIf you want your own written text on your homepage to be translated using google analytics when a user changes language
DefaultLanguageformstringNoWhat is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
CompanyWidgetSettings Parameters:
NameParameterData TypeRequiredDescription
ServiceLayoutIdformintNoThe service layouts id.
TimeLayoutIdformintNoThe time layouts id.
BookingLayoutIdformintNoThe booking layouts id.
PrimaryColorformstringNoThe primary color of the booking widget.
ShowServiceImageformboolNoIf you should show the service image in the booking widget.
ShowRebateCodeFieldformboolNoIf you should show the rebate code field in the booking widget.
ShowNextAvailableTimeformboolNoIf you should show the next available time in the booking widget.
ShowEndTimeformboolNoIf you should show the end time in the booking widget.
BookedTimeSlotTextformstringNoWhat text to show on booked time slots. Default text is Booked
DarkThemeformboolNoIf the widget should be displayed in dark theme
HomepageSettingsResponse Parameters:
NameParameterData TypeRequiredDescription
HomepageHeadingformstringNoThe text for homepage heading
WelcomePageHeadingformstringNoThe text for homepage startpage heading
WelcomePageBodyformstringNoThe text for homepage startpage body
AboutUsPageHeadingformstringNoThe text for homepage about us page heading
AboutUsPageBodyformstringNoThe text for homepage about us page body
ImageUrlformUriNoThe startpage image url
CoverImageformUriNoThe cover image url
ShowRatingformboolNoShow rating on the page
HomePageTemplateIdformintNoThe template for the homepage
HeroSectionStyleIdformintNoThe hero section style for the homepage
EnableHomepageformboolNoEnable the BokaMera Homepage
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
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
UserProfileResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
PhoneformstringNo
EmailformstringNo
AdminProfile Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformGuidNo
FirstnameformstringNo
LastnameformstringNo
EmailformstringNo
WorkerIdformstringNo
PhoneformstringNo
CompanyCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuid?No
CustomerIdformGuid?No
CustomFieldValuesformList<CustomFieldDataResponse>No
CustomFieldDataResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ColumnformstringNo
NameformstringNo
DescriptionformstringNo
ValueformstringNo
DataTypeformstringNoData field of custom field. Valid values are: TextBox, ... Example: 'TextBox'

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

HTTP + CSV

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

GET /users HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Favorites":[{"Company":{"Name":"String","OrganisationNumber":"String","TypeId":0,"Details":"String","CategoryId":0,"Category":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Longitude":"String","Latitude":"String","Distance":0,"Phone":"String","Email":"String","Homepage":"String","SitePath":"String","Active":false,"CodeLockSystem":"Sample","IsFreeAccount":false,"Updated":"0001-01-01T00:00:00","Created":"0001-01-01T00:00:00","StatusId":0,"IsFavorite":false,"BookingAgreements":"String","BookingSettings":{"EnableMobileApp":false,"BookingReceiptMessage":"String","ShowFreeTimesLeft":false,"EnableShowBookedTimes":false,"BookingAgreement":"String","WeekNumberSetting":0,"ShowBookedTimes":false,"PaymentProviderId":0,"BookOnlyOnExistingCustomers":false,"PaymentEnabled":false},"SystemSettings":{"Active":false,"InactiveMessage":"String","Searchable":false,"GATrackingId":"String","GoogleAdsConversionId":"String","LinkedinTagId":"String","GoogleAdsConversionLabel":"String","FacebookPixelId":"String","MultiLanguage":false,"ShowOnMarketplace":false,"EnableAPITranslation":false,"DefaultLanguage":"String"},"WidgetSettings":{"ServiceLayoutId":0,"TimeLayoutId":0,"BookingLayoutId":0,"PrimaryColor":"String","ShowServiceImage":false,"ShowRebateCodeField":false,"ShowNextAvailableTime":false,"ShowEndTime":false,"BookedTimeSlotText":"String","DarkTheme":false},"HomepageSettings":{"HomepageHeading":"String","WelcomePageHeading":"String","WelcomePageBody":"String","AboutUsPageHeading":"String","AboutUsPageBody":"String","ShowRating":false,"HomePageTemplateId":0,"HeroSectionStyleId":0,"EnableHomepage":false},"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"}],"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"}]}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}}],"UserProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"CustomerProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"AdminProfile":{"Firstname":"String","Lastname":"String","Email":"String","WorkerId":"String","Phone":"String"},"CompanyCustomers":[{"CompanyId":"00000000-0000-0000-0000-000000000000","CustomerId":"00000000-0000-0000-0000-000000000000","CustomFieldValues":[{"Id":0,"Column":"String","Name":"String","Description":"String","Value":"String","DataType":"String"}]}]}