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 Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class TestDateSchedule : ICompany, IInterval, 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 dates for the schedule. This is the actual timeslots.
    */
    // @ApiMember(Description="The dates for the schedule. This is the actual timeslots.", IsRequired=true)
    public var scheduleDates:[AddDateScheduleDate] = []

    /**
    * From what datetime to show available times
    */
    // @ApiMember(DataType="dateTime", Description="From what datetime to show available times", IsRequired=true, ParameterType="query")
    public var from:Date

    /**
    * To what datetime to show available times
    */
    // @ApiMember(DataType="dateTime", Description="To what datetime to show available times", IsRequired=true, ParameterType="query")
    public var to:Date

    /**
    * The Service Duration
    */
    // @ApiMember(Description="The Service Duration")
    public var serviceId:Int?

    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 AvailableTimesResponse : Codable
{
    public var companyId:String
    public var serviceId:Int
    public var timesFreeTextSingle:String
    public var timesFreeTextMultiple:String
    public var times:[AvailableTimesSum] = []

    required public init(){}
}

public class AvailableTimesSum : IAvailableTime, Codable
{
    public var from:Date
    public var to:Date
    public var free:Int
    public var freeSpots:Int
    public var exceptionTexts:[ExceptionText] = []

    required public init(){}
}

public class ExceptionText : Codable
{
    public var reason:String
    public var reasonPublic:String

    required public init(){}
}


Swift TestDateSchedule 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

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

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

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