Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /services/prices/{Id} | Update a price | Update a price on a service |
---|
import Foundation
import ServiceStack
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateServicePrice : ICompany, Codable
{
/**
* 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 var companyId:String?
/**
* Id of the price
*/
// @ApiMember(Description="Id of the price", IsRequired=true, ParameterType="path")
public var id:Int
/**
* The price
*/
// @ApiMember(Description="The price")
public var price:Double
/**
* The price currency
*/
// @ApiMember(Description="The price currency")
public var currencyId:String
/**
* 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 var calculationTypeId:Int
/**
* The price VAT in percent
*/
// @ApiMember(Description="The price VAT in percent")
public var vat:Double
/**
* The price category if price has a category
*/
// @ApiMember(Description="The price category if price has a category")
public var category:String
/**
* The valid from date for the price.
*/
// @ApiMember(Description="The valid from date for the price.")
public var from:Date
/**
* The valid to date for the price.
*/
// @ApiMember(Description="The valid to date for the price.")
public var to:Date
/**
* 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 var daysOfWeek:[Int] = []
/**
* 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.")
@TimeSpan public var fromTime:TimeInterval?
/**
* 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.")
@TimeSpan public var toTime:TimeInterval?
required public init(){}
}
public class ServicePriceResponse : Codable
{
/**
* The company id
*/
// @ApiMember(Description="The company id")
public var companyId:String
/**
* The price id
*/
// @ApiMember(Description="The price id")
public var id:Int
/**
* The service id
*/
// @ApiMember(Description="The service id")
public var serviceId:Int
/**
* The price
*/
// @ApiMember(Description="The price")
public var price:Double
/**
* 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 var calculationTypeId:Int
/**
* The price currency
*/
// @ApiMember(Description="The price currency")
public var currencyId:String
/**
* The price sign
*/
// @ApiMember(Description="The price sign")
public var priceSign:String
/**
* The price VAT in percent
*/
// @ApiMember(Description="The price VAT in percent")
public var vat:Double
/**
* The price category if price has a category
*/
// @ApiMember(Description="The price category if price has a category")
public var category:String
/**
* The price text to display
*/
// @ApiMember(Description="The price text to display")
public var priceText:String
/**
* The valid from date for the price.
*/
// @ApiMember(Description="The valid from date for the price.")
public var from:Date
/**
* The valid to date for the price.
*/
// @ApiMember(Description="The valid to date for the price.")
public var to:Date
/**
* 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 var daysOfWeek:[DayOfWeekDto] = []
/**
* 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.")
@TimeSpan public var fromTime:TimeInterval?
/**
* 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.")
@TimeSpan public var toTime:TimeInterval?
public var service:ServiceInfoResponse
/**
* 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 var isTimeSpecific:Bool
/**
* 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 var isDaysOfWeekSpecific:Bool
required public init(){}
}
public class DayOfWeekDto : Codable
{
public var dayOfWeekId:Int
public var dotNetDayOfWeekId:Int
public var dayOfWeek:String
required public init(){}
}
public class ServiceInfoResponse : Codable
{
public var id:Int
public var name:String
public var Description:String
public var imageUrl:Uri
public var lengthInMinutes:Int?
public var maxNumberOfSpotsPerBooking:Int
public var minNumberOfSpotsPerBooking:Int
public var groupBooking:GroupBookingSettings
public var multipleResource:MultipleResourceSettings
public var isGroupBooking:Bool
public var isPaymentEnabled:Bool
required public init(){}
}
public class GroupBookingSettings : Codable
{
public var active:Bool
public var min:Int
public var max:Int
required public init(){}
}
public class MultipleResourceSettings : Codable
{
public var active:Bool
public var min:Int
public var max:Int
required public 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 /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>