Rsl.Lotteries

<back to all web services

QuerySubscriptionPlan

Get all subscription plans.

The following routes are available for this service:
GET/subscriptions/plans
QuerySubscriptionPlan Parameters:
NameParameterData TypeRequiredDescription
IncludeActivequerybool?No
IncludeAvailableForSelectionquerybool?No
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
SubscriptionPlan Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdformstringNo
GameTypeformstringNo
ActiveformboolNo
AvailableForSelectionformboolNo
DescriptionformstringNo
CurrentLineItemformSubscriptionLineItemNo
GENValueformstringNo
GTValueformstringNo
CountryNameformstringNo
DefaultTBformstringNo
GenformExtendedSubscriptionDataGenGTNo
GTformExtendedSubscriptionDataGenGTNo
SubscriptionLineItem Parameters:
NameParameterData TypeRequiredDescription
EventIdformintNo
ProductDescriptionformstringNo
ProductIdformstringNo
ArtUnionIdformstringNo
ArtUnionStatusformArtUnionStatus?No
SalesQuantityformdecimalNo
StartingDateformDateTimeNo
PriceformdecimalNo
ArtUnionStatus Enum:
NameValue
Draft1
Approved2
PreOrder3
Open4
Closed5
Batching6
Sellout7
ExtendedSubscriptionDataGenGT Parameters:
NameParameterData TypeRequiredDescription
CoreTicketsformintNo
BonusTicketsformintNo
TotalTicketsformintNo
BookBonusformintNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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 /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
		}
	}
}