| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /schedules/date | Add new date schedule | Add new date schedule to the company for the currently logged in user, only administrators are allowed to add 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 DateScheduleDateResponse:
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)
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleResources:
id: int = 0
# @ApiMember(Description="Name of the resource")
name: Optional[str] = None
"""
Name of the resource
"""
# @ApiMember(Description="The image url of the resource")
image_url: Optional[str] = None
"""
The image url of the resource
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleServices:
id: int = 0
# @ApiMember(Description="Name of the service")
name: Optional[str] = None
"""
Name of the service
"""
# @ApiMember(Description="The image url of the service")
image_url: Optional[str] = None
"""
The image url of the service
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DateScheduleQueryResponse:
# @ApiMember(Description="The schedule id")
id: int = 0
"""
The schedule id
"""
# @ApiMember(Description="Name of the schedule")
name: Optional[str] = None
"""
Name of the schedule
"""
# @ApiMember(Description="Description of the schedule")
description: Optional[str] = None
"""
Description of the schedule
"""
# @ApiMember(Description="If the schedule is active or not")
active: bool = False
"""
If the schedule is active or not
"""
# @ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)
is_resource_specific: Optional[bool] = None
"""
If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
"""
# @ApiMember(Description="Schedule dates")
schedule_dates: Optional[List[DateScheduleDateResponse]] = None
"""
Schedule dates
"""
# @ApiMember(Description="The resources that is connected to the schedule")
resources: Optional[List[ScheduleResources]] = None
"""
The resources that is connected to the schedule
"""
# @ApiMember(Description="The services that is connected to the schedule")
services: Optional[List[ScheduleServices]] = None
"""
The services that is connected to the schedule
"""
# @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The timestamp when the schedule was updated
"""
# @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The timestamp when the schedule was created
"""
response_status: Optional[ResponseStatus] = 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
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddScheduleResource:
# @ApiMember(Description="The resource id", IsRequired=true)
id: int = 0
"""
The resource id
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddScheduleService:
# @ApiMember(Description="The service id", IsRequired=true)
id: int = 0
"""
The service id
"""
# @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 CreateDateSchedule(ICompany):
# @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 schedule name")
name: Optional[str] = None
"""
The schedule name
"""
# @ApiMember(Description="The schedule description")
description: Optional[str] = None
"""
The schedule description
"""
# @ApiMember(Description="If schedule is active or not")
active: bool = False
"""
If schedule is active or not
"""
# @ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)
number_of_schedule_days: int = 0
"""
The number of days the schedule is valid from todays date
"""
# @ApiMember(Description="The dates for the schedule. This is the actual timeslots.")
schedule_dates: Optional[List[AddDateScheduleDate]] = None
"""
The dates for the schedule. This is the actual timeslots.
"""
# @ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")
resources: Optional[List[AddScheduleResource]] = None
"""
If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
"""
# @ApiMember(Description="Set what services the schedule should be connected to.")
services: Optional[List[AddScheduleService]] = None
"""
Set what services the schedule should be connected to.
"""
Python CreateDateSchedule DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /schedules/date HTTP/1.1
Host: api.bokamera.se
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Name":"String","Description":"String","Active":false,"NumberOfScheduleDays":0,"ScheduleDates":[{}],"Resources":[{"Id":0}],"Services":[{"Id":0}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Id":0,"Name":"String","Description":"String","Active":false,"IsResourceSpecific":false,"ScheduleDates":[{"Id":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Resources":[{"Id":0,"Name":"String"}],"Services":[{"Id":0,"Name":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}