Requests and Responses

From Ma.gnolia Community Wiki

Request Format

All calls to the Ma.gnolia API start with http://ma.gnolia.com/api/rest/2/method_name with “2” representing the API Version. Although GET requests are supported, the preferred method of making calls is to use POST.

Response Format

All responses are wrapped in a response container which provides the status of the request and the api version:

 <response status="ok" version="2">
   ... response body ...
 </response>

If a request fails, the response body will include an error element:

 <response status="fail" version="2">
   <error code="100" message="Bad request." />
 </response>

Successful response content formats are documented in the individual method calls.

General Notes

Multiple values for parameters are separated by commas.

[member] can be specified as ‘myself’ to refer to the current user, or the screen name for a member. Appears as [members] where more than one can be specified.

[bookmark] is specified by the bookmark’s name in the system. The name for a bookmark is visible at the UI level as the final portion of the Short URL. Appears as [bookmarks] in this document where more than one can be specified.

[tag] specifies a tag, which can have spaces. Appears as [tags] in this document where more than one can be specified.

[datetime] specifies an XML dateTime (“2006-02-15T14:13:14Z”). Please note that we do not support trailing time zone specifications.