BokaMera.API.Host

<back to all web services

RecurringScheduleIntervalsQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/schedules/recurring/intervalsGet the schedule intervalsGet the schedule intervals. Note: This must not be the same as the available times.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class RecurringScheduleIntervalsQuery
            Implements ICompany
            Implements IInterval
            Public Sub New()
                ResourceIds = New Integer(){}
            End Sub

            '''<Summary>
            '''Company to show services for
            '''</Summary>
            <ApiMember(Description:="Company to show services for", ParameterType:="query")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''From what datetime to show times
            '''</Summary>
            <ApiMember(DataType:="dateTime", Description:="From what datetime to show times", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property From As Date

            '''<Summary>
            '''To what datetime to show times
            '''</Summary>
            <ApiMember(DataType:="dateTime", Description:="To what datetime to show times", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property To As Date

            '''<Summary>
            '''Here you can select one of the resource, if none is selected it will show available times for all
            '''</Summary>
            <ApiMember(Description:="Here you can select one of the resource, if none is selected it will show available times for all", ParameterType:="query")>
            Public Overridable Property ResourceIds As Integer()

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class ScheduleIntervalsQueryResponse
            Public Overridable Property From As Date
            Public Overridable Property To As Date
            Public Overridable Property Duration As TimeSpan
        End Class
    End Namespace
End Namespace

VB.NET RecurringScheduleIntervalsQuery 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 /schedules/recurring/intervals HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScheduleIntervalsQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Duration>PT0S</Duration>
  <From>0001-01-01T00:00:00</From>
  <To>0001-01-01T00:00:00</To>
</ScheduleIntervalsQueryResponse>