BokaMera.API.Host

<back to all web services

AvaiableTimesGroupedQuery

The following routes are available for this service:
GET/services/{ServiceId}/availabletimes/groupedGet availabletimes for the serviceGet availabletimes for the service and it's connected schedules
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ExceptionText() = 
        member val Reason:String = null with get,set
        member val ReasonPublic:String = null with get,set

    [<AllowNullLiteral>]
    type AvailableTimesSum() = 
        member val From:DateTime = new DateTime() with get,set
        member val To:DateTime = new DateTime() with get,set
        member val Free:Int32 = new Int32() with get,set
        member val FreeSpots:Int32 = new Int32() with get,set
        member val ExceptionTexts:IEnumerable<ExceptionText> = null with get,set

    [<AllowNullLiteral>]
    type AvailableTimesGroupedDates() = 
        member val Group:DateTime = new DateTime() with get,set
        member val Times:ResizeArray<AvailableTimesSum> = new ResizeArray<AvailableTimesSum>() with get,set

    [<AllowNullLiteral>]
    type AvailableTimesGroupedDatesResponse() = 
        member val CompanyId:Guid = new Guid() with get,set
        member val ServiceId:Int32 = new Int32() with get,set
        member val TimesFreeTextSingle:String = null with get,set
        member val TimesFreeTextMultiple:String = null with get,set
        member val Items:ResizeArray<AvailableTimesGroupedDates> = new ResizeArray<AvailableTimesGroupedDates>() with get,set

    [<AllowNullLiteral>]
    type AvailableTimesResourceTypeResource() = 
        ///<summary>
        ///The resourcetype id
        ///</summary>
        [<ApiMember(Description="The resourcetype id")>]
        member val ResourceTypeId:Int32 = new Int32() with get,set

        ///<summary>
        ///The resource id
        ///</summary>
        [<ApiMember(Description="The resource id")>]
        member val ResourceId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type AvaiableTimesGroupedQuery() = 
        ///<summary>
        ///Company to show services for
        ///</summary>
        [<ApiMember(Description="Company to show services for", ParameterType="query")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Service id
        ///</summary>
        [<ApiMember(Description="Service id", IsRequired=true, ParameterType="path")>]
        member val ServiceId:Int32 = new Int32() with get,set

        ///<summary>
        ///From what datetime to show available times
        ///</summary>
        [<ApiMember(DataType="dateTime", Description="From what datetime to show available times", IsRequired=true, ParameterType="query")>]
        member val From:DateTime = new DateTime() with get,set

        ///<summary>
        ///To what datetime to show available times
        ///</summary>
        [<ApiMember(DataType="dateTime", Description="To what datetime to show available times", IsRequired=true, ParameterType="query")>]
        member val To:DateTime = new DateTime() with get,set

        ///<summary>
        ///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
        ///</summary>
        [<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")>]
        member val Resources:ResizeArray<AvailableTimesResourceTypeResource> = new ResizeArray<AvailableTimesResourceTypeResource>() with get,set

        ///<summary>
        ///Here you select number of resources to book (in each resourcetype). Default is 1.
        ///</summary>
        [<ApiMember(Description="Here you select number of resources to book (in each resourcetype). Default is 1.", ParameterType="query")>]
        member val NumberOfResources:Int32 = new Int32() with get,set

        ///<summary>
        ///If you want to include the connected resourcetypes and resources
        ///</summary>
        [<ApiMember(Description="If you want to include the connected resourcetypes and resources", ParameterType="query")>]
        member val ShowPerResource:Boolean = new Boolean() with get,set

        ///<summary>
        ///Both start and time time should be inside test interval. Default is false which means only start time needs to be inside.
        ///</summary>
        [<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")>]
        member val InsideSearchInterval:Boolean = new Boolean() with get,set

        ///<summary>
        ///The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
        ///</summary>
        [<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")>]
        member val Duration:Nullable<Int32> = new Nullable<Int32>() with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

F# AvaiableTimesGroupedQuery 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.

GET /services/{ServiceId}/availabletimes/grouped HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AvailableTimesGroupedDatesResponse 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>
  <Items>
    <AvailableTimesGroupedDates>
      <Group>0001-01-01T00:00:00</Group>
      <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>
    </AvailableTimesGroupedDates>
  </Items>
  <ServiceId>0</ServiceId>
  <TimesFreeTextMultiple>String</TimesFreeTextMultiple>
  <TimesFreeTextSingle>String</TimesFreeTextSingle>
</AvailableTimesGroupedDatesResponse>