GET api/{lang}/pages?page={page}&version={version}&query={query}&pagetypecode={pagetypecode}&whitelabelcode={whitelabelcode}

Returns a collection of the pages on WePlann.

Resource URL

Tests Spanish: https://sandbox.weplann.com/api/es/pages?page={page}&version={version}&query={query}&pagetypecode={pagetypecode}&whitelabelcode={whitelabelcode}
Production Spanish: https://developer.weplann.com/api/es/pages?page={page}&version={version}&query={query}&pagetypecode={pagetypecode}&whitelabelcode={whitelabelcode}
Tests Spanish: https://sandbox.weplann.com/api/pt/pages?page={page}&version={version}&query={query}&pagetypecode={pagetypecode}&whitelabelcode={whitelabelcode}
Production Spanish: https://developer.weplann.com/api/pt/pages?page={page}&version={version}&query={query}&pagetypecode={pagetypecode}&whitelabelcode={whitelabelcode}

Request Parameters

Name Description Type Additional Information Mandatory
page The page to return integer Default is page 1. A maximum of 100 pages will be returned at a time. No
version Used to retrieve incremental updates. See Incremental Updates integer No
query Search string to limit results string No
pagetypecode Used to restrict pages to a particular type string Valid types are city, category, and product No
whitelabelcode Used to restrict pages to a particular white label 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 pages 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 pages
 + Id unique identifier
 + PageTypeCode The type of page. (city, category, product) string
 + CityCode City to which this page is assigned. string
 + Published Indicates if page is available on the site. boolean
 + Url Url where page is available. boolean

Example Request

GET https://developer.weplann.com/api/es/pages?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>457</TotalCount>
   <TotalPages>5</TotalPages>
   <HasPreviousPage>true</HasPreviousPage>
   <HasNextPage>true</HasNextPage>
   <Values>
      <Page Id="a2f97fcf-b786-4bf5-85bc-0c90b197f804">
         <Name>CityPass NY: sáltate las colas y visita 6 monumentos hasta en 9 días</Name>
         <Url>//www.weplann.com/nueva-york/city-pass</Url>
         <Published>true</Published>
         <PageTypeCode>product</PageTypeCode>
         <CityCode>LGA</CityCode>
      </Page>
      <Page Id="5cce14d8-6ca7-4275-b059-73efefa9853a">
         <Name>Completo tour por el barroco en Ape Calessino</Name>
         <Url>//www.weplann.com/roma/tour-ape-calessino</Url>
         <Published>true</Published>
         <PageTypeCode>product</PageTypeCode>
         <CityCode>FCO</CityCode>
      </Page>
      <Page Id="b8328f09-f7ef-4c15-aab1-6f8241186e6b">
         <Name>Con Niños</Name>
         <Url>//www.weplann.com/florencia/con-ninos</Url>
         <Published>true</Published>
         <PageTypeCode>category</PageTypeCode>
         <CityCode>FLR</CityCode>
      </Page>
      <Page Id="4da3ad4a-cb97-49b2-9777-805baf1d5039">
         <Name>Con niños</Name>
         <Url>//www.weplann.com/miami/con-ninos</Url>
         <Published>true</Published>
         <PageTypeCode>category</PageTypeCode>
         <CityCode>MIA</CityCode>
      </Page>
      **** MORE MATCHING PAGES ****
   </Values>
</PagedResponse>

Example Result (JSON)

{
	"currentPage" : 2,
	"pageSize" : 100,
	"totalCount" : 457,
	"totalPages" : 5,
	"hasPreviousPage" : true,
	"hasNextPage" : true,
	"values" : [
		{
			"id" : "a2f97fcf-b786-4bf5-85bc-0c90b197f804",
			"name" : "CityPass NY: sáltate las colas y visita 6 monumentos hasta en 9 días",
			"url" : "//www.weplann.com/nueva-york/city-pass",
			"published" : true,
			"pageTypeCode" : "product",
			"cityCode" : "LGA"
		},
		{
			"id" : "5cce14d8-6ca7-4275-b059-73efefa9853a",
			"name" : "Completo tour por el barroco en Ape Calessino",
			"url" : "//www.weplann.com/roma/tour-ape-calessino",
			"published" : true,
			"pageTypeCode" : "product",
			"cityCode" : "FCO"
		},
		{
			"id" : "b8328f09-f7ef-4c15-aab1-6f8241186e6b",
			"name" : "Con Niños",
			"url" : "//www.weplann.com/florencia/con-ninos",
			"published" : true,
			"pageTypeCode" : "category",
			"cityCode" : "FLR"
		},
                        **** MORE MATCHING PAGES ****
	]
}