GET | /services/{ServiceId}/availabletimes | Get availabletimes for the service | Get availabletimes for the service and it's connected schedules |
---|
import Foundation
import ServiceStack
public class AvailableTimesQuery : IInterval, Codable
{
/**
* Company to show services for
*/
// @ApiMember(Description="Company to show services for", ParameterType="query")
public var companyId:String?
/**
* Service id
*/
// @ApiMember(Description="Service id", IsRequired=true, ParameterType="path")
public var serviceId:Int
/**
* 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
/**
* Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all
*/
// @ApiMember(Description="Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all", ParameterType="query")
public var resources:[AvailableTimesResourceTypeResource] = []
/**
* Here you select number of resources to book (in each resourcetype). Default is 1.
*/
// @ApiMember(Description="Here you select number of resources to book (in each resourcetype). Default is 1.", ParameterType="query")
public var numberOfResources:Int
/**
* If you want to include the connected resource types and resources
*/
// @ApiMember(Description="If you want to include the connected resource types and resources", ParameterType="query")
public var showPerResource:Bool
/**
* Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.
*/
// @ApiMember(DataType="bool", Description="Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.", ParameterType="query")
public var insideSearchInterval:Bool
/**
* The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
*/
// @ApiMember(DataType="bool", Description="The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration", ParameterType="query")
public var duration:Int?
public var responseStatus:ResponseStatus
required public init(){}
}
public class AvailableTimesResourceTypeResource : Codable
{
/**
* The resourcetype id
*/
// @ApiMember(Description="The resourcetype id")
public var resourceTypeId:Int
/**
* The resource id
*/
// @ApiMember(Description="The resource id")
public var resourceId:Int
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 AvailableTimesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /services/{ServiceId}/availabletimes HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AvailableTimesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <ServiceId>0</ServiceId> <Times> <AvailableTimesSum> <ExceptionTexts i:nil="true" /> <Free>0</Free> <FreeSpots>0</FreeSpots> <From>0001-01-01T00:00:00</From> <To>0001-01-01T00:00:00</To> </AvailableTimesSum> </Times> <TimesFreeTextMultiple>String</TimesFreeTextMultiple> <TimesFreeTextSingle>String</TimesFreeTextSingle> </AvailableTimesResponse>