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