| GET | /coupons |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | query | string | Yes |
| 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 | string | Yes | |
| Description | form | string | Yes | |
| Discount | form | int | No | |
| ExpiryDate | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<Booking> | Yes | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | 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 | |
| CouponId | form | string | No | |
| Discount | form | Coupon | Yes | |
| Notes | form | string | No | |
| Cancelled | form | bool? | No | |
| Employee | form | User | Yes |
| 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 |
|---|---|---|---|---|
| Id | form | string | Yes | |
| UserName | form | string | Yes | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| DisplayName | form | string | No | |
| ProfileUrl | form | string | 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 /coupons HTTP/1.1 Host: blazor-vue.web-templates.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
id: String,
description: String,
discount: 0,
expiryDate: 0001-01-01
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}