BokaMera.API.Host

<back to all web services

AvailableTimesQuery

The following routes are available for this service:
GET/services/{ServiceId}/availabletimesGet availabletimes for the serviceGet availabletimes for the service and it's connected schedules
AvailableTimesQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoCompany to show services for
ServiceIdpathintYesService id
FromquerydateTimeYesFrom what datetime to show available times
ToquerydateTimeYesTo what datetime to show available times
ResourcesqueryList<AvailableTimesResourceTypeResource>NoHere 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
NumberOfResourcesqueryintNoHere you select number of resources to book (in each resourcetype). Default is 1.
ShowPerResourcequeryboolNoIf you want to include the connected resource types and resources
InsideSearchIntervalqueryboolNoBoth start and time time should be inside test interval. Default is false which means only start time needs to be inside.
DurationqueryboolNoThe duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
ResponseStatusqueryResponseStatusNo
AvailableTimesResourceTypeResource Parameters:
NameParameterData TypeRequiredDescription
ResourceTypeIdformintNoThe resourcetype id
ResourceIdformintNoThe resource id
AvailableTimesResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ServiceIdformintNo
TimesFreeTextSingleformstringNo
TimesFreeTextMultipleformstringNo
TimesformList<AvailableTimesSum>No
AvailableTimesSum Parameters:
NameParameterData TypeRequiredDescription
FromformDateTimeNo
ToformDateTimeNo
FreeformintNo
FreeSpotsformintNo
ExceptionTextsformIEnumerable<ExceptionText>No
ExceptionText Parameters:
NameParameterData TypeRequiredDescription
ReasonformstringNo
ReasonPublicformstringNo

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 /services/{ServiceId}/availabletimes HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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