Marketplace.getListings

From Facebook Developers Wiki

Contents 1 Description 2 Parameters 3 Example Return XML 4 Response 5 FQL Equivalent 6 Error Codes

[edit] Description

Return all Marketplace listings either by listing ID or by user.

[edit] Parameters

Required	Name	Type	Description
required	api_key	string	The application key associated with the calling application.
	session_key	string	The session key of the logged in user.
	call_id	float	The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function.
	sig	string	An MD5 hash of the current request and your secret key, as described in the authentication guide.
	v	string	This must be set to 1.0 to use this version of the API.
optional	format	string	Desired response format. Either XML (default) or JSON.
	callback	string	Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.
	listing_ids	array	Filter by listing IDs. This is a comma-separated list of listing IDs. If you leave this blank, then the list is filtered only for user IDs.
	uids	array	Filter by a list of users. This is a comma-separated list of user IDs. If you leave this blank, then the list is filtered only for listing IDs.

[edit] Example Return XML

<?xml version="1.0" encoding="UTF-8"?> <marketplace_getListings_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd" list="true"> <listing> <listing_id>4973534529</listing_id> <url>http://www.facebook.com/marketplace/listing.php?classified_id=4973534529</url> <title>Want a Bike Bad</title> <description>please sell me a bike, i want to save the environment. pretty please.</description> <poster>703</poster> <update_time>1190706121</update_time> <category>FORSALE_WANTED</category> <subcategory>GENERAL_WANTED</subcategory> <image_urls list="true"/> </listing> </marketplace_getListings_response>

[edit] Response

This method returns all visible listings matching the criteria given. If no matching listings are found, the method returns an empty element.

[edit] FQL Equivalent

This function is similar to doing the following FQL query, with the appropriate parameters filled in:

SELECT listing_id, url , title, description, price, poster, update_time, category, subcategory, image_urls, condition, isbn,num_beds,num_baths,dogs,cats, smoking, square_footage, street, crossstreet, postal, rent, pay, full,intern, summer, nonprofit, pay_type FROM listings WHERE poster in (uids) AND listing_id in (listing_ids)

[edit] Error Codes

Code	Description
1	An unknown error occurred. Please resubmit the request.
2	The service is not available at this time.
4	The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed.
5	The request came from a remote address not allowed by this application.
100	One of the parameters specified was missing or invalid.
101	The API key submitted is not associated with any known application.
102	The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key.
103	The submitted call_id was not greater than the previous call_id for this session.
104	Incorrect signature.