Viviot.Api

<back to all web services

GetReservationServiceTimeslotAvailability

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, MarketplaceAdmin, AvailabilityReader
The following routes are available for this service:
GET/service/{ServiceId}/availabilityGets available timeslots for a smartspace within a service on a given time period.
GetReservationServiceTimeslotAvailability Parameters:
NameParameterData TypeRequiredDescription
ServiceIdpathstringYesService ID (GUID)
ThingIdquerystringYesThing/smartspace ID (GUID)
StartquerystringYesStart date and time from when to collect available timeslots (UTC).
EndquerystringNoEnd date and time until when to collect available timeslots (UTC - 24h from start if not set).
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ReservationServiceTimeslotAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<TimeslotAvailabilityDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TimeslotAvailabilityDto Parameters:
NameParameterData TypeRequiredDescription
AvailableformboolNo
TimeslotDto Parameters:
NameParameterData TypeRequiredDescription
FromformDateTime?No
ToformDateTime?No

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 /service/{ServiceId}/availability HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReservationServiceTimeslotAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Service">
    <d2p1:TimeslotAvailabilityDto>
      <d2p1:From>0001-01-01T00:00:00</d2p1:From>
      <d2p1:To>0001-01-01T00:00:00</d2p1:To>
      <d2p1:Available>false</d2p1:Available>
    </d2p1:TimeslotAvailabilityDto>
  </Data>
</ReservationServiceTimeslotAvailabilityResponse>