BokaMera.API.Host

<back to all web services

CreateDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/schedules/dateAdd new date scheduleAdd new date schedule to the company for the currently logged in user, only administrators are allowed to add schedules.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateDateSchedule : ICompany, Codable
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public var companyId:String?

    /**
    * The schedule name
    */
    // @ApiMember(Description="The schedule name")
    public var name:String

    /**
    * The schedule description
    */
    // @ApiMember(Description="The schedule description")
    public var Description:String

    /**
    * If schedule is active or not
    */
    // @ApiMember(Description="If schedule is active or not")
    public var active:Bool

    /**
    * The number of days the schedule is valid from todays date
    */
    // @ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)
    public var numberOfScheduleDays:Int

    /**
    * The dates for the schedule. This is the actual timeslots.
    */
    // @ApiMember(Description="The dates for the schedule. This is the actual timeslots.")
    public var scheduleDates:[AddDateScheduleDate] = []

    /**
    * If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
    */
    // @ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")
    public var resources:[AddScheduleResource] = []

    /**
    * Set what services the schedule should be connected to.
    */
    // @ApiMember(Description="Set what services the schedule should be connected to.")
    public var services:[AddScheduleService] = []

    required public init(){}
}

public class AddDateScheduleDate : Codable
{
    /**
    * The from date for the timeslot
    */
    // @ApiMember(Description="The from date for the timeslot", IsRequired=true)
    public var from:Date

    /**
    * The to date for the timeslot
    */
    // @ApiMember(Description="The to date for the timeslot", IsRequired=true)
    public var to:Date

    required public init(){}
}

public class AddScheduleResource : Codable
{
    /**
    * The resource id
    */
    // @ApiMember(Description="The resource id", IsRequired=true)
    public var id:Int

    required public init(){}
}

public class AddScheduleService : Codable
{
    /**
    * The service id
    */
    // @ApiMember(Description="The service id", IsRequired=true)
    public var id:Int

    required public init(){}
}

public class DateScheduleQueryResponse : Codable
{
    /**
    * The schedule id
    */
    // @ApiMember(Description="The schedule id")
    public var id:Int

    /**
    * Name of the schedule
    */
    // @ApiMember(Description="Name of the schedule")
    public var name:String

    /**
    * Description of the schedule
    */
    // @ApiMember(Description="Description of the schedule")
    public var Description:String

    /**
    * If the schedule is active or not
    */
    // @ApiMember(Description="If the schedule is active or not")
    public var active:Bool

    /**
    * If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
    */
    // @ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)
    public var isResourceSpecific:Bool?

    /**
    * Schedule dates
    */
    // @ApiMember(Description="Schedule dates")
    public var scheduleDates:[DateScheduleDateResponse] = []

    /**
    * The resources that is connected to the schedule
    */
    // @ApiMember(Description="The resources that is connected to the schedule")
    public var resources:[ScheduleResources] = []

    /**
    * The services that is connected to the schedule
    */
    // @ApiMember(Description="The services that is connected to the schedule")
    public var services:[ScheduleServices] = []

    /**
    * The timestamp when the schedule was updated
    */
    // @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
    public var updatedDate:Date

    /**
    * The timestamp when the schedule was created
    */
    // @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
    public var createdDate:Date

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DateScheduleDateResponse : Codable
{
    public var id:Int
    public var from:Date
    public var to:Date
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ScheduleResources : Codable
{
    public var id:Int
    /**
    * Name of the resource
    */
    // @ApiMember(Description="Name of the resource")
    public var name:String

    /**
    * The image url of the resource
    */
    // @ApiMember(Description="The image url of the resource")
    public var imageUrl:Uri

    required public init(){}
}

public class ScheduleServices : Codable
{
    public var id:Int
    /**
    * Name of the service
    */
    // @ApiMember(Description="Name of the service")
    public var name:String

    /**
    * The image url of the service
    */
    // @ApiMember(Description="The image url of the service")
    public var imageUrl:Uri

    required public init(){}
}


Swift CreateDateSchedule 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.

POST /schedules/date HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateDateSchedule 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>
  <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>
</CreateDateSchedule>
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>