GET | /bookings | ||
---|---|---|---|
GET | /bookings/{Id} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | int? | No | |
Skip | query | int? | No | |
Take | query | int? | No | |
OrderBy | query | string | No | |
OrderByDesc | query | string | No | |
Include | query | string | No | |
Fields | query | string | No | |
Meta | query | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Name | form | string | Yes | |
RoomType | form | RoomType | No | |
RoomNumber | form | int | No | |
BookingStartDate | form | DateTime | No | |
BookingEndDate | form | DateTime? | No | |
Cost | form | decimal | No | |
Notes | form | string | No | |
Cancelled | form | bool? | No | |
CreatedDate | form | DateTime | No | |
CreatedBy | form | string | Yes | |
ModifiedDate | form | DateTime | No | |
ModifiedBy | form | string | Yes | |
DeletedDate | form | DateTime? | No | |
DeletedBy | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CreatedDate | form | DateTime | No | |
CreatedBy | form | string | Yes | |
ModifiedDate | form | DateTime | No | |
ModifiedBy | form | string | Yes | |
DeletedDate | form | DateTime? | No | |
DeletedBy | form | string | No |
Single | |
Double | |
Queen | |
Twin | |
Suite |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<Todo> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Text | form | string | Yes | |
IsFinished | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } } }