| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /services/prices/{Id} | Update a price | Update a price on a service |
|---|
export class DayOfWeekDto
{
public DayOfWeekId: number;
public DotNetDayOfWeekId: number;
public DayOfWeek: string;
public constructor(init?: Partial<DayOfWeekDto>) { (Object as any).assign(this, init); }
}
export class GroupBookingSettings
{
public Active: boolean;
public Min: number;
public Max: number;
public constructor(init?: Partial<GroupBookingSettings>) { (Object as any).assign(this, init); }
}
export class MultipleResourceSettings
{
public Active: boolean;
public Min: number;
public Max: number;
public constructor(init?: Partial<MultipleResourceSettings>) { (Object as any).assign(this, init); }
}
export class ServiceInfoResponse
{
public Id: number;
public Name: string;
public Description: string;
public ImageUrl: string;
public LengthInMinutes?: number;
public MaxNumberOfSpotsPerBooking: number;
public MinNumberOfSpotsPerBooking: number;
public GroupBooking: GroupBookingSettings;
public MultipleResource: MultipleResourceSettings;
public IsGroupBooking: boolean;
public IsPaymentEnabled: boolean;
public constructor(init?: Partial<ServiceInfoResponse>) { (Object as any).assign(this, init); }
}
export class ServicePriceResponse
{
/** @description The company id */
// @ApiMember(Description="The company id")
public CompanyId: string;
/** @description The price id */
// @ApiMember(Description="The price id")
public Id: number;
/** @description The service id */
// @ApiMember(Description="The service id")
public ServiceId: number;
/** @description The price */
// @ApiMember(Description="The price")
public Price: number;
/** @description The price calculation type id, 1 = Normal, price is for the service total duration, 2 = Price is per minute, 3 = Price is per hour, 4= Price is per day */
// @ApiMember(Description="The price calculation type id, 1 = Normal, price is for the service total duration, 2 = Price is per minute, 3 = Price is per hour, 4= Price is per day")
public CalculationTypeId: number;
/** @description The price currency */
// @ApiMember(Description="The price currency")
public CurrencyId: string;
/** @description The price sign */
// @ApiMember(Description="The price sign")
public PriceSign: string;
/** @description The price VAT in percent */
// @ApiMember(Description="The price VAT in percent")
public VAT: number;
/** @description The price category if price has a category */
// @ApiMember(Description="The price category if price has a category")
public Category: string;
/** @description The price text to display */
// @ApiMember(Description="The price text to display")
public PriceText: string;
/** @description The valid from date for the price. */
// @ApiMember(Description="The valid from date for the price.")
public From: string;
/** @description The valid to date for the price. */
// @ApiMember(Description="The valid to date for the price.")
public To: string;
/** @description If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update. */
// @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
public DaysOfWeek: DayOfWeekDto[];
/** @description If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update. */
// @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
public FromTime?: string;
/** @description If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters. */
// @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
public ToTime?: string;
public Service: ServiceInfoResponse;
/** @description If the price is only valid for a specific time span */
// @ApiMember(Description="If the price is only valid for a specific time span")
public IsTimeSpecific: boolean;
/** @description If the price is only valid for specific days of week */
// @ApiMember(Description="If the price is only valid for specific days of week")
public IsDaysOfWeekSpecific: boolean;
public constructor(init?: Partial<ServicePriceResponse>) { (Object as any).assign(this, init); }
}
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateServicePrice 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.")
public CompanyId?: string;
/** @description Id of the price */
// @ApiMember(Description="Id of the price", IsRequired=true, ParameterType="path")
public Id: number;
/** @description The price */
// @ApiMember(Description="The price")
public Price: number;
/** @description The price currency */
// @ApiMember(Description="The price currency")
public CurrencyId: string;
/** @description The price calculation type id, 1 = Normal, price is for the service total duration, 2 = Price is per minute, 3 = Price is per hour, 4= Price is per day */
// @ApiMember(Description="The price calculation type id, 1 = Normal, price is for the service total duration, 2 = Price is per minute, 3 = Price is per hour, 4= Price is per day")
public CalculationTypeId: number;
/** @description The price VAT in percent */
// @ApiMember(Description="The price VAT in percent")
public VAT: number;
/** @description The price category if price has a category */
// @ApiMember(Description="The price category if price has a category")
public Category: string;
/** @description The valid from date for the price. */
// @ApiMember(Description="The valid from date for the price.")
public From: string;
/** @description The valid to date for the price. */
// @ApiMember(Description="The valid to date for the price.")
public To: string;
/** @description If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update. */
// @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
public DaysOfWeek: number[];
/** @description If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update. */
// @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
public FromTime?: string;
/** @description If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters. */
// @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
public ToTime?: string;
public constructor(init?: Partial<UpdateServicePrice>) { (Object as any).assign(this, init); }
}
TypeScript UpdateServicePrice DTOs
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 /services/prices/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateServicePrice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CalculationTypeId>0</CalculationTypeId>
<Category>String</Category>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CurrencyId>String</CurrencyId>
<DaysOfWeek xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</DaysOfWeek>
<From>0001-01-01T00:00:00</From>
<FromTime>PT0S</FromTime>
<Id>0</Id>
<Price>0</Price>
<To>0001-01-01T00:00:00</To>
<ToTime>PT0S</ToTime>
<VAT>0</VAT>
</UpdateServicePrice>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ServicePriceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CalculationTypeId>0</CalculationTypeId>
<Category>String</Category>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CurrencyId>String</CurrencyId>
<DaysOfWeek>
<DayOfWeekDto>
<DayOfWeek>String</DayOfWeek>
<DayOfWeekId>0</DayOfWeekId>
<DotNetDayOfWeekId>0</DotNetDayOfWeekId>
</DayOfWeekDto>
</DaysOfWeek>
<From>0001-01-01T00:00:00</From>
<FromTime>PT0S</FromTime>
<Id>0</Id>
<IsDaysOfWeekSpecific>false</IsDaysOfWeekSpecific>
<IsTimeSpecific>false</IsTimeSpecific>
<Price>0</Price>
<PriceSign>String</PriceSign>
<PriceText>String</PriceText>
<Service>
<Description>String</Description>
<GroupBooking>
<Active>false</Active>
<Max>0</Max>
<Min>0</Min>
</GroupBooking>
<Id>0</Id>
<ImageUrl i:nil="true" />
<IsGroupBooking>false</IsGroupBooking>
<IsPaymentEnabled>false</IsPaymentEnabled>
<LengthInMinutes>0</LengthInMinutes>
<MaxNumberOfSpotsPerBooking>0</MaxNumberOfSpotsPerBooking>
<MinNumberOfSpotsPerBooking>0</MinNumberOfSpotsPerBooking>
<MultipleResource>
<Active>false</Active>
<Max>0</Max>
<Min>0</Min>
</MultipleResource>
<Name>String</Name>
</Service>
<ServiceId>0</ServiceId>
<To>0001-01-01T00:00:00</To>
<ToTime>PT0S</ToTime>
<VAT>0</VAT>
</ServicePriceResponse>