| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IncludeProducts | query | bool | No | When true, the associated products are also returned. Default is false. |
| 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 |
|---|---|---|---|---|
| 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 |
| 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 |
| Name | Value |
|---|---|
| Draft | 1 |
| Approved | 2 |
| PreOrder | 3 |
| Open | 4 |
| Closed | 5 |
| Batching | 6 |
| Sellout | 7 |
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/QueryArtUnions HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
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/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"}}}