| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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). |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class BookedCustomer
{
public virtual Guid Id { get; set; }
public virtual string Firstname { get; set; }
public virtual string Lastname { get; set; }
public virtual string Email { get; set; }
public virtual string Phone { get; set; }
public virtual string FacebookUserName { get; set; }
public virtual string ImageUrl { get; set; }
public virtual string CorporateIdentityNumber { get; set; }
public virtual string InvoiceAddress1 { get; set; }
public virtual string InvoiceAddress2 { get; set; }
public virtual string InvoiceCity { get; set; }
public virtual string InvoicePostalCode { get; set; }
public virtual string InvoiceCountryCode { get; set; }
}
public partial class BookingIntervalResponse
{
public virtual int Id { get; set; }
public virtual Guid CompanyId { get; set; }
public virtual DateTime From { get; set; }
public virtual DateTime To { get; set; }
public virtual BookingStatusEnum Status { get; set; }
public virtual int StatusId { get; set; }
public virtual string StatusName { get; set; }
public virtual BookedCustomer Customer { get; set; }
public virtual ServiceInfoResponse Service { get; set; }
public virtual DateTime CreatedDate { get; set; }
}
[ApiResponse(Description="The request parameters was not valid", StatusCode=400)]
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)]
[ValidateRequest("IsAuthenticated")]
public partial class CollidingBookingQuery
{
public CollidingBookingQuery()
{
ResourceIds = new int[]{};
DaysOfWeek = new int[]{};
}
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///Resource ids of the resource that should be matched against booked events
///</summary>
[ApiMember(Description="Resource ids of the resource that should be matched against booked events")]
public virtual int[] ResourceIds { get; set; }
///<summary>
///Time exception starting date
///</summary>
[ApiMember(Description="Time exception starting date")]
public virtual DateTime From { get; set; }
///<summary>
///Time exception ending date
///</summary>
[ApiMember(Description="Time exception ending date")]
public virtual DateTime To { get; set; }
///<summary>
///This value indicates the time of day when the time exception begins. Example: 10:00. If Recurring this will be the startime for each recurring day.
///</summary>
[ApiMember(Description="This value indicates the time of day when the time exception begins. Example: 10:00. If Recurring this will be the startime for each recurring day.")]
public virtual TimeSpan FromTime { get; set; }
///<summary>
///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.
///</summary>
[ApiMember(Description="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.")]
public virtual TimeSpan ToTime { get; set; }
///<summary>
///A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday
///</summary>
[ApiMember(Description="A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday")]
public virtual int[] DaysOfWeek { get; set; }
///<summary>
///If you want to include the service information for the booking
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include the service information for the booking", ParameterType="query")]
public virtual bool IncludeServiceInformation { get; set; }
///<summary>
///If you want to include the customer information for the booking
///</summary>
[ApiMember(DataType="boolean", Description="If you want to include the customer information for the booking", ParameterType="query")]
public virtual bool IncludeCustomerInformation { get; set; }
}
public partial class CollidingBookingQueryResponse
{
public CollidingBookingQueryResponse()
{
ResourceIds = new int[]{};
Bookings = new List<BookingIntervalResponse>{};
}
///<summary>
///Resource id of the resource that owns this exception
///</summary>
[ApiMember(Description="Resource id of the resource that owns this exception")]
public virtual int[] ResourceIds { get; set; }
///<summary>
///A list of bookings that would collide with the time exception
///</summary>
[ApiMember(Description="A list of bookings that would collide with the time exception")]
public virtual List<BookingIntervalResponse> Bookings { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class GroupBookingSettings
{
public virtual bool Active { get; set; }
public virtual int Min { get; set; }
public virtual int Max { get; set; }
}
public partial class MultipleResourceSettings
{
public virtual bool Active { get; set; }
public virtual int Min { get; set; }
public virtual int Max { get; set; }
}
public partial class ServiceInfoResponse
{
public virtual int Id { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual Uri ImageUrl { get; set; }
public virtual int? LengthInMinutes { get; set; }
public virtual int MaxNumberOfSpotsPerBooking { get; set; }
public virtual GroupBookingSettings GroupBooking { get; set; }
public virtual MultipleResourceSettings MultipleResource { get; set; }
public virtual bool IsGroupBooking { get; set; }
public virtual bool IsPaymentEnabled { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Enums
{
public enum BookingStatusEnum
{
Booked = 1,
Unbooked = 2,
Reserved = 3,
Canceled = 4,
AwaitingPayment = 5,
AwaitingPaymentNoTimeLimit = 6,
Payed = 7,
AwaitingPaymentRequestFromAdmin = 8,
AwaitingPaymentFromProvider = 9,
Invoiced = 10,
}
}
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
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: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResourceIds":[0],"Bookings":[{"Id":0,"Status":"Booked","StatusId":0,"StatusName":"String","Customer":{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","FacebookUserName":"String","ImageUrl":"String","CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"String"},"Service":{"Id":0,"Name":"String","Description":"String","LengthInMinutes":0,"MaxNumberOfSpotsPerBooking":0,"GroupBooking":{"Active":false,"Min":0,"Max":0},"MultipleResource":{"Active":false,"Min":0,"Max":0},"IsGroupBooking":false,"IsPaymentEnabled":false}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}