| GET | /users | Get user information | Get information about the currently logged in user |
|---|
"use strict";
/** @typedef {'Sample'|'RcoM5'|'AxemaVaka'|'VanderbiltOmnis'|'ParakeyParakey'|'AmidoDax'|'TelkeyTelkey'|'TechSolutionsSiedle'|'Accessy'|'Zesec'|'Enabla'} */
export var CodeLockSystemType;
(function (CodeLockSystemType) {
CodeLockSystemType["Sample"] = "Sample"
CodeLockSystemType["RcoM5"] = "RcoM5"
CodeLockSystemType["AxemaVaka"] = "AxemaVaka"
CodeLockSystemType["VanderbiltOmnis"] = "VanderbiltOmnis"
CodeLockSystemType["ParakeyParakey"] = "ParakeyParakey"
CodeLockSystemType["AmidoDax"] = "AmidoDax"
CodeLockSystemType["TelkeyTelkey"] = "TelkeyTelkey"
CodeLockSystemType["TechSolutionsSiedle"] = "TechSolutionsSiedle"
CodeLockSystemType["Accessy"] = "Accessy"
CodeLockSystemType["Zesec"] = "Zesec"
CodeLockSystemType["Enabla"] = "Enabla"
})(CodeLockSystemType || (CodeLockSystemType = {}));
export class CompanyBookingSettings {
/** @param {{EnableMobileApp?:boolean,BookingReceiptMessage?:string,ShowFreeTimesLeft?:boolean,EnableShowBookedTimes?:boolean,BookingAgreement?:string,WeekNumberSetting?:number,ShowBookedTimes?:boolean,PaymentProviderId?:number,BookOnlyOnExistingCustomers?:boolean,PaymentEnabled?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
EnableMobileApp;
/** @type {string} */
BookingReceiptMessage;
/** @type {boolean} */
ShowFreeTimesLeft;
/** @type {boolean} */
EnableShowBookedTimes;
/** @type {string} */
BookingAgreement;
/**
* @type {number}
* @description The settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber */
WeekNumberSetting;
/** @type {boolean} */
ShowBookedTimes;
/**
* @type {number}
* @description The 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 */
PaymentProviderId;
/**
* @type {boolean}
* @description If it's only allowed for existing customers to book */
BookOnlyOnExistingCustomers;
/**
* @type {boolean}
* @description If payment is enabled */
PaymentEnabled;
}
export class CompanySystemSettings {
/** @param {{Active?:boolean,InactiveMessage?:string,Searchable?:boolean,GATrackingId?:string,GoogleAdsConversionId?:string,LinkedinTagId?:string,GoogleAdsConversionLabel?:string,GTMTrackingId?:string,FacebookPixelId?:string,MultiLanguage?:boolean,ShowOnMarketplace?:boolean,EnableAPITranslation?:boolean,DefaultLanguage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {boolean}
* @description If the booking is active or not */
Active;
/**
* @type {string}
* @description If the booking is not active, what message to show to the customers */
InactiveMessage;
/**
* @type {boolean}
* @description If the company should be visible in search results on hompage */
Searchable;
/**
* @type {string}
* @description If you have a google analytics account and want to track your customers behaviors. */
GATrackingId;
/**
* @type {string}
* @description If you have a google Ads Conversion Id account and want to track your customers behaviors. */
GoogleAdsConversionId;
/**
* @type {string}
* @description If you have a LinkedIn account and want to track your customers behaviors. */
LinkedinTagId;
/**
* @type {string}
* @description If you have a Google Ads Conversion Label and want to track your customers behaviors. */
GoogleAdsConversionLabel;
/**
* @type {string}
* @description If you have a google tag manager account and want to track your customers behaviors. */
GTMTrackingId;
/**
* @type {string}
* @description If you have a facebook account and want to track your customers behaviors. */
FacebookPixelId;
/**
* @type {boolean}
* @description If you want your customers to be albe to change language on your homepage */
MultiLanguage;
/**
* @type {boolean}
* @description If the company should be visible on the marketplace */
ShowOnMarketplace;
/**
* @type {boolean}
* @description If you want your own written text on your homepage to be translated using google analytics when a user changes language */
EnableAPITranslation;
/**
* @type {string}
* @description What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN */
DefaultLanguage;
}
export class CompanyWidgetSettings {
/** @param {{ServiceLayoutId?:number,TimeLayoutId?:number,BookingLayoutId?:number,PrimaryColor?:string,ShowServiceImage?:boolean,ShowRebateCodeField?:boolean,ShowNextAvailableTime?:boolean,ShowEndTime?:boolean,BookedTimeSlotText?:string,DarkTheme?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The service layouts id. */
ServiceLayoutId;
/**
* @type {number}
* @description The time layouts id. */
TimeLayoutId;
/**
* @type {number}
* @description The booking layouts id. */
BookingLayoutId;
/**
* @type {string}
* @description The primary color of the booking widget. */
PrimaryColor;
/**
* @type {boolean}
* @description If you should show the service image in the booking widget. */
ShowServiceImage;
/**
* @type {boolean}
* @description If you should show the rebate code field in the booking widget. */
ShowRebateCodeField;
/**
* @type {boolean}
* @description If you should show the next available time in the booking widget. */
ShowNextAvailableTime;
/**
* @type {boolean}
* @description If you should show the end time in the booking widget. */
ShowEndTime;
/**
* @type {string}
* @description What text to show on booked time slots. Default text is Booked */
BookedTimeSlotText;
/**
* @type {boolean}
* @description If the widget should be displayed in dark theme */
DarkTheme;
}
export class HomepageSettingsResponse {
/** @param {{HomepageHeading?:string,WelcomePageHeading?:string,WelcomePageBody?:string,AboutUsPageHeading?:string,AboutUsPageBody?:string,ImageUrl?:string,CoverImage?:string,ShowRating?:boolean,HomePageTemplateId?:number,HeroSectionStyleId?:number,EnableHomepage?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The text for homepage heading */
HomepageHeading;
/**
* @type {string}
* @description The text for homepage startpage heading */
WelcomePageHeading;
/**
* @type {string}
* @description The text for homepage startpage body */
WelcomePageBody;
/**
* @type {string}
* @description The text for homepage about us page heading */
AboutUsPageHeading;
/**
* @type {string}
* @description The text for homepage about us page body */
AboutUsPageBody;
/**
* @type {string}
* @description The startpage image url */
ImageUrl;
/**
* @type {string}
* @description The cover image url */
CoverImage;
/**
* @type {boolean}
* @description Show rating on the page */
ShowRating;
/**
* @type {number}
* @description The template for the homepage */
HomePageTemplateId;
/**
* @type {number}
* @description The hero section style for the homepage */
HeroSectionStyleId;
/**
* @type {boolean}
* @description Enable the BokaMera Homepage */
EnableHomepage;
}
export class CompanyRatingSummary {
/** @param {{AverageScore?:number,RatingScore1Count?:number,RatingScore2Count?:number,RatingScore3Count?:number,RaingScore4Count?:number,RatingScore5Count?:number,Count?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The average rating score */
AverageScore;
/**
* @type {number}
* @description The number of ratings of score 1 */
RatingScore1Count;
/**
* @type {number}
* @description The number of ratings of score 2 */
RatingScore2Count;
/**
* @type {number}
* @description The number of ratings of score 3 */
RatingScore3Count;
/**
* @type {number}
* @description The number of ratings of score 4 */
RaingScore4Count;
/**
* @type {number}
* @description The number of ratings of score 5 */
RatingScore5Count;
/**
* @type {number}
* @description The number of ratings */
Count;
}
export class RatingReviewResponse {
/** @param {{Title?:string,Description?:string,RatingScore?:number,Author?:string,Created?:string,ReviewAnswer?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The title for the review */
Title;
/**
* @type {string}
* @description The description for the review */
Description;
/**
* @type {number}
* @description The rating score */
RatingScore;
/**
* @type {string}
* @description The review author */
Author;
/**
* @type {string}
* @description The created date */
Created;
/**
* @type {string}
* @description The review answer from the company */
ReviewAnswer;
}
export class CustomFieldValueResponse {
/** @param {{Value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Value;
}
export class CustomFieldConfigData {
/** @param {{Id?:number,Name?:string,Description?:string,Width?:number,DataType?:string,DefaultValue?:string,IsMandatory?:boolean,MandatoryErrorMessage?:string,MaxLength?:number,MultipleLineText?:boolean,RegEx?:string,RegExErrorMessage?:string,Values?:CustomFieldValueResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Custom field id */
Id;
/**
* @type {string}
* @description Configuration name. Example: 'Number of persons'. */
Name;
/**
* @type {string}
* @description Custom field description. Example: 'For how many persons is this booking?' */
Description;
/**
* @type {?number}
* @description Field width. Example: 20 for 20px */
Width;
/**
* @type {string}
* @description Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' */
DataType;
/**
* @type {string}
* @description Default value of the field. Example: '3' */
DefaultValue;
/**
* @type {boolean}
* @description Determines if the field is required to have a value or not */
IsMandatory;
/**
* @type {string}
* @description Error message shown to the user if the field data is required but not entered */
MandatoryErrorMessage;
/**
* @type {number}
* @description Max lenght of the field */
MaxLength;
/**
* @type {boolean}
* @description If the field should have multiple lines */
MultipleLineText;
/**
* @type {string}
* @description Regular expression used for validation of the field */
RegEx;
/**
* @type {string}
* @description Error message shown if the regular expression validation failed */
RegExErrorMessage;
/**
* @type {CustomFieldValueResponse[]}
* @description The values to select from if Datatype is DropDown for this custom field */
Values;
}
export class CompanyQueryResponse {
/** @param {{Id?:string,Name?:string,OrganisationNumber?:string,TypeId?:number,Details?:string,CategoryId?:number,Category?:string,LogoType?:string,CoverImage?:string,Street1?:string,Street2?:string,ZipCode?:string,City?:string,CountryId?:string,Longitude?:string,Latitude?:string,Distance?:number,Phone?:string,Email?:string,Homepage?:string,SitePath?:string,Active?:boolean,CodeLockSystem?:CodeLockSystemType,IsFreeAccount?:boolean,Updated?:string,Created?:string,StatusId?:number,IsFavorite?:boolean,BookingAgreements?:string,BookingSettings?:CompanyBookingSettings,SystemSettings?:CompanySystemSettings,WidgetSettings?:CompanyWidgetSettings,HomepageSettings?:HomepageSettingsResponse,RatingSummary?:CompanyRatingSummary,Reviews?:RatingReviewResponse[],CustomerCustomFields?:CustomFieldConfigData[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Name;
/**
* @type {string}
* @description The organisation number will only be visible if your owner to the company */
OrganisationNumber;
/**
* @type {?number}
* @description What type of company. If it's used for personal use or as a company. */
TypeId;
/** @type {string} */
Details;
/** @type {number} */
CategoryId;
/** @type {string} */
Category;
/** @type {string} */
LogoType;
/** @type {string} */
CoverImage;
/** @type {string} */
Street1;
/** @type {string} */
Street2;
/** @type {string} */
ZipCode;
/** @type {string} */
City;
/** @type {string} */
CountryId;
/** @type {string} */
Longitude;
/** @type {string} */
Latitude;
/** @type {?number} */
Distance;
/** @type {string} */
Phone;
/** @type {string} */
Email;
/** @type {string} */
Homepage;
/** @type {string} */
SitePath;
/** @type {boolean} */
Active;
/** @type {?CodeLockSystemType} */
CodeLockSystem;
/** @type {boolean} */
IsFreeAccount;
/**
* @type {?string}
* @description Will show when the company was updated, note it will only be shown if your logged in as admin for the company. */
Updated;
/**
* @type {?string}
* @description Will show when the company was created, note it will only be shown if your logged in as admin for the company. */
Created;
/** @type {number} */
StatusId;
/**
* @type {boolean}
* @description If the company is marked as favourite for the logged in user */
IsFavorite;
/** @type {string} */
BookingAgreements;
/** @type {CompanyBookingSettings} */
BookingSettings;
/** @type {CompanySystemSettings} */
SystemSettings;
/** @type {CompanyWidgetSettings} */
WidgetSettings;
/** @type {HomepageSettingsResponse} */
HomepageSettings;
/** @type {CompanyRatingSummary} */
RatingSummary;
/** @type {RatingReviewResponse[]} */
Reviews;
/** @type {CustomFieldConfigData[]} */
CustomerCustomFields;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class UserFavorites {
/** @param {{CompanyId?:string,Company?:CompanyQueryResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CompanyId;
/** @type {CompanyQueryResponse} */
Company;
}
export class UserProfileResponse {
/** @param {{Id?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Firstname;
/** @type {string} */
Lastname;
/** @type {string} */
Phone;
/** @type {string} */
Email;
}
export class AdminProfile {
/** @param {{CompanyId?:string,Id?:string,Firstname?:string,Lastname?:string,Email?:string,WorkerId?:string,Phone?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CompanyId;
/** @type {string} */
Id;
/** @type {string} */
Firstname;
/** @type {string} */
Lastname;
/** @type {string} */
Email;
/** @type {string} */
WorkerId;
/** @type {string} */
Phone;
}
export class CustomFieldDataResponse {
/** @param {{Id?:number,Column?:string,Name?:string,Description?:string,Value?:string,DataType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Column;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Value;
/**
* @type {string}
* @description Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' */
DataType;
}
export class CompanyCustomerResponse {
/** @param {{CompanyId?:string,CompanyName?:string,CustomerId?:string,SubscribedToNewsletter?:boolean,CustomFieldValues?:CustomFieldDataResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
CompanyId;
/** @type {?string} */
CompanyName;
/** @type {?string} */
CustomerId;
/** @type {boolean} */
SubscribedToNewsletter;
/** @type {CustomFieldDataResponse[]} */
CustomFieldValues;
}
export class CurrentUserQueryResponse {
/** @param {{UserId?:string,Favorites?:UserFavorites[],UserProfile?:UserProfileResponse,CustomerProfile?:UserProfileResponse,AdminProfile?:AdminProfile,CompanyCustomers?:CompanyCustomerResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The user id for your profile. */
UserId;
/** @type {UserFavorites[]} */
Favorites;
/** @type {UserProfileResponse} */
UserProfile;
/** @type {UserProfileResponse} */
CustomerProfile;
/** @type {AdminProfile} */
AdminProfile;
/** @type {CompanyCustomerResponse[]} */
CompanyCustomers;
}
export class CurrentUserQuery {
/** @param {{IncludeFavorites?:boolean,IncludeCompanyCustomers?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {boolean}
* @description If you want to include the users favorites */
IncludeFavorites;
/** @type {boolean} */
IncludeCompanyCustomers;
}
JavaScript CurrentUserQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
},
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
},
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,
CompanyName: String,
CustomerId: 00000000-0000-0000-0000-000000000000,
SubscribedToNewsletter: False,
CustomFieldValues:
[
{
Id: 0,
Column: String,
Name: String,
Description: String,
Value: String,
DataType: String
}
]
}
]
}