| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /services/prices/ | Create a price | Create a new price on the service |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ValidateRequest(Validator="IsAuthenticated")
open class CreateServicePrice : ICompany
{
/**
* 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.")
var CompanyId:UUID? = null
/**
* The service id
*/
@ApiMember(Description="The service id", IsRequired=true)
var ServiceId:Int? = null
/**
* The price
*/
@ApiMember(Description="The price", IsRequired=true)
var Price:Double? = null
/**
* The price currency
*/
@ApiMember(Description="The price currency", IsRequired=true)
var CurrencyId:String? = null
/**
* 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", IsRequired=true)
var CalculationTypeId:Int? = null
/**
* The price VAT in percent
*/
@ApiMember(Description="The price VAT in percent", IsRequired=true)
var VAT:BigDecimal? = null
/**
* The price category if price has a category
*/
@ApiMember(Description="The price category if price has a category")
var Category:String? = null
/**
* The valid from date for the price.
*/
@ApiMember(Description="The valid from date for the price.")
var From:Date? = null
/**
* The valid to date for the price.
*/
@ApiMember(Description="The valid to date for the price.")
var To:Date? = null
/**
* 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.")
var DaysOfWeek:ArrayList<Int>? = null
/**
* 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.")
var FromTime:TimeSpan? = null
/**
* 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.")
var ToTime:TimeSpan? = null
}
open class ServicePriceResponse
{
/**
* The company id
*/
@ApiMember(Description="The company id")
var CompanyId:UUID? = null
/**
* The price id
*/
@ApiMember(Description="The price id")
var Id:Int? = null
/**
* The service id
*/
@ApiMember(Description="The service id")
var ServiceId:Int? = null
/**
* The price
*/
@ApiMember(Description="The price")
var Price:Double? = null
/**
* 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")
var CalculationTypeId:Int? = null
/**
* The price currency
*/
@ApiMember(Description="The price currency")
var CurrencyId:String? = null
/**
* The price sign
*/
@ApiMember(Description="The price sign")
var PriceSign:String? = null
/**
* The price VAT in percent
*/
@ApiMember(Description="The price VAT in percent")
var VAT:BigDecimal? = null
/**
* The price category if price has a category
*/
@ApiMember(Description="The price category if price has a category")
var Category:String? = null
/**
* The price text to display
*/
@ApiMember(Description="The price text to display")
var PriceText:String? = null
/**
* The valid from date for the price.
*/
@ApiMember(Description="The valid from date for the price.")
var From:Date? = null
/**
* The valid to date for the price.
*/
@ApiMember(Description="The valid to date for the price.")
var To:Date? = null
/**
* 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.")
var DaysOfWeek:ArrayList<DayOfWeekDto> = ArrayList<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.")
var FromTime:TimeSpan? = null
/**
* 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.")
var ToTime:TimeSpan? = null
var Service:ServiceInfoResponse? = null
/**
* If the price is only valid for a specific time span
*/
@ApiMember(Description="If the price is only valid for a specific time span")
var IsTimeSpecific:Boolean? = null
/**
* If the price is only valid for specific days of week
*/
@ApiMember(Description="If the price is only valid for specific days of week")
var IsDaysOfWeekSpecific:Boolean? = null
/**
* If the price is Weighted
*/
@ApiMember(Description="If the price is Weighted")
var IsWeighted:Boolean? = null
}
open class DayOfWeekDto
{
var DayOfWeekId:Int? = null
var DotNetDayOfWeekId:Int? = null
var DayOfWeek:String? = null
}
open class ServiceInfoResponse
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
var ImageUrl:Uri? = null
var LengthInMinutes:Int? = null
var MaxNumberOfSpotsPerBooking:Int? = null
var GroupBooking:GroupBookingSettings? = null
var MultipleResource:MultipleResourceSettings? = null
var IsGroupBooking:Boolean? = null
var IsPaymentEnabled:Boolean? = null
}
open class GroupBookingSettings
{
var Active:Boolean? = null
var Min:Int? = null
var Max:Int? = null
}
open class MultipleResourceSettings
{
var Active:Boolean? = null
var Min:Int? = null
var Max:Int? = null
}
Kotlin CreateServicePrice 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.
POST /services/prices/ HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
ServiceId: 0,
Price: 0,
CurrencyId: String,
CalculationTypeId: 0,
VAT: 0,
Category: String,
DaysOfWeek:
[
0
],
FromTime: PT0S,
ToTime: PT0S
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
ServiceId: 0,
Price: 0,
CalculationTypeId: 0,
CurrencyId: String,
PriceSign: String,
VAT: 0,
Category: String,
PriceText: String,
DaysOfWeek:
[
{
DayOfWeekId: 0,
DotNetDayOfWeekId: 0,
DayOfWeek: String
}
],
FromTime: PT0S,
ToTime: PT0S,
Service:
{
Id: 0,
Name: String,
Description: String,
LengthInMinutes: 0,
MaxNumberOfSpotsPerBooking: 0,
GroupBooking:
{
Active: False,
Min: 0,
Max: 0
},
MultipleResource:
{
Active: False,
Min: 0,
Max: 0
},
IsGroupBooking: False,
IsPaymentEnabled: False
},
IsTimeSpecific: False,
IsDaysOfWeekSpecific: False,
IsWeighted: False
}