GET Photos

get

https://api.planomatic.com/v1/{format}/feeds/tour_slides/{api_key}/feedtype/{feedname}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

This API is used to return tour information for a company’s active tours. Tours and photos listed by this API are selected from across an entire Company's listings in the PlanOmatic Virtual Tour system. However, only properties that have been selected for inclusion at the listing level for the aforementioned company will be included in this API. Keep in mind the feed only retrieves six months of results. If older data is needed the start_date parameter may be used.

Path Params

format

string

required

Defaults to json

txt, xml, or json. This parameter determines the response format for the API call. Depending on your needs, the data can be pulled using text (CSV), XML, or JSON formats.

api_key

string

required

The key parameter will be used in the future to authenticate access. If you do not have your direct access key please email us at [email protected].

feedname

string

required

String. No default. The feed type parameter, also known as the feed name, is the name used to obtain tours which belong to a particular feed. If you do not know the specific feed name please email us at [email protected]

Query Params

number_of_days

int32

Input a number of days to limit the results dataset returned. The minimum is 1 day and the maximum is 30 days. This optional parameter inputted will return the dataset in the past number of days specified. For example, if 30 is inputted, it will return the dataset from the past 30 days.

start_date

date

Input a start date to get a specific time frame for your dataset. This parameter must be used with number of days parameter. For example, if 2016-04-01 is inputted for start date and 10 is inputted for number of days, it will return the dataset between 2016-04-01 to 2016-04-11.

show_related_photos

string

This parameter can only be used with the photo feeds and the number_of_days parameter above. This parameter will return all photos of any tour that has been updated within the number_of_days parameter passed in. To use this Boolean parameter, the value must be 1.

order_id[]

array of int32s

This parameter will only pull tour and photo information based on its correlating order id. The param key must be in array format, even if you are only passing through one order id. Notice, this param cannot be combined with any other optional params.

order_id[]

Responses

200200

400400