MyApp

<back to all web services

QueryBookings

bookings

Find Bookings

The following routes are available for this service:
GET/bookings
GET/bookings/{Id}
QueryBookings Parameters:
NameParameterData TypeRequiredDescription
Idpathint?No
Skipqueryint?No
Takequeryint?No
OrderByquerystringNo
OrderByDescquerystringNo
IncludequerystringNo
FieldsquerystringNo
MetaqueryDictionary<string, string>No
QueryDb<T> Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Booking Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
RoomTypeformRoomTypeNo
RoomNumberformintNo
BookingStartDateformDateTimeNo
BookingEndDateformDateTime?No
CostformdecimalNo
NotesformstringNo
Cancelledformbool?No
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo
RoomType Enum:
Single
Double
Queen
Twin
Suite
QueryResponse<Todo> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Todo>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Todo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
TextformstringYes
IsFinishedformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookings HTTP/1.1 
Host: vue-vite-api.jamstacks.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			name: String,
			roomType: Single,
			roomNumber: 0,
			bookingStartDate: 0001-01-01,
			bookingEndDate: 0001-01-01,
			cost: 0,
			notes: String,
			cancelled: False,
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			deletedBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}