Difference between revisions of "AurJson"

From ArchWiki
Jump to: navigation, search
(Return Values)
(Return Values)
Line 22: Line 22:
  
 
The main format of the return payload is:
 
The main format of the return payload is:
  "type": returntype
+
  "type": ReturnType
  "data": returndata
+
  "data": ReturnData
  
Types is one of: Error, Search, Info.
+
ReturnType is one of: Error, Search, Info.
The return type of data is dependent on the query type:
+
The return type of ReturnData is dependent on the query type:
* If type is `error` then data is a string.
+
* If returntype is `error` then ReturnData is a string.
* If type is `search` then data is an array of dictionary objects.
+
* If returntype is `search` then ReturnData is an array of dictionary objects.
* If type is `info` then data is a single dictionary object.
+
* If returntype is `info` then ReturnData is a single dictionary object.
  
 
=== Error ===
 
=== Error ===

Revision as of 03:04, 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. Example return of type 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 type 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 type 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"})