Rsl.Lotteries

<back to all web services

GetArtUnionsCache

Get cached art unions and associated products

GetArtUnionsCache Parameters:
NameParameterData TypeRequiredDescription
ShowOpenArtunionsqueryboolNo
ShowPreOrderArtunionsqueryboolNo
ShowClosedArtunionsqueryboolNo
RecentClosedArtunionDrawsqueryint?No
ShowBatchingArtunionsqueryboolNo
ShowApprovedArtunionsqueryboolNo
ShowSelloutArtunionsqueryboolNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
ArtUnion Parameters:
NameParameterData TypeRequiredDescription
ArtUnionIdformstringNo
GameTypeformstringNo
ProjectGroupformstringNo
EligibilityCriteriaformstringNo
IsWebOpenformboolNo
IsVipDrawformboolNo
IsVisibleOnWebformboolNo
ProductsformList<Product>No
StatusformArtUnionStatus?No
NameformstringNo
BaseDenominationformintNo
TotalTicketsformintNo
TotalPrizeValueformint?No
DisclosureStatementformstringNo
TermsAndConditionsformstringNo
OpeningDateformDateTime?No
ClosingDateformDateTime?No
DrawDateformDateTime?No
Product Parameters:
NameParameterData TypeRequiredDescription
ProductIdformstringNoThe product variant record id
DescriptionformstringNo
NameformstringNo
Priceformdecimal?No
ProductQuantityformint?No
TicketQuantityformdecimal?No
BonusTicketsformint?No
GoldBullionformint?No
IsPopularformboolNo
ArtUnionStatus Enum:
NameValue
Draft1
Approved2
PreOrder3
Open4
Closed5
Batching6
Sellout7
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.

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

{
	showOpenArtunions: False,
	showPreOrderArtunions: False,
	showClosedArtunions: False,
	recentClosedArtunionDraws: 0,
	showBatchingArtunions: False,
	showApprovedArtunions: False,
	showSelloutArtunions: 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
		}
	}
}