This reference documents version 2 of the Placester RESTful API.

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

Basic Use

  DELETE - http://api.placester.com/api/v2/listings/[listing_id]?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:

Format URL Argument
String, Integer, or Float key=StringValue
Array key[]=StringValue1&key[]=StringValue2&key[]=StringValue3…
Hash metadata[key]=2&metadata[key]=4

 

Argument Description Example
listing_id Listing ID to be deleted (Required)

 

Returns

Successful deletion returns a HTTP 204 No Content.

HTTP/1.1 204 No Content
Cache-Control: no-cache
Connection: close
Date: Mon, 04 Nov 2013 21:50:42 GMT
Server: nginx
Set-Cookie: _placester_session=eyJzZXNzaW9uX2abcdefZjg5NjMwZGUwNTViYjhlMDA2OGQ3NTA5ZGZkZWU0NTEifQ%3D%3D--f5136f46ec0b54d2feeabcdef95901120fe2c660; path=/; HttpOnly
Status: 204 No Content
X-Frame-Options: DENY
X-Served-By: app4
X-UA-Compatible: IE=Edge,chrome=1