BokaMera.API.Host

<back to all web services

GetAllBookingQueueForAdmin

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/bookinguserqueue/companyGet all queue items for company
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingUserQueuePriceResponse:
    company_id: Optional[str] = None
    id: int = 0
    booking_user_queue_id: int = 0
    service_price_id: Optional[int] = None
    quantity: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GroupBookingSettings:
    active: bool = False
    min: int = 0
    max: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MultipleResourceSettings:
    active: bool = False
    min: int = 0
    max: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ServiceInfoResponse:
    id: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    image_url: Optional[str] = None
    length_in_minutes: Optional[int] = None
    max_number_of_spots_per_booking: int = 0
    min_number_of_spots_per_booking: int = 0
    group_booking: Optional[GroupBookingSettings] = None
    multiple_resource: Optional[MultipleResourceSettings] = None
    is_group_booking: bool = False
    is_payment_enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyInfoResponse:
    id: Optional[str] = None
    name: Optional[str] = None
    logo_type: Optional[str] = None
    category: Optional[str] = None
    street1: Optional[str] = None
    street2: Optional[str] = None
    zip_code: Optional[str] = None
    city: Optional[str] = None
    country_id: Optional[str] = None
    longitude: Optional[str] = None
    latitude: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None
    home_page: Optional[str] = None
    site_path: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingUserQueueItemResponse:
    booking_user_queue_id: int = 0
    company_id: Optional[str] = None
    customer_id: Optional[str] = None
    service_id: int = 0
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    status_code: int = 0
    status_name: Optional[str] = None
    send_confirmation_time: Optional[datetime.datetime] = None
    quantities: Optional[List[BookingUserQueuePriceResponse]] = None
    service: Optional[ServiceInfoResponse] = None
    company: Optional[CompanyInfoResponse] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAllBookingQueueForUserResponse:
    booking_user_queue_response_list: Optional[List[BookingUserQueueItemResponse]] = None
    response_status: Optional[ResponseStatus] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetAllBookingQueueForAdmin:
    company_id: Optional[str] = None
    service_id: int = 0
    date_start: Optional[datetime.datetime] = None
    date_end: Optional[datetime.datetime] = None

Python GetAllBookingQueueForAdmin 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.

GET /bookinguserqueue/company HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAllBookingQueueForUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingUserQueueResponseList>
    <BookingUserQueueItemResponse>
      <BookingUserQueueId>0</BookingUserQueueId>
      <Company>
        <Category>String</Category>
        <City>String</City>
        <CountryId>String</CountryId>
        <Email>String</Email>
        <HomePage>String</HomePage>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <Latitude>String</Latitude>
        <LogoType i:nil="true" />
        <Longitude>String</Longitude>
        <Name>String</Name>
        <Phone>String</Phone>
        <SitePath>String</SitePath>
        <Street1>String</Street1>
        <Street2>String</Street2>
        <ZipCode>String</ZipCode>
      </Company>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <From>0001-01-01T00:00:00</From>
      <Quantities>
        <BookingUserQueuePriceResponse>
          <BookingUserQueueId>0</BookingUserQueueId>
          <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
          <Id>0</Id>
          <Quantity>0</Quantity>
          <ServicePriceId>0</ServicePriceId>
        </BookingUserQueuePriceResponse>
      </Quantities>
      <SendConfirmationTime>0001-01-01T00:00:00</SendConfirmationTime>
      <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>
      <StatusCode>0</StatusCode>
      <StatusName>String</StatusName>
      <To>0001-01-01T00:00:00</To>
    </BookingUserQueueItemResponse>
  </BookingUserQueueResponseList>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetAllBookingQueueForUserResponse>