API Response Format

[kurtbradd]

As per our most recent conversation, below is an initial proposal for the response object format of a search request to the API.

{
    "query": {
        "id": 123123123,
        "q_namespace": "spotify_artist",
        "parameters": {
            "ordering": "created_at",
            "include": [
                "id", "confidence", "created_at"
            ],
            "min_confidence": 0.5,
            "r_namespace": [
                "musicbrainz",
                "echonest",
                "acousticbrainz"
            ]
        }
    },
    "results": {
        "musicbrainz": [
            {
                "id": 12312321, 
                "confidence": 0.754,
                "created_at": 2016-09-01
            }
        ],
        "echonest": [],
        "acousticbrainz": [
            {
                "id": 12312312, 
                "confidence": 0.754,
                "created_at": 2016-09-01
            },
            {
                "id": 1231, 
                "confidence": 0.754,
                "created_at": 2016-09-01
            }
        ]
    }
}

[vigliensoni]

I checked the Solr response and, per default, it returns the parameters of the query in the responseHeader, as in:

{
  "response": {
    "docs": [
    ...
    ],
    "numFound": 167, 
    "start": 0
  }, 
  "responseHeader": {
    "QTime": 3, 
    "params": {
      "q": "facebook_artist:38984171847", 
      "wt": "json"
    }, 
    "status": 0
  }
}