BokaMera.API.Host

<back to all web services

AvailableTimesQuery

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 ExceptionText:
    reason: Optional[str] = None
    reason_public: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableTimesSum(IAvailableTime):
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    free: int = 0
    free_spots: int = 0
    exception_texts: Optional[List[ExceptionText]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableTimesResponse:
    company_id: Optional[str] = None
    service_id: int = 0
    times_free_text_single: Optional[str] = None
    times_free_text_multiple: Optional[str] = None
    times: Optional[List[AvailableTimesSum]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableTimesResourceTypeResource:
    # @ApiMember(Description="The resourcetype id")
    resource_type_id: int = 0
    """
    The resourcetype id
    """


    # @ApiMember(Description="The resource id")
    resource_id: int = 0
    """
    The resource id
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AvailableTimesQuery(IInterval):
    # @ApiMember(Description="Company to show services for", ParameterType="query")
    company_id: Optional[str] = None
    """
    Company to show services for
    """


    # @ApiMember(Description="Service id", IsRequired=true, ParameterType="path")
    service_id: int = 0
    """
    Service id
    """


    # @ApiMember(DataType="dateTime", Description="From what datetime to show available times", IsRequired=true, ParameterType="query")
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    """
    From what datetime to show available times
    """


    # @ApiMember(DataType="dateTime", Description="To what datetime to show available times", IsRequired=true, ParameterType="query")
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    To what datetime to show available times
    """


    # @ApiMember(Description="Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all", ParameterType="query")
    resources: Optional[List[AvailableTimesResourceTypeResource]] = None
    """
    Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all
    """


    # @ApiMember(Description="Here you select number of resources to book (in each resourcetype). Default is 1.", ParameterType="query")
    number_of_resources: int = 0
    """
    Here you select number of resources to book (in each resourcetype). Default is 1.
    """


    # @ApiMember(Description="If you want to include the connected resource types and resources", ParameterType="query")
    show_per_resource: bool = False
    """
    If you want to include the connected resource types and resources
    """


    # @ApiMember(DataType="bool", Description="Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.", ParameterType="query")
    inside_search_interval: bool = False
    """
    Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.
    """


    # @ApiMember(DataType="bool", Description="The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration", ParameterType="query")
    duration: Optional[int] = None
    """
    The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
    """


    response_status: Optional[ResponseStatus] = None

Python AvailableTimesQuery DTOs

GET /services/{ServiceId}/availabletimes HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ServiceId: 0,
	TimesFreeTextSingle: String,
	TimesFreeTextMultiple: String,
	Times: 
	[
		{
			Free: 0,
			FreeSpots: 0
		}
	]
}