This reference documents version 2 of the Placester RESTful API. “People” does not exist in the v2.1 section.

The code in this document requires an API key which you can obtain from the Placester plugin.

Basic Use

  http://api.placester.com/api/v2/people/people_id[.format]?api_key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

[.format] can be .xml or .json depending on the format you want the API to output.

Arguments

Arguments are specified on the URL usually after the API key and are separated by an &. You can use the following patterns for different types of arguments:

ArgumentDescriptionExample
person_idPerson to get data for

 

Returns

KeyDescription
idPerson ID
relationWhere the person came from
cust_relationCustom relation type
cur_dataCurated data returned for the person
people[]cur_data[]namePerson’s name
people[]cur_data[]emailPerson’s email
people[]uncur_dataUncurated data for the listing
rel_people[]idRelated Person ID
rel_people[]relationshipRelated peoples relationship to this person
fav_listings[]idListing ID
fav_listings[]addressAddress of the persons favorite listing

 

Sample Output

<?xml version="1.0" encoding="UTF-8"?>
<person>
    <id>520bd54456dabc540c000001</id>
    <relation>2</relation>
    <cur-data>
        <name>Matt Williams</name>
        <email>mwilliams@placester.com</email>
    </cur-data>
    <uncur-data></uncur-data>
</person>