BokaMera.API.Host

<back to all web services

UpdateDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/schedules/date/{Id}Update date scheduleUpdate 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 UpdateDateSchedule(ICompany):
    # @ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
    id: int = 0
    """
    Id of the schedule to update
    """


    # @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: Optional[bool] = None
    """
    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 UpdateDateSchedule 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.

PUT /schedules/date/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateDateSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <Id>0</Id>
  <Name>String</Name>
  <NumberOfScheduleDays>0</NumberOfScheduleDays>
  <Resources>
    <AddScheduleResource>
      <Id>0</Id>
    </AddScheduleResource>
  </Resources>
  <ScheduleDates>
    <AddDateScheduleDate>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </AddDateScheduleDate>
  </ScheduleDates>
  <Services>
    <AddScheduleService>
      <Id>0</Id>
    </AddScheduleService>
  </Services>
</UpdateDateSchedule>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DateScheduleQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Description>String</Description>
  <Id>0</Id>
  <IsResourceSpecific>false</IsResourceSpecific>
  <Name>String</Name>
  <Resources>
    <ScheduleResources>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </ScheduleResources>
  </Resources>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ScheduleDates>
    <DateScheduleDateResponse>
      <From>0001-01-01T00:00:00</From>
      <Id>0</Id>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <To>0001-01-01T00:00:00</To>
    </DateScheduleDateResponse>
  </ScheduleDates>
  <Services>
    <ScheduleServices>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </ScheduleServices>
  </Services>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</DateScheduleQueryResponse>