POST v{version}/bookings

Gets paged result of bookings

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

query defition

BookingLimiter

Name	Description	Type	Additional information
BookingTypeIds	Filter using of type	Collection of integer	Required
PublishTypeIds	Filter using of type	Collection of integer	None.
RoomIds	Filter using of type	Collection of integer	None.
BookingId	Filter using equals	integer	None.
DateFrom	Filter using gt and eq	date	None.
ExternalId	Filter using equals	string	None.
TeacherName	Filter using contains	string	String length: inclusive between 1 and 20
Take		integer	Range: inclusive between 0 and 500
Skip		integer	Range: inclusive between 0 and 2147483647
Sort	Available fields StartDate, TeacherName, BookingTypeId, School	string	None.

Request Formats

application/json, text/json

Sample:

{
  "BookingTypeIds": [
    1,
    2
  ],
  "PublishTypeIds": [
    1,
    2
  ],
  "RoomIds": [
    1,
    2
  ],
  "BookingId": 1,
  "DateFrom": "2025-03-12T04:46:49.5001435+01:00",
  "ExternalId": "sample string 1",
  "TeacherName": "sample string 2",
  "Take": 3,
  "Skip": 4,
  "Sort": "sample string 5"
}

application/xml, text/xml

Sample:

<BookingLimiter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpeedadminApi.ViewModels">
  <BookingId>1</BookingId>
  <BookingTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </BookingTypeIds>
  <DateFrom>2025-03-12T04:46:49.5001435+01:00</DateFrom>
  <ExternalId>sample string 1</ExternalId>
  <PublishTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </PublishTypeIds>
  <RoomIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RoomIds>
  <Skip>4</Skip>
  <Sort>sample string 5</Sort>
  <Take>3</Take>
  <TeacherName>sample string 2</TeacherName>
</BookingLimiter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

paged result

IPagedResultOfBookingViewModel

Name	Type	Additional information
Results	Collection of BookingViewModel	None.
TotalResults	integer	None.
RequestResults	integer	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.