Rsl.Lotteries

<back to all web services

QueryByProjectGroup

Get all ArtUnions by project group type. This service will only retrieve products that contain associated product variants.

The following routes are available for this service:
GET/artunions/projectgroup
QueryByProjectGroup Parameters:
NameParameterData TypeRequiredDescription
TypequerystringNoProject group type.
IncludeProductsqueryboolNoWhen true, the associated products are also returned. Default is false.
ProjectStatusTypequerystringNo
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 .csv suffix or ?format=csv

HTTP + CSV

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

GET /artunions/projectgroup HTTP/1.1 
Host: azs-stg-lotteries-web.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","closingDate":"0001-01-01T00:00:00.0000000","drawDate":"0001-01-01T00:00:00.0000000"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}