| GET | /subscriptions/plans |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeActive | query | bool? | No | |
| IncludeAvailableForSelection | query | bool? | 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 |
|---|---|---|---|---|
| SubscriptionId | form | string | No | |
| GameType | form | string | No | |
| Active | form | bool | No | |
| AvailableForSelection | form | bool | No | |
| Description | form | string | No | |
| CurrentLineItem | form | SubscriptionLineItem | No | |
| GENValue | form | string | No | |
| GTValue | form | string | No | |
| CountryName | form | string | No | |
| DefaultTB | form | string | No | |
| Gen | form | ExtendedSubscriptionDataGenGT | No | |
| GT | form | ExtendedSubscriptionDataGenGT | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EventId | form | int | No | |
| ProductDescription | form | string | No | |
| ProductId | form | string | No | |
| ArtUnionId | form | string | No | |
| ArtUnionStatus | form | ArtUnionStatus? | No | |
| SalesQuantity | form | decimal | No | |
| StartingDate | form | DateTime | No | |
| Price | form | decimal | No |
| Name | Value |
|---|---|
| Draft | 1 |
| Approved | 2 |
| PreOrder | 3 |
| Open | 4 |
| Closed | 5 |
| Batching | 6 |
| Sellout | 7 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CoreTickets | form | int | No | |
| BonusTickets | form | int | No | |
| TotalTickets | form | int | No | |
| BookBonus | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | form | int | No | |
| Total | form | int | No | |
| Results | form | List<T> | No | |
| Meta | form | Dictionary<string, string> | No | |
| ResponseStatus | form | ResponseStatus | 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 /subscriptions/plans HTTP/1.1 Host: azs-stg-lotteries-web.azurewebsites.net Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
subscriptionId: String,
gameType: String,
active: False,
availableForSelection: False,
description: String,
currentLineItem:
{
eventId: 0,
productDescription: String,
productId: String,
artUnionId: String,
artUnionStatus: 0,
salesQuantity: 0,
startingDate: 0001-01-01,
price: 0
},
genValue: String,
gtValue: String,
countryName: String,
defaultTB: String,
gen:
{
coreTickets: 0,
bonusTickets: 0,
totalTickets: 0,
bookBonus: 0
},
gt:
{
coreTickets: 0,
bonusTickets: 0,
totalTickets: 0,
bookBonus: 0
}
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}