Difference between revisions of "App/API"

From mx Help Wiki
Jump to: navigation, search
(Created page with ' == Conventions == === Request === * [ option1 | option2 ] - List of options, one of which is required * < value > - Required. === Response === Regular text: literal ''Ita…')
 
m (Conventions)
 
(5 intermediate revisions by one user not shown)
Line 1: Line 1:
 
 
== Conventions ==
 
== Conventions ==
 +
 +
* All requests default to return JSON unless otherwise noted. 
  
 
=== Request ===
 
=== Request ===
  
* [ option1 | option2 ] - List of options, one of which is required
+
* [ ] - List of options, one of which is required
 
* < value > - Required.
 
* < value > - Required.
  
 
=== Response ===  
 
=== Response ===  
  
  Regular text: literal
+
  Regular text - literal
  ''Italicized text'': replaced with response
+
  ''Italicized text'' - replaced with response
  '''...''': Result at same level can be repeated.
+
  '''...''' - Result at same level can be repeated.
 +
[] - Array
 +
{} - Hash
 +
Key:Value - ''':''' (Colon) separates the two.
 +
 
 +
== Methods ==
 +
 
 +
{{Special:Prefixindex/App/API}}

Latest revision as of 16:49, 5 March 2011

Contents

[edit] Conventions

  • All requests default to return JSON unless otherwise noted.

[edit] Request

  • [ ] - List of options, one of which is required
  • < value > - Required.

[edit] Response

Regular text - literal
Italicized text - replaced with response
... - Result at same level can be repeated.
[] - Array
{} - Hash
Key:Value - : (Colon) separates the two.

[edit] Methods

App/APIApp/API/FigureApp/API/Ontology
App/API/Ontology/analyzeApp/API/Ontology/glossary markupApp/API/Ontology/label
App/API/Ontology/ontology classApp/API/Ontology/svgApp/API/Ontology/uri markup
Personal tools