api example query

Example with Query String

Request

This is requesting the photo 123456 informations: title, description and publish-date

Here we ask for json format in response but we can ask for xml format too. Same method is used with http POST method.

GET http://www.something.com/api/photo.get/json/?id=123456&fields[]=title&fields[]=description&fields[]=publish-date

Response

The requested data are provided like this:

{
	"status"   : "valid",
	"response" : 
	{
		"title"        : "My best photo",
		"description"  : "This photo was token ..."
		"publish-date" : "2011-08-24T12:33:42+01:00"
	}
}

Response Error

If an error occurs like an unknown photo id:

{
	"status"  : "error",
	"code"    : "no_result",
	"message" : "There is no photo corresponding to the 'id' : 123456"
}

Notes

If you need to provide data which are not in the request body (beside method), you have extra url parameters to accomplish that. This is used for authentication.

Here a JSON request:

{
	"method"       : "comment.get",
	"extra_data_1" : "foo",
	"extra_data_2" : "bar",
	"request" : 
	{
		"id"     : 123456
	}
}

And its Query equivalent:

GET http://example.com/api/comment.get/xml/extra_data_1:foo/extra_data_2:bar/?id=123456