GET api/events?id={productid}&page={page}&version={version}&fromdate={fromdate}&todate={todate}

The events API returns the list of individual performances available for sale.


Resource URL

Tests: https://sandbox.weplann.com/api/events?id={productid}&page={page}&version={version}&fromdate={fromdate}&todate={todate}
Production: https://developer.weplann.com/api/events?id={productid}&page={page}&version={version}&fromdate={fromdate}&todate={todate}

Request Parameters

Name Description Type Additional Information Mandatory
id The product id to filter the events on uniqueidentifier No
page The page to return integer Default is page 1 No
version Used to retrieve incremental updates. See Incremental Updates integer No
fromdate The start date to search from. datetime No
todate The end date to search to datetime No

Response Information

Name Description Type Additional Information
CurrentPage Currently returned page integer
PageSize Requested page size integer Always returned as 500
TotalCount The total number of matching events integer
TotalPages The total number of pages integer
HasPreviousPage Indicates if previous page exists boolean
HasNextPage Indicates if next page exists boolean
Values collection of events
 + Id unique identifier
 + ItemId The id of the item this event is for. unique identifier
 + EventOn The date and time of the event datetime This is the local time in the location.
 + AvailabilityCode Indicates the availability for this event. string valid values are available, removed, black-out, sold-out
 + Tickets container of tickets that can be sold
 + + Code The type of ticket being sold. string
 + + UnitPrice container of price type Price per item
 + + + CurrencyCode The base currency for this product. string
 + + + Value The price per item. decimal
 + + UnitUsdPrice The price of the item in USD Note: this field is calculated based on the current exchange rate.
 + + + CurrencyCode The base currency for this item. string
 + + + Value The USD price per item. decimal

Example Request (filtered by product id and date range)

GET https://developer.weplann.com/api/events?id=e7bdcdc3-5c63-4e2a-b0cc-2efa08ce58b2&fromdate=04-05-2016&todate=04-10-2016 

Example Result (XML)

  <PagedResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.weplann.com">
	<CurrentPage>1</CurrentPage>
	<PageSize>500</PageSize>
	<TotalCount>21</TotalCount>
	<TotalPages>1</TotalPages>
	<HasPreviousPage>false</HasPreviousPage>
	<HasNextPage>false</HasNextPage>
	<Values>
		<Event Id="b07e56ae-c2ce-4a66-b81b-fc08362426a6" ItemId="112025e9-e2f9-4b7e-9cdf-62ba24818dfa">
			<EventOn>2016-04-05T19:00:00Z</EventOn>
			<AvailabilityCode>available</AvailabilityCode>
			<Tickets>
				<Ticket Code="ticket">
					<UnitPrice CurrencyCode="USD">
						<Value>178.0000</Value>
					</UnitPrice>
					<UnitUsdPrice CurrencyCode="USD">
						<Value>178.0000</Value>
					</UnitUsdPrice>
				</Ticket>
			</Tickets>
		</Event>
		<Event Id="b7b129d3-b78e-45ab-8bef-cafa1473f2db" ItemId="a1f569a0-7ca2-446a-89bb-cae53a96eef9">
			<EventOn>2016-04-05T19:00:00Z</EventOn>
			<AvailabilityCode>available</AvailabilityCode>
			<Tickets>
				<Ticket Code="ticket">
					<UnitPrice CurrencyCode="USD">
						<Value>159.0000</Value>
					</UnitPrice>
					<UnitUsdPrice CurrencyCode="USD">
						<Value>159.0000</Value>
					</UnitUsdPrice>
				</Ticket>
			</Tickets>
		</Event>
		<Event Id="19f3e197-5100-4f13-9ec7-2495bd87f894" ItemId="e8d5b1e5-d6cd-4a2c-b336-e1d212af355d">
			<EventOn>2016-04-05T19:00:00Z</EventOn>
			<AvailabilityCode>available</AvailabilityCode>
			<Tickets>
				<Ticket Code="ticket">
					<UnitPrice CurrencyCode="USD">
						<Value>272.0000</Value>
					</UnitPrice>
					<UnitUsdPrice CurrencyCode="USD">
						<Value>272.0000</Value>
					</UnitUsdPrice>
				</Ticket>
			</Tickets>
		</Event>
  		**** MORE MATCHING EVENTS ****
	</Values>
</PagedResponse>

Example Result (JSON)

{
	"currentPage" : 1,
	"pageSize" : 500,
	"totalCount" : 21,
	"totalPages" : 1,
	"hasPreviousPage" : false,
	"hasNextPage" : false,
	"values" : [
		{
			"id" : "b07e56ae-c2ce-4a66-b81b-fc08362426a6",
			"itemId" : "112025e9-e2f9-4b7e-9cdf-62ba24818dfa",
			"eventOn" : "2016-04-05T19:00:00Z",
			"availabilityCode" : "available",
			"tickets" : [
				{
					"code" : "ticket",
					"unitPrice" : {
						"currencyCode" : "USD",
						"value" : 178.0000
					},
					"unitUsdPrice" : {
						"currencyCode" : "USD",
						"value" : 178.0000
					}
				}
			]
		},
		{
			"id" : "b7b129d3-b78e-45ab-8bef-cafa1473f2db",
			"itemId" : "a1f569a0-7ca2-446a-89bb-cae53a96eef9",
			"eventOn" : "2016-04-05T19:00:00Z",
			"availabilityCode" : "available",
			"tickets" : [
				{
					"code" : "ticket",
					"unitPrice" : {
						"currencyCode" : "USD",
						"value" : 159.0000
					},
					"unitUsdPrice" : {
						"currencyCode" : "USD",
						"value" : 159.0000
					}
				}
			]
		},
		{
			"id" : "19f3e197-5100-4f13-9ec7-2495bd87f894",
			"itemId" : "e8d5b1e5-d6cd-4a2c-b336-e1d212af355d",
			"eventOn" : "2016-04-05T19:00:00Z",
			"availabilityCode" : "available",
			"tickets" : [
				{
					"code" : "ticket",
					"unitPrice" : {
						"currencyCode" : "USD",
						"value" : 272.0000
					},
					"unitUsdPrice" : {
						"currencyCode" : "USD",
						"value" : 272.0000
					}
				}
			]
		},
		**** MORE MATCHING EVENTS ****
	]
}