Skip to content
Brian Campbell edited this page Apr 14, 2015 · 20 revisions

#API

##Coordinator

VERB URL BODY RESPONSE
POST /register {id: Number, url: String} RESPONSE 200 or 400
GET /query {id: Number, query: String, data:[QUERY]} RESPONSE 200 or 400
POST /response {id: Number, query: String, data: [RESPONSE]} RESPONSE 200 or 400

##Module

VERB URL BODY RESPONSE
POST /query {id: Number, query: String, data:[QUERY]} RESPONSE 202 or 400

##Example Queries ###1 Find the price of "Viva la Vida" ###Query

{
  "id":0,
  "query":"commerce",
  "data":[{
    "query":"song",
    "data":[{
         "track_name":"Viva la Vida",
         "artist_name":"Cold Play"
    }]
  }]
}

###Response

{
  "id":0,
  "query":"commerce",
  "data":[{
    "query":"song",
    "data":[{
         "category": "song",
         "track_name":"Viva la Vida",
         "artist_name":"Cold Play",
         "track_price":"1.29"
    }]
  }]
}

##2 Find the top rated songs ###Query

{
  "id":2,
  "query":"top songs",
  "data":[]
}

###Response

{
  "id":2,
  "query":"top songs",
  "data":[
      {
       "artist_name":"Sheppard",
       "album_name":"Bomb's Away",
       "track_name":"Geronimo"
      },
      {
       "artist_name":"Bruno Mars",
       "album_name":"Uptown Funk - Single",
       "track_name":"Uptown Funk You Up"
      }
   ]
}

##3 Find the top rated songs ###Query

{
  "id":2,
  "query":"commerce",
  "data":[{
     "id":2,
     "query":"top songs",
     "data":[{}]
   }]
}

###Response

{
  "id":2,
  "query":"commerce",
  "data":[{
     "id":2,
     "query":"top songs",
     "data":[
      {
       "artist_name":"Sheppard",
       "album_name":"Bomb's Away",
       "track_name":"Geronimo",
       "track_price":"1.29"
      },
      {
       "artist_name":"Bruno Mars",
       "album_name":"Uptown Funk - Single",
       "track_name":"Uptown Funk You Up",
       "track_price":"1.29"
      }]
   }]
}

Clone this wiki locally