BokaMera.API.Host

CurrentUserQuery

The following routes are available for this service:
GET	/users	Get user information	Get information about the currently logged in user

**CurrentUserQuery** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeFavorites	query	boolean	No	If you want to include the users favorites
IncludeCompanyCustomers	query	bool	No
IncludeInvoiceAddress	query	bool	No

**CurrentUserQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
UserId	form	Guid	No	The user id for your profile.
Favorites	form	List<UserFavorites>	Yes
UserProfile	form	UserProfileResponse	Yes
CustomerProfile	form	UserProfileResponse	Yes
AdminProfile	form	AdminProfile	Yes
CompanyCustomers	form	List<CompanyCustomerResponse>	Yes
InvoiceAddress	form	InvoiceAddressResponse	Yes

**UserFavorites** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No
Company	form	CompanyQueryResponse	Yes

**CompanyQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	Yes
OrganisationNumber	form	string	Yes	The organisation number will only be visible if you are the owner of the company.
TypeId	form	int	No	What type of company. If it's used for personal use or as a company.
Details	form	string	Yes
CategoryId	form	int	No
Category	form	string	Yes
LogoType	form	Uri	Yes
CoverImage	form	Uri	Yes
Street1	form	string	Yes
Street2	form	string	Yes
ZipCode	form	string	Yes
City	form	string	Yes
CountryId	form	string	Yes
Longitude	form	string	Yes
Latitude	form	string	Yes
Distance	form	double?	No
Phone	form	string	Yes
Email	form	string	Yes
Homepage	form	string	Yes
SitePath	form	string	Yes
Active	form	bool	No
CodeLockSystem	form	CodeLockSystemType?	No
IsFreeAccount	form	bool	No
Updated	form	datetime	No	Will show when the company was updated, note it will only be shown if your logged in as admin for the company.
Created	form	datetime	No	Will show when the company was created, note it will only be shown if your logged in as admin for the company.
StatusId	form	int	No
IsFavorite	form	boolean	No	If the company is marked as favourite for the logged in user
BookingAgreements	form	string	Yes
BookingSettings	form	CompanyBookingSettings	No
SystemSettings	form	CompanySystemSettings	No
WidgetSettings	form	CompanyWidgetSettings	No
HomepageSettings	form	HomepageSettingsResponse	Yes
RatingSummary	form	CompanyRatingSummary	No
Reviews	form	List<RatingReviewResponse>	Yes
CustomerCustomFields	form	List<CustomFieldConfigData>	Yes
ResponseStatus	form	ResponseStatus	Yes

**CodeLockSystemType** Enum:
Sample
RcoM5
AxemaVaka
VanderbiltOmnis
ParakeyParakey
AmidoDax
TelkeyTelkey
TechSolutionsSiedle
Accessy
Zesec
Enabla

**CompanyBookingSettings** Parameters:
Name	Parameter	Data Type	Required	Description
EnableMobileApp	form	bool	No
BookingReceiptMessage	form	string	Yes
ShowFreeTimesLeft	form	bool	No
EnableShowBookedTimes	form	bool	No
BookingAgreement	form	string	Yes
WeekNumberSetting	form	int	No	The settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber
ShowBookedTimes	form	bool	No
PaymentProviderId	form	int	No	The payment provider id. To get the full payment provider for the company call GET /payment/settings
BookOnlyOnExistingCustomers	form	boolean	No	If it's only allowed for existing customers to book
PaymentEnabled	form	boolean	No	If payment is enabled
BookingPinCodeRestriction	form	string	Yes
CustomerInvoiceAdressRequired	form	bool	No

**CompanySystemSettings** Parameters:
Name	Parameter	Data Type	Required	Description
Active	form	bool	No	If the booking is active or not
InactiveMessage	form	string	Yes	If the booking is not active, what message to show to the customers
Searchable	form	bool	No	If the company should be visible in search results on homepage
GATrackingId	form	string	Yes	If you have a Google Analytics account and want to track your customers behaviors.
GoogleAdsConversionId	form	string	Yes	If you have a Google Ads Conversion Id account and want to track your customers behaviors.
LinkedinTagId	form	string	Yes	If you have a LinkedIn account and want to track your customers behaviors.
GoogleAdsConversionLabel	form	string	Yes	If you have a Google Ads Conversion Label and want to track your customers behaviors.
GTMTrackingId	form	string	Yes	If you have a Google Tag Manager account and want to track your customers behaviors.
FacebookPixelId	form	string	Yes	If you have a Facebook account and want to track your customers behaviors.
MultiLanguage	form	bool	No	If you want your customers to be able to change language on your homepage
ShowOnMarketplace	form	bool	No	If the company should be visible on the marketplace
EnableAPITranslation	form	bool	No	If you want your own written text on your homepage to be translated using Google Translate when a user changes language
DefaultLanguage	form	string	Yes	What is the standard language your homepage information is written in. Select from the different countries, i.e. SE,NO,EN
SendCustomerInformationToExternalProviders	form	bool	No	If you want to allow to send customer information in the tracking events to the external providers. Note you as a company are responsible for informing your customers and handling the data in terms of GDPR.
SMSMessageDailySendLimit	form	int	No	The maximum number of SMS messages that can be sent per day.
EmailMessageDailySendLimit	form	int	No	The maximum number of email messages that can be sent per day.

**CompanyWidgetSettings** Parameters:
Name	Parameter	Data Type	Required	Description
ServiceLayoutId	form	int	No	The service layouts id.
TimeLayoutId	form	int	No	The time layouts id.
BookingLayoutId	form	int	No	The booking layouts id.
PrimaryColor	form	string	Yes	The primary color of the booking widget.
ShowServiceImage	form	bool	No	If you should show the service image in the booking widget.
ShowRebateCodeField	form	bool	No	If you should show the rebate code field in the booking widget.
ShowNextAvailableTime	form	bool	No	If you should show the next available time in the booking widget.
ShowEndTime	form	bool	No	If you should show the end time in the booking widget.
BookedTimeSlotText	form	string	Yes	What text to show on booked time slots. Default text is Booked
DarkTheme	form	bool	No	If the widget should be displayed in dark theme
ShowSubscribeToNewsletter	form	bool	No	If you should show the subscribe to newsletter checkbox in the booking widget.

**HomepageSettingsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
HomepageHeading	form	string	Yes	The text for homepage heading
WelcomePageHeading	form	string	Yes	The text for homepage startpage heading
WelcomePageBody	form	string	Yes	The text for homepage startpage body
AboutUsPageHeading	form	string	Yes	The text for homepage about us page heading
AboutUsPageBody	form	string	Yes	The text for homepage about us page body
ImageUrl	form	Uri	Yes	The startpage image url
CoverImage	form	Uri	Yes	The cover image url
ShowRating	form	bool	No	Show rating on the page
HomePageTemplateId	form	int	No	The template for the homepage
HeroSectionStyleId	form	int	No	The hero section style for the homepage
EnableHomepage	form	bool	No	Enable the BokaMera Homepage

**CompanyRatingSummary** Parameters:
Name	Parameter	Data Type	Required	Description
AverageScore	form	double	No	The average rating score
RatingScore1Count	form	int	No	The number of ratings of score 1
RatingScore2Count	form	int	No	The number of ratings of score 2
RatingScore3Count	form	int	No	The number of ratings of score 3
RaingScore4Count	form	int	No	The number of ratings of score 4
RatingScore5Count	form	int	No	The number of ratings of score 5
Count	form	int	No	The number of ratings

**RatingReviewResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	Yes	The title for the review
Description	form	string	Yes	The description for the review
RatingScore	form	int	No	The rating score
Author	form	string	Yes	The review author
Created	form	DateTime	No	The created date
ReviewAnswer	form	string	Yes	The review answer from the company

**CustomFieldConfigData** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	Custom field id
Name	form	string	Yes	Configuration name. Example: 'Number of persons'.
Description	form	string	Yes	Custom field description. Example: 'For how many persons is this booking?'
Width	form	int?	No	Field width. Example: 20 for 20px
DataType	form	string	Yes	Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
DefaultValue	form	string	Yes	Default value of the field. Example: '3'
IsMandatory	form	bool	No	Determines if the field is required to have a value or not
MandatoryErrorMessage	form	string	Yes	Error message shown to the user if the field data is required but not entered
MaxLength	form	int	No	Max lenght of the field
MultipleLineText	form	bool	No	If the field should have multiple lines
RegEx	form	string	Yes	Regular expression used for validation of the field
RegExErrorMessage	form	string	Yes	Error message shown if the regular expression validation failed
Values	form	List<CustomFieldValueResponse>	Yes	The values to select from if Datatype is DropDown for this custom field

**CustomFieldValueResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Value	form	string	Yes

**UserProfileResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Phone	form	string	Yes
Email	form	string	Yes
InvoiceAddress	form	InvoiceAddressResponse	Yes

**InvoiceAddressResponse** Parameters:
Name	Parameter	Data Type	Required
InvoiceAddressId	form	Guid	No
UserId	form	Guid?	No
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**AdminProfile** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid	No
Id	form	Guid	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
WorkerId	form	string	Yes
Phone	form	string	Yes

**CompanyCustomerResponse** Parameters:
Name	Parameter	Data Type	Required
CompanyId	form	Guid?	No
CompanyName	form	string	No
CustomerId	form	Guid?	No
SubscribedToNewsletter	form	bool	No
CustomFieldValues	form	List<CustomFieldDataResponse>	Yes
InvoiceAddress	form	InvoiceAddressResponse	Yes

**CustomFieldDataResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Column	form	string	Yes
Name	form	string	Yes
Description	form	string	Yes
Value	form	string	Yes
DataType	form	string	Yes	Data 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 .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 /users HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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,
					BookingPinCodeRestriction: String,
					CustomerInvoiceAdressRequired: False
				},
				SystemSettings: 
				{
					Active: False,
					InactiveMessage: String,
					Searchable: False,
					GATrackingId: String,
					GoogleAdsConversionId: String,
					LinkedinTagId: String,
					GoogleAdsConversionLabel: String,
					GTMTrackingId: String,
					FacebookPixelId: String,
					MultiLanguage: False,
					ShowOnMarketplace: False,
					EnableAPITranslation: False,
					DefaultLanguage: String,
					SendCustomerInformationToExternalProviders: False,
					SMSMessageDailySendLimit: 0,
					EmailMessageDailySendLimit: 0
				},
				WidgetSettings: 
				{
					ServiceLayoutId: 0,
					TimeLayoutId: 0,
					BookingLayoutId: 0,
					PrimaryColor: String,
					ShowServiceImage: False,
					ShowRebateCodeField: False,
					ShowNextAvailableTime: False,
					ShowEndTime: False,
					BookedTimeSlotText: String,
					DarkTheme: False,
					ShowSubscribeToNewsletter: 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,
		InvoiceAddress: 
		{
			UserId: 00000000-0000-0000-0000-000000000000,
			CorporateIdentityNumber: String,
			InvoiceAddress1: String,
			InvoiceAddress2: String,
			InvoiceCity: String,
			InvoicePostalCode: String,
			InvoiceCountryCode: String
		}
	},
	CustomerProfile: 
	{
		Firstname: String,
		Lastname: String,
		Phone: String,
		Email: String,
		InvoiceAddress: 
		{
			UserId: 00000000-0000-0000-0000-000000000000,
			CorporateIdentityNumber: String,
			InvoiceAddress1: String,
			InvoiceAddress2: String,
			InvoiceCity: String,
			InvoicePostalCode: String,
			InvoiceCountryCode: String
		}
	},
	AdminProfile: 
	{
		Firstname: String,
		Lastname: String,
		Email: String,
		WorkerId: String,
		Phone: String
	},
	CompanyCustomers: 
	[
		{
			CompanyId: 00000000-0000-0000-0000-000000000000,
			CompanyName: String,
			CustomerId: 00000000-0000-0000-0000-000000000000,
			SubscribedToNewsletter: False,
			CustomFieldValues: 
			[
				{
					Id: 0,
					Column: String,
					Name: String,
					Description: String,
					Value: String,
					DataType: String
				}
			],
			InvoiceAddress: 
			{
				UserId: 00000000-0000-0000-0000-000000000000,
				CorporateIdentityNumber: String,
				InvoiceAddress1: String,
				InvoiceAddress2: String,
				InvoiceCity: String,
				InvoicePostalCode: String,
				InvoiceCountryCode: String
			}
		}
	],
	InvoiceAddress: 
	{
		UserId: 00000000-0000-0000-0000-000000000000,
		CorporateIdentityNumber: String,
		InvoiceAddress1: String,
		InvoiceAddress2: String,
		InvoiceCity: String,
		InvoicePostalCode: String,
		InvoiceCountryCode: String
	}
}