BokaMera.API.Host

<back to all web services

UpdateQuantity

Requires Authentication
The following routes are available for this service:
PUT/bookings/{BookingId}/quantity/{Id}Update an existing booking quantityUpdates an existing booking quantity if you are authorized to do so. Note: Updating quantity wont updated the number of booked resources.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class BookedQuantity
            '''<Summary>
            '''The quantity Id
            '''</Summary>
            <ApiMember(Description:="The quantity Id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The quantity for booked on this price category
            '''</Summary>
            <ApiMember(Description:="The quantity for booked on this price category")>
            Public Overridable Property Quantity As Integer

            '''<Summary>
            '''The price
            '''</Summary>
            <ApiMember(Description:="The price")>
            Public Overridable Property Price As Nullable(Of Double)

            '''<Summary>
            '''The price bofore rebate codes
            '''</Summary>
            <ApiMember(Description:="The price bofore rebate codes")>
            Public Overridable Property PriceBeforeRebate As Nullable(Of Double)

            '''<Summary>
            '''The price currency
            '''</Summary>
            <ApiMember(Description:="The price currency")>
            Public Overridable Property CurrencyId As String

            '''<Summary>
            '''The price sign
            '''</Summary>
            <ApiMember(Description:="The price sign")>
            Public Overridable Property PriceSign As String

            '''<Summary>
            '''The price category
            '''</Summary>
            <ApiMember(Description:="The price category")>
            Public Overridable Property Category As String

            '''<Summary>
            '''The price VAT in percent
            '''</Summary>
            <ApiMember(Description:="The price VAT in percent")>
            Public Overridable Property VAT As Nullable(Of Decimal)

            '''<Summary>
            '''The price text to display
            '''</Summary>
            <ApiMember(Description:="The price text to display")>
            Public Overridable Property PriceText As String

            '''<Summary>
            '''If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.
            '''</Summary>
            <ApiMember(Description:="If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.")>
            Public Overridable Property OccupiesSpot As Boolean
        End Class

        <ValidateRequest(Validator:="IsAuthenticated")>
        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privilegies to call this service", StatusCode:=403)>
        Public Partial Class UpdateQuantity
            Implements 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.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Id of the booking
            '''</Summary>
            <ApiMember(Description:="Id of the booking", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property BookingId As Nullable(Of Integer)

            '''<Summary>
            '''Id of the quantity
            '''</Summary>
            <ApiMember(Description:="Id of the quantity", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Nullable(Of Integer)

            '''<Summary>
            '''If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.
            '''</Summary>
            <ApiMember(Description:="If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.")>
            Public Overridable Property OccupiesSpot As Nullable(Of Boolean)

            '''<Summary>
            '''The quantity for booked on this price category
            '''</Summary>
            <ApiMember(Description:="The quantity for booked on this price category")>
            Public Overridable Property Quantity As Integer

            '''<Summary>
            '''The price
            '''</Summary>
            <ApiMember(Description:="The price")>
            Public Overridable Property Price As Nullable(Of Double)

            '''<Summary>
            '''The price currency
            '''</Summary>
            <ApiMember(Description:="The price currency")>
            Public Overridable Property CurrencyId As String

            '''<Summary>
            '''The price category
            '''</Summary>
            <ApiMember(Description:="The price category")>
            Public Overridable Property Category As String

            '''<Summary>
            '''The price VAT in percent
            '''</Summary>
            <ApiMember(Description:="The price VAT in percent")>
            Public Overridable Property VAT As Nullable(Of Decimal)

            '''<Summary>
            '''Any comments to be stored in the event log.
            '''</Summary>
            <ApiMember(Description:="Any comments to be stored in the event log.")>
            Public Overridable Property Comments As String

            '''<Summary>
            '''If you want the amount to be refunded automatically if amount is lower than paid
            '''</Summary>
            <ApiMember(Description:="If you want the amount to be refunded automatically if amount is lower than paid")>
            Public Overridable Property Refund As Boolean
        End Class
    End Namespace
End Namespace

VB.NET UpdateQuantity DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /bookings/{BookingId}/quantity/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	BookingId: 0,
	Id: 0,
	OccupiesSpot: False,
	Quantity: 0,
	Price: 0,
	CurrencyId: String,
	Category: String,
	VAT: 0,
	Comments: String,
	Refund: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Quantity: 0,
	Price: 0,
	PriceBeforeRebate: 0,
	CurrencyId: String,
	PriceSign: String,
	Category: String,
	VAT: 0,
	PriceText: String,
	OccupiesSpot: False
}