Rsl.Lotteries

CustomerOrderSummary

Returns the customer brief orders Summary

The following routes are available for this service:
GET	/customers/{CustomerId}/ordersummary

**CustomerOrderSummary** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	path	string	Yes	The customer identifier
FromCreatedDate	query	DateTime?	No
ToCreatedDate	query	DateTime?	No

**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

**OrderSummary** Parameters:
Name	Parameter	Data Type	Required	Description
DrawId	form	string	No
TicketNumbers	form	string	No
OrderDate	form	DateTime?	No
OrderTotal	form	decimal	No
NumberOfTickets	form	int	No
ReferenceNumber	form	string	No	The order number
Items	form	List<OrderLineItem>	No
GiftRecipient	form	Contact	No	The order gift recipient
IsGift	form	bool	No
OrderStatus	form	OrderStatus?	No

**OrderLineItem** Parameters:
Name	Parameter	Data Type	Required
ArtUnion	form	string	No
ProductId	form	string	No
LineItemId	form	string	No
InventTransId	form	string	No
ProductName	form	string	No
ProductTicketCount	form	int?	No
Quantity	form	int	No
SubTotal	form	decimal	No
TicketNumbers	form	string	No
DrawDate	form	DateTime?	No
GameType	form	string	No
ArtUnionDictionary	form	Dictionary<string, string>	No
ArtUnionStatus	form	ArtUnionStatus?	No
LineItemStatus	form	OrderLineItemStatus?	No
IsRefunded	form	bool?	No
ArtUnionId	form	string	No
IsVIPDraw	form	bool	No

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

**OrderLineItemStatus** Enum:
Name	Value
Open	1
Closed	2
PreOrder	3

**Contact** Parameters:
Name	Parameter	Data Type	Required	Description
ContactId	form	string	No
Title	form	PersonTitle?	No	Person title Allowable Values Mr Mrs Miss Ms Dr
FirstName	form	string	No
LastName	form	string	No
DateOfBirth	form	DateTime?	No
HomePhone	form	string	No
MobilePhone	form	string	No
Email	form	string	No
Address	form	Address	No

**PersonTitle** Enum:
Mr
Mrs
Miss
Ms
Dr

**Address** Parameters:
Name	Parameter	Data Type	Required
Street	form	string	No
City	form	string	No
ZipCode	form	string	No
State	form	string	No
CountryRegionId	form	string	No
DPID	form	int	No
Suburb	form	string	No

**OrderStatus** Enum:
Name	Value
Unknown	0
Open	1
Invoiced	4
Cancelled	5
Pending	6

**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.

GET /customers/{CustomerId}/ordersummary 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: 
	[
		{
			drawId: String,
			ticketNumbers: String,
			orderDate: 0001-01-01,
			orderTotal: 0,
			numberOfTickets: 0,
			referenceNumber: String,
			items: 
			[
				{
					artUnion: String,
					productId: String,
					lineItemId: String,
					inventTransId: String,
					productName: String,
					productTicketCount: 0,
					quantity: 0,
					subTotal: 0,
					ticketNumbers: String,
					drawDate: 0001-01-01,
					gameType: String,
					artUnionDictionary: 
					{
						String: String
					},
					artUnionStatus: 0,
					lineItemStatus: 0,
					isRefunded: False,
					artUnionId: String,
					isVIPDraw: False
				}
			],
			giftRecipient: 
			{
				contactId: String,
				title: Mr,
				firstName: String,
				lastName: String,
				dateOfBirth: 0001-01-01,
				homePhone: String,
				mobilePhone: String,
				email: String,
				address: 
				{
					street: String,
					city: String,
					zipCode: String,
					state: String,
					countryRegionId: String,
					dpid: 0,
					suburb: String
				}
			},
			isGift: True,
			orderStatus: Unknown
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}

Rsl.Lotteries

CustomerOrderSummary

Returns the customer brief orders Summary

Allowable Values

HTTP + JSV