Rsl.Lotteries

QueryArtUnions

Get all lottery ArtUnions. This service will only retrieve products that contain associated product variants.

**QueryArtUnions** Parameters:
Name	Parameter	Data Type	Required	Description
IncludeProducts	query	bool	No	When true, the associated products are also returned. Default is false.

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
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

**ArtUnion** Parameters:
Name	Parameter	Data Type	Required
ArtUnionId	form	string	No
GameType	form	string	No
ProjectGroup	form	string	No
EligibilityCriteria	form	string	No
IsWebOpen	form	bool	No
IsVipDraw	form	bool	No
IsVisibleOnWeb	form	bool	No
Products	form	List<Product>	No
Status	form	ArtUnionStatus?	No
Name	form	string	No
BaseDenomination	form	int	No
TotalTickets	form	int	No
TotalPrizeValue	form	int?	No
DisclosureStatement	form	string	No
TermsAndConditions	form	string	No
OpeningDate	form	DateTime?	No
ClosingDate	form	DateTime?	No
DrawDate	form	DateTime?	No

**Product** Parameters:
Name	Parameter	Data Type	Required	Description
ProductId	form	string	No	The product variant record id
Description	form	string	No
Name	form	string	No
Price	form	decimal?	No
ProductQuantity	form	int?	No
TicketQuantity	form	decimal?	No
BonusTickets	form	int?	No
GoldBullion	form	int?	No
IsPopular	form	bool	No

**ArtUnionStatus** Enum:
Name	Value
Draft	1
Approved	2
PreOrder	3
Open	4
Closed	5
Batching	6
Sellout	7

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
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

HTTP + JSV

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

POST /jsv/reply/QueryArtUnions HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	includeProducts: False,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			artUnionId: String,
			gameType: String,
			projectGroup: String,
			eligibilityCriteria: String,
			isWebOpen: False,
			isVipDraw: False,
			isVisibleOnWeb: False,
			products: 
			[
				{
					productId: String,
					description: String,
					name: String,
					price: 0,
					productQuantity: 0,
					ticketQuantity: 0,
					bonusTickets: 0,
					goldBullion: 0,
					isPopular: False
				}
			],
			status: 0,
			name: String,
			baseDenomination: 0,
			totalTickets: 0,
			totalPrizeValue: 0,
			disclosureStatement: String,
			termsAndConditions: String,
			openingDate: 0001-01-01,
			closingDate: 0001-01-01,
			drawDate: 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
		}
	}
}