BokaMera.API.Host

CollidingBookingQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/timeexceptions/collidingevents	Searches for collisions with existing bookings of the resource	Searches for existing bookings and investigates if a proposed time exception would collide with them, if so, the bookings should be unbooked to be able to create the time exception. A time exception must be either recurring (DaysOfWeek, ExceptionFromTime, ExceptionToTime is set) or non recurring (From and To are set).

**CollidingBookingQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
ResourceIds	query	int[]	Yes	Resource ids of the resource that should be matched against booked events
From	query	DateTime	No	Time exception starting date
To	query	DateTime	No	Time exception ending date
FromTime	query	TimeSpan	No	This value indicates the time of day when the time exception begins. Example: 10:00. If Recurring this will be the start time for each recurring day.
ToTime	query	TimeSpan	No	This value indicates the time of day when the time exception ends. Example: 12:00. If Recurring this will be the endtime for each recurring day.
DaysOfWeek	query	int[]	Yes	A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday
IncludeServiceInformation	query	boolean	No	If you want to include the service information for the booking
IncludeCustomerInformation	query	boolean	No	If you want to include the customer information for the booking

**CollidingBookingQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceIds	form	int[]	Yes	Resource id of the resource that owns this exception
Bookings	form	List<BookingIntervalResponse>	Yes	A list of bookings that would collide with the time exception
ResponseStatus	form	ResponseStatus	Yes

**BookingIntervalResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CompanyId	form	Guid	No
From	form	DateTime	No
To	form	DateTime	No
Status	form	BookingStatusEnum	No
StatusId	form	int	No
StatusName	form	string	Yes
Customer	form	BookedCustomer	Yes
Service	form	ServiceInfoResponse	Yes
CreatedDate	form	DateTime	No

**BookingStatusEnum** Enum:
Name	Value
Booked	1
Unbooked	2
Reserved	3
Canceled	4
AwaitingPayment	5
AwaitingPaymentNoTimeLimit	6
Payed	7
AwaitingPaymentRequestFromAdmin	8
AwaitingPaymentFromProvider	9
Invoiced	10

**BookedCustomer** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
Phone	form	string	Yes
FacebookUserName	form	string	Yes
ImageUrl	form	string	Yes
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**ServiceInfoResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	Yes
Description	form	string	Yes
ImageUrl	form	Uri	Yes
LengthInMinutes	form	int?	No
MaxNumberOfSpotsPerBooking	form	int	No
MinNumberOfSpotsPerBooking	form	int	No
GroupBooking	form	GroupBookingSettings	Yes
MultipleResource	form	MultipleResourceSettings	Yes
IsGroupBooking	form	bool	No
IsPaymentEnabled	form	bool	No

**GroupBookingSettings** Parameters:
Name	Parameter	Data Type	Required
Active	form	bool	No
Min	form	int	No
Max	form	int	No

**MultipleResourceSettings** Parameters:
Name	Parameter	Data Type	Required
Active	form	bool	No
Min	form	int	No
Max	form	int	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 /timeexceptions/collidingevents HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CollidingBookingQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Bookings>
    <BookingIntervalResponse>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Customer>
        <CorporateIdentityNumber>String</CorporateIdentityNumber>
        <Email>String</Email>
        <FacebookUserName>String</FacebookUserName>
        <Firstname>String</Firstname>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <ImageUrl>String</ImageUrl>
        <InvoiceAddress1>String</InvoiceAddress1>
        <InvoiceAddress2>String</InvoiceAddress2>
        <InvoiceCity>String</InvoiceCity>
        <InvoiceCountryCode>String</InvoiceCountryCode>
        <InvoicePostalCode>String</InvoicePostalCode>
        <Lastname>String</Lastname>
        <Phone>String</Phone>
      </Customer>
      <From>0001-01-01T00:00:00</From>
      <Id>0</Id>
      <Service>
        <Description>String</Description>
        <GroupBooking>
          <Active>false</Active>
          <Max>0</Max>
          <Min>0</Min>
        </GroupBooking>
        <Id>0</Id>
        <ImageUrl i:nil="true" />
        <IsGroupBooking>false</IsGroupBooking>
        <IsPaymentEnabled>false</IsPaymentEnabled>
        <LengthInMinutes>0</LengthInMinutes>
        <MaxNumberOfSpotsPerBooking>0</MaxNumberOfSpotsPerBooking>
        <MinNumberOfSpotsPerBooking>0</MinNumberOfSpotsPerBooking>
        <MultipleResource>
          <Active>false</Active>
          <Max>0</Max>
          <Min>0</Min>
        </MultipleResource>
        <Name>String</Name>
      </Service>
      <Status>Booked</Status>
      <StatusId>0</StatusId>
      <StatusName>String</StatusName>
      <To>0001-01-01T00:00:00</To>
    </BookingIntervalResponse>
  </Bookings>
  <ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ResourceIds>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <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>
</CollidingBookingQueryResponse>