BokaMera.API.Host

<back to all web services

SyncToiCal

The following routes are available for this service:
GET/sync/icalsync/{companyid}/{token}Get iCals
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

        Public Partial Class SyncToiCal
            Implements ICompany
            Public Sub New()
                ResourceIds = New Integer(){}
            End Sub

            '''<Summary>
            '''Enter the company, if blank and you are an admin, your company id will be used
            '''</Summary>
            <ApiMember(Description:="Enter the company, if blank and you are an admin, your company id will be used", ParameterType:="path")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Query for specific Resources, default is all resources
            '''</Summary>
            <ApiMember(Description:="Query for specific Resources, default is all resources", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property ResourceIds As Integer()

            '''<Summary>
            '''ICalSync Token
            '''</Summary>
            <ApiMember(Description:="ICalSync Token", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Token As String

            '''<Summary>
            '''If you want to include the schedule time slots
            '''</Summary>
            <ApiMember(Description:="If you want to include the schedule time slots", ParameterType:="query")>
            Public Overridable Property IncludeSchedules As Boolean
        End Class
    End Namespace
End Namespace

VB.NET SyncToiCal DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /sync/icalsync/{companyid}/{token} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}