BokaMera.API.Host

<back to all web services

NextFreeTimeQuery

The following routes are available for this service:
GET/services/{ServiceId}/nextfreetimeGet the next available time for the serviceGet the next available time for the service
NextFreeTimeQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoCompany to show available time for
ServiceIdpathintYesService id
FromquerydateTimeYesFrom what datetime to search available times
ToquerydateTimeYesTo what datetime to show available times. Optional, if no datetime is set it will search one year
ResourcesqueryList<AvailableTimesResourceTypeResource>NoHere you can select one of the resource in each resource type 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 resource type). Default is 1.
DurationqueryboolNoThe duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration
ShowPerResourcequeryboolNoIf you want to include the connected resource types and resources
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

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