search

rigatoni / linguine

Issue tracking repository.
http://rigatoni.se.rit.edu
3 stars 2 forks source link

Define JSON formatting #8

Closed mikewideman closed 10 years ago

petermikitsh commented 10 years ago

Initial (v1) payload format

Outgoing from Express to Webserver:

{
  "transactionId": "A unique string associated on per-request basis.",
  "operation": "The analysis technique to be applied.",
  "library": "The analytics engine ",
  "data": ["An array of the id's to the documents containing the data to analyze."]
}

Incoming from Webserver to Express:

{
  "transactionId": "A unique string associated on per-request basis.",
  "operation": "The analysis technique to be applied.",
  "library": "The analytics engine ",
  "results": {}
}

The results object format is dependent on the operation and library specified.