Difference between revisions of "AurJson"

From ArchWiki
Jump to: navigation, search
(Search)
(Error)
Line 33: Line 33:
 
=== Error ===
 
=== Error ===
 
The error type has an error response string as the return value. An error response can be returned from either a '''''search''''' or an '''''info''''' query type.
 
The error type has an error response string as the return value. An error response can be returned from either a '''''search''''' or an '''''info''''' query type.
 +
 
Example return of ReturnType '''''error''''':
 
Example return of ReturnType '''''error''''':
 
  {"type":"error","results":"No results found"}
 
  {"type":"error","results":"No results found"}

Revision as of 03:08, 5 April 2008

Overview

The AurJson interface is a lightweight remote interface for the AUR. It utilizes json as the data exchange format.

Usage

The interface has two major query methods:

  • search
  • info

Each method requires the following HTTP GET syntax:

type=methodname&arg=data

Where methodname is the name of an allowed method, and data is the argument to the call. Data is returned in json encapsulated format.

Return Values

The return payload is of one format, and currently has three main types.

The main format of the return payload is:

"type": ReturnType
"data": ReturnData

ReturnType is one of: Error, Search, Info. The return type of ReturnData is dependent on the query type:

  • If ReturnType is error then ReturnData is a string.
  • If ReturnType is search then ReturnData is an array of dictionary objects.
  • If ReturnType is info then ReturnData is a single dictionary object.

Error

The error type has an error response string as the return value. An error response can be returned from either a search or an info query type.

Example return of ReturnType error:

{"type":"error","results":"No results found"}

Search

The search type is the result returned from a search request operation. Returning the type as search is useful for detecting whether the response to a search operation is search data or an error.

Example return of ReturnType search:

{"type":"search","results":[{"Name":"pam_abl","ID":"1995"}]}

Info

The info type is the result returned from an info request operation. Returning the type as search is useful for detecting whether the response to a search operation is search data or an error.

Example return of ReturnType info:

{"type":"info","results":{"ID":"1995","Name":"pam_abl","Version":"0.2.3-1","Description":"Provides auto blacklisting of hosts and users responsible for repeated failed authentication attempts","URL":"http:\/\/www.hexten.net\/pam_abl","URLPath":"\/packages\/pam_abl\/pam_abl.tar.gz","License":"","NumVotes":"4","OutOfDate":"0"}}

Example

Example Query:

http://aur-url/rpc.php?type=search&arg=foobar

Example Return:

{"type":"error","results":"No results found"}

jsonp

If you are working with a javascript page, and need a jsonp callback mechanism, you can do it. You just need to provide an additional variable callback. This callback is usually handled via the javascript library, but here is an example.

Example Query:

http://aur-url/rpc.php?type=search&arg=foobar&callback=jsonp1192244621103

Example Return:

jsonp1192244621103({"type":"error","results":"No results found"})