BokaMera.API.Host

<back to all web services

RecurringScheduleIntervalsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/schedules/recurring/intervalsGet the schedule intervalsGet the schedule intervals. Note: This must not be the same as the available times.
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 ScheduleIntervalsQueryResponse:
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    duration: datetime.timedelta = datetime.timedelta()


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


    # @ApiMember(DataType="dateTime", Description="From what datetime to show 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 times
    """


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


    # @ApiMember(Description="Here you can select one of the resource, if none is selected it will show available times for all", ParameterType="query")
    resource_ids: Optional[List[int]] = None
    """
    Here you can select one of the resource, if none is selected it will show available times for all
    """


    response_status: Optional[ResponseStatus] = None

Python RecurringScheduleIntervalsQuery 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 /schedules/recurring/intervals HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduleIntervalsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Duration>PT0S</Duration>
  <From>0001-01-01T00:00:00</From>
  <To>0001-01-01T00:00:00</To>
</ScheduleIntervalsQueryResponse>