| GET | /bookinguserqueue/user | Get all (future) queue items for the logged in user |
|---|
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
# @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 GetAllBookingQueueForUser:
# @ApiMember(Description="The user id for your profile. If not set it will set it automatically from your session")
user_id: Optional[str] = None
"""
The user id for your profile. If not set it will set it automatically from your session
"""
# @ApiMember(DataType="dateTime", Description="Optional start date for the search interval. If not set it will default to todays date.", ParameterType="query")
date_start: Optional[datetime.datetime] = None
"""
Optional start date for the search interval. If not set it will default to todays date.
"""
# @ApiMember(DataType="dateTime", Description="Optional end date for the search interval. If not set all future queue items will be returned.", ParameterType="query")
date_end: Optional[datetime.datetime] = None
"""
Optional end date for the search interval. If not set all future queue items will be returned.
"""
# @ApiMember(DataType="boolean", Description="Set to true if you want to include the queue items for the company you are logged in as administrator on, if false only queue items for the logged in user will be retrieved. Only administrators are allowed to do this.", ParameterType="query")
company_queue_items: bool = False
"""
Set to true if you want to include the queue items for the company you are logged in as administrator on, if false only queue items for the logged in user will be retrieved. Only administrators are allowed to do this.
"""
# @ApiMember(DataType="int", Description="Optional filter for a specific service id.", ParameterType="query")
service_id: Optional[int] = None
"""
Optional filter for a specific service id.
"""
# @ApiMember(DataType="Guid", Description="Optional filter for a specific customer id.", ParameterType="query")
customer_id: Optional[str] = None
"""
Optional filter for a specific customer id.
"""
# @ApiMember(DataType="boolean", Description="If you want to include the service information for the booking", ParameterType="query")
include_service_information: bool = False
"""
If you want to include the service information for the booking
"""
# @ApiMember(DataType="boolean", Description="If you want to include the company information for the booking", ParameterType="query")
include_company_information: bool = False
"""
If you want to include the company information for the booking
"""
# @ApiMember(DataType="boolean", Description="If you want to include the customer information for the booking", ParameterType="query")
include_customer_information: bool = False
"""
If you want to include the customer information for the booking
"""
Python GetAllBookingQueueForUser DTOs
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.
GET /bookinguserqueue/user HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfBookingUserQueueItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookingUserQueueItemResponse>
<BookingUserQueueId>0</BookingUserQueueId>
<Company>
<Id>00000000-0000-0000-0000-000000000000</Id>
<LogoType i:nil="true" />
<Name>String</Name>
<SitePath>String</SitePath>
</Company>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Customer>
<CorporateIdentityNumber>String</CorporateIdentityNumber>
<Email>String</Email>
<FacebookUserName>String</FacebookUserName>
<Firstname>String</Firstname>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ImageUrl>String</ImageUrl>
<InvoiceAddress1>String</InvoiceAddress1>
<InvoiceAddress2>String</InvoiceAddress2>
<InvoiceCity>String</InvoiceCity>
<InvoiceCountryCode>String</InvoiceCountryCode>
<InvoicePostalCode>String</InvoicePostalCode>
<Lastname>String</Lastname>
<PersonalIdentityNumber>String</PersonalIdentityNumber>
<Phone>String</Phone>
</Customer>
<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>
<Price>0</Price>
<PriceText>String</PriceText>
<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>
</ArrayOfBookingUserQueueItemResponse>