| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /companies/{CompanyId} | Update existing company | Updates your company profile information. |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.CodeLock.Model.Api;
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class CompanyBookingSettings
{
public virtual bool EnableMobileApp { get; set; }
public virtual string BookingReceiptMessage { get; set; }
public virtual bool ShowFreeTimesLeft { get; set; }
public virtual bool EnableShowBookedTimes { get; set; }
public virtual string BookingAgreement { get; set; }
///<summary>
///The settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber
///</summary>
[ApiMember(DataType="int", Description="The settings for how to display week number. 1 = ShowWeekNumberFromDate, 2 = ShowWeekNumberToDate, 3 = ShowWeekNumberFromToDate, 4 = DontShowWeekNumber ")]
public virtual int WeekNumberSetting { get; set; }
public virtual bool ShowBookedTimes { get; set; }
///<summary>
///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
///</summary>
[ApiMember(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")]
public virtual int PaymentProviderId { get; set; }
///<summary>
///If it's only allowed for existing customers to book
///</summary>
[ApiMember(DataType="boolean", Description="If it's only allowed for existing customers to book")]
public virtual bool BookOnlyOnExistingCustomers { get; set; }
///<summary>
///If payment is enabled
///</summary>
[ApiMember(DataType="boolean", Description="If payment is enabled")]
public virtual bool PaymentEnabled { get; set; }
}
public partial class CompanyQueryResponse
{
public CompanyQueryResponse()
{
Reviews = new List<RatingReviewResponse>{};
CustomerCustomFields = new List<CustomFieldConfigData>{};
}
public virtual Guid Id { get; set; }
public virtual string Name { get; set; }
///<summary>
///The organisation number will only be visible if your owner to the company
///</summary>
[ApiMember(DataType="string", Description="The organisation number will only be visible if your owner to the company")]
public virtual string OrganisationNumber { get; set; }
///<summary>
///What type of company. If it's used for personal use or as a company.
///</summary>
[ApiMember(DataType="int", Description="What type of company. If it's used for personal use or as a company.")]
public virtual int? TypeId { get; set; }
public virtual string Details { get; set; }
public virtual int CategoryId { get; set; }
public virtual string Category { get; set; }
public virtual Uri LogoType { get; set; }
public virtual Uri CoverImage { get; set; }
public virtual string Street1 { get; set; }
public virtual string Street2 { get; set; }
public virtual string ZipCode { get; set; }
public virtual string City { get; set; }
public virtual string CountryId { get; set; }
public virtual string Longitude { get; set; }
public virtual string Latitude { get; set; }
public virtual double? Distance { get; set; }
public virtual string Phone { get; set; }
public virtual string Email { get; set; }
public virtual string Homepage { get; set; }
public virtual string SitePath { get; set; }
public virtual bool Active { get; set; }
public virtual CodeLockSystemType? CodeLockSystem { get; set; }
public virtual bool IsFreeAccount { get; set; }
///<summary>
///Will show when the company was updated, note it will only be shown if your logged in as admin for the company.
///</summary>
[ApiMember(DataType="datetime", Description="Will show when the company was updated, note it will only be shown if your logged in as admin for the company.")]
public virtual DateTime? Updated { get; set; }
///<summary>
///Will show when the company was created, note it will only be shown if your logged in as admin for the company.
///</summary>
[ApiMember(DataType="datetime", Description="Will show when the company was created, note it will only be shown if your logged in as admin for the company.")]
public virtual DateTime? Created { get; set; }
public virtual int StatusId { get; set; }
///<summary>
///If the company is marked as favourite for the logged in user
///</summary>
[ApiMember(DataType="boolean", Description="If the company is marked as favourite for the logged in user")]
public virtual bool IsFavorite { get; set; }
public virtual string BookingAgreements { get; set; }
public virtual CompanyBookingSettings BookingSettings { get; set; }
public virtual CompanySystemSettings SystemSettings { get; set; }
public virtual CompanyWidgetSettings WidgetSettings { get; set; }
public virtual HomepageSettingsResponse HomepageSettings { get; set; }
public virtual CompanyRatingSummary RatingSummary { get; set; }
public virtual List<RatingReviewResponse> Reviews { get; set; }
public virtual List<CustomFieldConfigData> CustomerCustomFields { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class CompanyRatingSummary
{
///<summary>
///The average rating score
///</summary>
[ApiMember(Description="The average rating score")]
public virtual double AverageScore { get; set; }
///<summary>
///The number of ratings of score 1
///</summary>
[ApiMember(Description="The number of ratings of score 1")]
public virtual int RatingScore1Count { get; set; }
///<summary>
///The number of ratings of score 2
///</summary>
[ApiMember(Description="The number of ratings of score 2")]
public virtual int RatingScore2Count { get; set; }
///<summary>
///The number of ratings of score 3
///</summary>
[ApiMember(Description="The number of ratings of score 3")]
public virtual int RatingScore3Count { get; set; }
///<summary>
///The number of ratings of score 4
///</summary>
[ApiMember(Description="The number of ratings of score 4")]
public virtual int RaingScore4Count { get; set; }
///<summary>
///The number of ratings of score 5
///</summary>
[ApiMember(Description="The number of ratings of score 5")]
public virtual int RatingScore5Count { get; set; }
///<summary>
///The number of ratings
///</summary>
[ApiMember(Description="The number of ratings")]
public virtual int Count { get; set; }
}
public partial class CompanySystemSettings
{
///<summary>
///If the booking is active or not
///</summary>
[ApiMember(DataType="bool", Description="If the booking is active or not")]
public virtual bool Active { get; set; }
///<summary>
///If the booking is not active, what message to show to the customers
///</summary>
[ApiMember(DataType="string", Description="If the booking is not active, what message to show to the customers")]
public virtual string InactiveMessage { get; set; }
///<summary>
///If the company should be visible in search results on hompage
///</summary>
[ApiMember(DataType="bool", Description="If the company should be visible in search results on hompage")]
public virtual bool Searchable { get; set; }
///<summary>
///If you have a google analytics account and want to track your customers behaviors.
///</summary>
[ApiMember(DataType="string", Description="If you have a google analytics account and want to track your customers behaviors.")]
public virtual string GATrackingId { get; set; }
///<summary>
///If you have a google Ads Conversion Id account and want to track your customers behaviors.
///</summary>
[ApiMember(DataType="string", Description="If you have a google Ads Conversion Id account and want to track your customers behaviors.")]
public virtual string GoogleAdsConversionId { get; set; }
///<summary>
///If you have a LinkedIn account and want to track your customers behaviors.
///</summary>
[ApiMember(DataType="string", Description="If you have a LinkedIn account and want to track your customers behaviors.")]
public virtual string LinkedinTagId { get; set; }
///<summary>
///If you have a Google Ads Conversion Label and want to track your customers behaviors.
///</summary>
[ApiMember(DataType="string", Description="If you have a Google Ads Conversion Label and want to track your customers behaviors.")]
public virtual string GoogleAdsConversionLabel { get; set; }
///<summary>
///If you have a google tag manager account and want to track your customers behaviors.
///</summary>
[ApiMember(DataType="string", Description="If you have a google tag manager account and want to track your customers behaviors.")]
public virtual string GTMTrackingId { get; set; }
///<summary>
///If you have a facebook account and want to track your customers behaviors.
///</summary>
[ApiMember(DataType="string", Description="If you have a facebook account and want to track your customers behaviors.")]
public virtual string FacebookPixelId { get; set; }
///<summary>
///If you want your customers to be albe to change language on your homepage
///</summary>
[ApiMember(DataType="bool", Description="If you want your customers to be albe to change language on your homepage")]
public virtual bool MultiLanguage { get; set; }
///<summary>
///If the company should be visible on the marketplace
///</summary>
[ApiMember(DataType="bool", Description="If the company should be visible on the marketplace")]
public virtual bool ShowOnMarketplace { get; set; }
///<summary>
///If you want your own written text on your homepage to be translated using google analytics when a user changes language
///</summary>
[ApiMember(DataType="bool", Description="If you want your own written text on your homepage to be translated using google analytics when a user changes language")]
public virtual bool EnableAPITranslation { get; set; }
///<summary>
///What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN
///</summary>
[ApiMember(DataType="string", Description="What is the standard language your homepage information is written in. Select from the different countries, ie. SE,NO,EN")]
public virtual string DefaultLanguage { get; set; }
}
public partial class CompanyWidgetSettings
{
///<summary>
///The service layouts id.
///</summary>
[ApiMember(Description="The service layouts id.")]
public virtual int ServiceLayoutId { get; set; }
///<summary>
///The time layouts id.
///</summary>
[ApiMember(Description="The time layouts id.")]
public virtual int TimeLayoutId { get; set; }
///<summary>
///The booking layouts id.
///</summary>
[ApiMember(Description="The booking layouts id.")]
public virtual int BookingLayoutId { get; set; }
///<summary>
///The primary color of the booking widget.
///</summary>
[ApiMember(Description="The primary color of the booking widget.")]
public virtual string PrimaryColor { get; set; }
///<summary>
///If you should show the service image in the booking widget.
///</summary>
[ApiMember(Description="If you should show the service image in the booking widget.")]
public virtual bool ShowServiceImage { get; set; }
///<summary>
///If you should show the rebate code field in the booking widget.
///</summary>
[ApiMember(Description="If you should show the rebate code field in the booking widget.")]
public virtual bool ShowRebateCodeField { get; set; }
///<summary>
///If you should show the next available time in the booking widget.
///</summary>
[ApiMember(Description="If you should show the next available time in the booking widget.")]
public virtual bool ShowNextAvailableTime { get; set; }
///<summary>
///If you should show the end time in the booking widget.
///</summary>
[ApiMember(Description="If you should show the end time in the booking widget.")]
public virtual bool ShowEndTime { get; set; }
///<summary>
///What text to show on booked time slots. Default text is Booked
///</summary>
[ApiMember(Description="What text to show on booked time slots. Default text is Booked")]
public virtual string BookedTimeSlotText { get; set; }
///<summary>
///If the widget should be displayed in dark theme
///</summary>
[ApiMember(Description="If the widget should be displayed in dark theme")]
public virtual bool DarkTheme { get; set; }
}
public partial class CustomFieldConfigData
{
public CustomFieldConfigData()
{
Values = new List<CustomFieldValueResponse>{};
}
///<summary>
///Custom field id
///</summary>
[ApiMember(Description="Custom field id")]
public virtual int Id { get; set; }
///<summary>
///Configuration name. Example: 'Number of persons'.
///</summary>
[ApiMember(Description="Configuration name. Example: 'Number of persons'.")]
public virtual string Name { get; set; }
///<summary>
///Custom field description. Example: 'For how many persons is this booking?'
///</summary>
[ApiMember(Description="Custom field description. Example: 'For how many persons is this booking?'")]
public virtual string Description { get; set; }
///<summary>
///Field width. Example: 20 for 20px
///</summary>
[ApiMember(Description="Field width. Example: 20 for 20px")]
public virtual int? Width { get; set; }
///<summary>
///Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'
///</summary>
[ApiMember(Description="Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox'")]
public virtual string DataType { get; set; }
///<summary>
///Default value of the field. Example: '3'
///</summary>
[ApiMember(Description="Default value of the field. Example: '3'")]
public virtual string DefaultValue { get; set; }
///<summary>
///Determines if the field is required to have a value or not
///</summary>
[ApiMember(Description="Determines if the field is required to have a value or not")]
public virtual bool IsMandatory { get; set; }
///<summary>
///Error message shown to the user if the field data is required but not entered
///</summary>
[ApiMember(Description="Error message shown to the user if the field data is required but not entered")]
public virtual string MandatoryErrorMessage { get; set; }
///<summary>
///Max lenght of the field
///</summary>
[ApiMember(Description="Max lenght of the field")]
public virtual int MaxLength { get; set; }
///<summary>
///If the field should have multiple lines
///</summary>
[ApiMember(Description="If the field should have multiple lines")]
public virtual bool MultipleLineText { get; set; }
///<summary>
///Regular expression used for validation of the field
///</summary>
[ApiMember(Description="Regular expression used for validation of the field")]
public virtual string RegEx { get; set; }
///<summary>
///Error message shown if the regular expression validation failed
///</summary>
[ApiMember(Description="Error message shown if the regular expression validation failed")]
public virtual string RegExErrorMessage { get; set; }
///<summary>
///The values to select from if Datatype is DropDown for this custom field
///</summary>
[ApiMember(Description="The values to select from if Datatype is DropDown for this custom field")]
public virtual List<CustomFieldValueResponse> Values { get; set; }
}
public partial class CustomFieldValueResponse
{
public virtual string Value { get; set; }
}
public partial class HomepageSettingsResponse
{
///<summary>
///The text for homepage heading
///</summary>
[ApiMember(Description="The text for homepage heading")]
public virtual string HomepageHeading { get; set; }
///<summary>
///The text for homepage startpage heading
///</summary>
[ApiMember(Description="The text for homepage startpage heading")]
public virtual string WelcomePageHeading { get; set; }
///<summary>
///The text for homepage startpage body
///</summary>
[ApiMember(Description="The text for homepage startpage body")]
public virtual string WelcomePageBody { get; set; }
///<summary>
///The text for homepage about us page heading
///</summary>
[ApiMember(Description="The text for homepage about us page heading")]
public virtual string AboutUsPageHeading { get; set; }
///<summary>
///The text for homepage about us page body
///</summary>
[ApiMember(Description="The text for homepage about us page body")]
public virtual string AboutUsPageBody { get; set; }
///<summary>
///The startpage image url
///</summary>
[ApiMember(Description="The startpage image url")]
public virtual Uri ImageUrl { get; set; }
///<summary>
///The cover image url
///</summary>
[ApiMember(Description="The cover image url")]
public virtual Uri CoverImage { get; set; }
///<summary>
///Show rating on the page
///</summary>
[ApiMember(Description="Show rating on the page")]
public virtual bool ShowRating { get; set; }
///<summary>
///The template for the homepage
///</summary>
[ApiMember(Description="The template for the homepage")]
public virtual int HomePageTemplateId { get; set; }
///<summary>
///The hero section style for the homepage
///</summary>
[ApiMember(Description="The hero section style for the homepage")]
public virtual int HeroSectionStyleId { get; set; }
///<summary>
///Enable the BokaMera Homepage
///</summary>
[ApiMember(Description="Enable the BokaMera Homepage")]
public virtual bool EnableHomepage { get; set; }
}
public partial class RatingReviewResponse
{
///<summary>
///The title for the review
///</summary>
[ApiMember(Description="The title for the review")]
public virtual string Title { get; set; }
///<summary>
///The description for the review
///</summary>
[ApiMember(Description="The description for the review")]
public virtual string Description { get; set; }
///<summary>
///The rating score
///</summary>
[ApiMember(Description="The rating score")]
public virtual int RatingScore { get; set; }
///<summary>
///The review author
///</summary>
[ApiMember(Description="The review author")]
public virtual string Author { get; set; }
///<summary>
///The created date
///</summary>
[ApiMember(Description="The created date")]
public virtual DateTime Created { get; set; }
///<summary>
///The review answer from the company
///</summary>
[ApiMember(Description="The review answer from the company")]
public virtual string ReviewAnswer { get; set; }
}
[ValidateRequest("IsAuthenticated")]
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
public partial class UpdateCompany
: ICompany
{
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", IsRequired=true, ParameterType="path")]
public virtual Guid? CompanyId { get; set; }
public virtual string Name { get; set; }
public virtual string OrganisationNumber { get; set; }
///<summary>
///What type of company. If it's used for personal use or as a company. 1 = Company use, 2 = Personal use
///</summary>
[ApiMember(DataType="int", Description="What type of company. If it's used for personal use or as a company. 1 = Company use, 2 = Personal use")]
public virtual int? TypeId { get; set; }
public virtual string OpeningHours { get; set; }
public virtual string Details { get; set; }
public virtual int? CategoryId { get; set; }
public virtual Uri LogoType { get; set; }
public virtual string Street1 { get; set; }
public virtual string Street2 { get; set; }
public virtual string ZipCode { get; set; }
public virtual string City { get; set; }
public virtual string CountryId { get; set; }
public virtual string Longitude { get; set; }
public virtual string Latitude { get; set; }
public virtual string Phone { get; set; }
public virtual string Email { get; set; }
public virtual string Fax { get; set; }
public virtual string Homepage { get; set; }
public virtual string SitePath { get; set; }
}
}
namespace BokaMera.CodeLock.Model.Api
{
public enum CodeLockSystemType
{
Sample,
RcoM5,
AxemaVaka,
VanderbiltOmnis,
ParakeyParakey,
AmidoDax,
TelkeyTelkey,
TechSolutionsSiedle,
Accessy,
Zesec,
Enabla,
}
}
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.
PUT /companies/{CompanyId} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Name: String,
OrganisationNumber: String,
TypeId: 0,
OpeningHours: String,
Details: String,
CategoryId: 0,
Street1: String,
Street2: String,
ZipCode: String,
City: String,
CountryId: String,
Longitude: String,
Latitude: String,
Phone: String,
Email: String,
Fax: String,
Homepage: String,
SitePath: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}