BokaMera.API.Host

<back to all web services

TestDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/schedules/date/testTest date scheduleTest date schedule, only administrators are allowed to test schedules.
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 AddDateScheduleDate:
    # @ApiMember(Description="The from date for the timeslot", IsRequired=true)
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    """
    The from date for the timeslot
    """


    # @ApiMember(Description="The to date for the timeslot", IsRequired=true)
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The to date for the timeslot
    """


# @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 TestDateSchedule(ICompany, IInterval):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The dates for the schedule. This is the actual timeslots.", IsRequired=true)
    schedule_dates: Optional[List[AddDateScheduleDate]] = None
    """
    The dates for the schedule. This is the actual timeslots.
    """


    # @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="The Service Duration")
    service_id: Optional[int] = None
    """
    The Service Duration
    """

Python TestDateSchedule DTOs

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

HTTP + JSV

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

POST /schedules/date/test HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ScheduleDates: 
	[
		{
			
		}
	],
	ServiceId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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