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
AvaiableTimesGroupedQuery 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 resourcetypes and resources
InsideSearchIntervalqueryboolNoBoth start and time time should be inside test interval. Default is false which means only start time needs to be inside.
ResponseStatusqueryResponseStatusNo
AvailableTimesResourceTypeResource Parameters:
NameParameterData TypeRequiredDescription
ResourceTypeIdformintNoThe resourcetype id
ResourceIdformintNoThe resource id
AvailableTimesGroupedDatesResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ServiceIdformintNo
TimesFreeTextSingleformstringNo
TimesFreeTextMultipleformstringNo
ItemsformList<AvailableTimesGroupedDates>No
AvailableTimesGroupedDates Parameters:
NameParameterData TypeRequiredDescription
GroupformDateTimeNo
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 .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: testapi.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>