Reviews

Get Review

Gets the users review of a song.

Method GET
Endpoint /connect/reviews/songID/get
Query Parameters (string) connectToken


Output Body (Success)
{
   "version":1,
   "status":200,
   "data":{
      "id":23,
      "song":{
         "id":138,
         "title":"Tendril",
         "subtitle":"",
         "artist":"Collin McLoughlin \u0026 Au5",
         "charter":"Halflite",
         "uploader":1,
         "fileReference":"spinshare_5ea59e04df800",
         "tags":[
            "test",
            "awesome",
            "nice"
         ],
         "views":536,
         "downloads":2,
         "isExplicit":false,
         "isTournament":false,
         "hasEasyDifficulty":false,
         "hasNormalDifficulty":false,
         "hasHardDifficulty":false,
         "hasExtremeDifficulty":false,
         "hasXDDifficulty":true,
         "uploadDate":{
            "date":"2020-04-26 16:43:16.000000",
            "timezone_type":3,
            "timezone":"Europe\/Berlin"
         },
         "description":"I\u0027m very proud of this chart!"
      },
      "user":{
         "id":1,
         "username":"taw",
         "coverReference":"5f4147b117c7b.png",
         "isVerified":true,
         "isPatreon":true,
         "pronouns": "they/them"
      },
      "recommended":true,
      "comment":"Nice1337",
      "reviewDate":{
         "date":"2020-09-09 19:25:29.000000",
         "timezone_type":3,
         "timezone":"Europe\/Berlin"
      }
   }
}


Responses

Code Explaination
200 The review exists.
422 Some parameters were missing.
403 Your connectToken is missing or wrong.
404 This song does not exist or there is no review from this user.

Add Review

Adds or updates a review of a song.

Method POST
Endpoint /connect/reviews/songID/add
Query Parameters (string) connectToken
JSON Body (bool) recommend
(string) comment


Responses

Code Explaination
200 The review was posted successfully.
201 The review was updated successfully.
422 Some parameters were missing.
403 Your connectToken is missing or wrong.
404 This song does not exist.

Remove Review

Removes a review from a song if the user owns it or has appropriate permissions.

Method GET
Endpoint /connect/reviews/songID/remove
Query Parameters (string) connectToken


Responses

Code Explaination
200 The review was successfully removed.
422 Some parameters were missing.
403 Your connectToken is missing/wrong or you don't have permission to remove this review.
404 The song or review does not exist.