Test

<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
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
CouponIdformstringNo
DiscountformCouponYes
NotesformstringNo
Cancelledformbool?No
PermanentAddressIdformlong?No
PermanentAddressformAddressNo
PostalAddressIdformlong?No
PostalAddressformAddressNo
AuditBase Parameters:
NameParameterData TypeRequiredDescription
CreatedDateformDateTimeNo
CreatedByformstringYes
ModifiedDateformDateTimeNo
ModifiedByformstringYes
DeletedDateformDateTime?No
DeletedByformstringNo
RoomType Enum:
Single
Double
Queen
Twin
Suite
Coupon Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
DescriptionformstringYes
DiscountformintNo
ExpiryDateformDateTimeNo
Address Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AddressTextformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<Poco>Yes
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
Poco Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes

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

HTTP + JSON

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

GET /bookings HTTP/1.1 
Host: test.servicestack.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"name":"String","roomType":"Single","roomNumber":0,"bookingStartDate":"\/Date(-62135596800000-0000)\/","bookingEndDate":"\/Date(-62135596800000-0000)\/","cost":0,"couponId":"String","discount":{"id":"String","description":"String","discount":0,"expiryDate":"\/Date(-62135596800000-0000)\/"},"notes":"String","cancelled":false,"permanentAddressId":0,"permanentAddress":{"id":0,"addressText":"String"},"postalAddressId":0,"postalAddress":{"id":0,"addressText":"String"},"createdDate":"\/Date(-62135596800000-0000)\/","createdBy":"String","modifiedDate":"\/Date(-62135596800000-0000)\/","modifiedBy":"String","deletedDate":"\/Date(-62135596800000-0000)\/","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"}}}