BokaMera.API.Host

<back to all web services

AddQuantity

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/bookings/{BookingId}/quantity/Add an booking quantityUpdates an booking quantity if you are authorized to do so. Note: Add quantity wont update 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

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privilegies to call this service", StatusCode:=403)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class AddQuantity
            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>
            '''The quantity for booked on this price category
            '''</Summary>
            <ApiMember(Description:="The quantity for booked on this price category", IsRequired:=true)>
            Public Overridable Property Quantity As Nullable(Of 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>
            '''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

            '''<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
        End Class

        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
    End Namespace
End Namespace

VB.NET AddQuantity DTOs

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

HTTP + XML

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

POST /bookings/{BookingId}/quantity/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <Category>String</Category>
  <Comments>String</Comments>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CurrencyId>String</CurrencyId>
  <OccupiesSpot>false</OccupiesSpot>
  <Price>0</Price>
  <Quantity>0</Quantity>
  <VAT>0</VAT>
</AddQuantity>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BookedQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Category>String</Category>
  <CurrencyId>String</CurrencyId>
  <Id>0</Id>
  <OccupiesSpot>false</OccupiesSpot>
  <Price>0</Price>
  <PriceBeforeRebate>0</PriceBeforeRebate>
  <PriceSign>String</PriceSign>
  <PriceText>String</PriceText>
  <Quantity>0</Quantity>
  <VAT>0</VAT>
</BookedQuantity>