GET api/products?page={page}&version={version}&query={query}

Returns a collection of the products on WePlann.

Resource URL

Tests: https://sandbox.weplann.com/api/products?page={page}&version={version}&query={query}
Production: https://developer.weplann.com/api/products?page={page}&version={version}&query={query}

Request Parameters

Name Description Type Additional Information Mandatory
page The page to return integer Default is page 1 No
version Used to retrieve incremental updates. See Incremental Updates integer No
query Search string to limit results string No

Response Information

Name Description Type Additional Information
CurrentPage Currently returned page integer
PageSize Requested page size integer Always returned as 100
TotalCount The total number of matching products 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 product
 + Id unique identifier
 + ProductTypeCode The type of product. (scheduled, timeless, dateless) string
 + CityCode City to which this product is assigned. string Note: this value can be used in query to restrict results
 + ImmediateBooking Indicates if order is placed whether the product is immediately booked with supplier. boolean
 + HasAvailability Calculated field indicating if there are events available. boolean

Example Request

GET https://developer.weplann.com/api/products?page=2 

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>2</CurrentPage>
	<PageSize>100</PageSize>
	<TotalCount>431</TotalCount>
	<TotalPages>5</TotalPages>
	<HasPreviousPage>true</HasPreviousPage>
	<HasNextPage>true</HasNextPage>
	<Values>
		<Product Id="a568cd3b-e3c7-497b-a7ec-3e430b449a36">
			<ProductTypeCode>scheduled</ProductTypeCode>
			<Name>Las Vegas - Grand Celebration</Name>
			<CityCode>LAS</CityCode>
			<ImmediateBooking>true</ImmediateBooking>
			<HasAvailability>false</HasAvailability>
		</Product>
		<Product Id="5fa676ce-440c-4429-87df-2b00fedc47f1">
			<ProductTypeCode>scheduled</ProductTypeCode>
			<Name>Las Vegas - Grand Celebration with Strip</Name>
			<CityCode>LAS</CityCode>
			<ImmediateBooking>true</ImmediateBooking>
			<HasAvailability>true</HasAvailability>
		</Product>
		<Product Id="38bd0215-3b36-47f3-8384-dd275f044a2a">
			<ProductTypeCode>scheduled</ProductTypeCode>
			<Name>Las Vegas - Grand Voyager</Name>
			<CityCode>LAS</CityCode>
			<ImmediateBooking>true</ImmediateBooking>
			<HasAvailability>true</HasAvailability>
		</Product>
                **** MORE MATCHING PRODUCTS ****
	</Values>
</PagedResponse>

Example Result (JSON)

{
	"currentPage" : 2,
	"pageSize" : 100,
	"totalCount" : 431,
	"totalPages" : 5,
	"hasPreviousPage" : true,
	"hasNextPage" : true,
	"values" : [
		{
			"id" : "a568cd3b-e3c7-497b-a7ec-3e430b449a36",
			"productTypeCode" : "scheduled",
			"name" : "Las Vegas - Grand Celebration",
			"cityCode" : "LAS",
			"immediateBooking" : true,
			"hasAvailability" : false
		},
		{
			"id" : "5fa676ce-440c-4429-87df-2b00fedc47f1",
			"productTypeCode" : "scheduled",
			"name" : "Las Vegas - Grand Celebration with Strip",
			"cityCode" : "LAS",
			"immediateBooking" : true,
			"hasAvailability" : true
		},
		{
			"id" : "38bd0215-3b36-47f3-8384-dd275f044a2a",
			"productTypeCode" : "scheduled",
			"name" : "Las Vegas - Grand Voyager",
			"cityCode" : "LAS",
			"immediateBooking" : true,
			"hasAvailability" : true
		},
		**** MORE MATCHING PRODUCTS ****
	]
}