Transferring blueprint from apiary.io

Author: mdesiderio

apiary.apib

@@ -0,0 +1,54 @@
+FORMAT: 1A
+HOST: https://api.topcoder.com/v3
+
+# ap-review-microservice
+
+Services to enable members to review submissions.
+
+It includes functionality for scorecards, scorecard questions, reviews, 
+review items, scoring individual reviews, aggregating review scores.
+
+# Scorecard API [/scorecards]
+
+Scorecard represents the top level object of the questions that should be 
+asked to reviewers during a review phase
+
+## Retrieve Scorecards [GET /?filter=scorecardId%3Dvalue&challengeId%3Dvalue]
+
+Retrieves scorecards 
+
++ Parameters
+  + filter: fieldName=fieldValue (enum[string],optional)  - parameter for filtering the fields according to v3 spec
+        + scorecardId - Filter parameter to retrieve a specific scorecard by id
+        + challengeId - Filter parameter to retrieve a specific scorecard that is assigned to the review phase of a challenge
+
++ Request (application/json)
+    
+    + Headers
+    
+            Authorization: Bearer token
+            Accept: application/json
+
++ Response 200 (application/json)
+
+        {
+            "id": "-40894480:14dbb858e00:-7fb7",
+            "result": {
+                "success": true,
+                "status": 200,
+                "metadata": null,
+                "content": [
+                    {
+                        "updatedAt": "",
+                        "createdAt": "",
+                        "createdBy": "",
+                        "updatedBy": "",
+                        "id": "",
+                        "name": ""
+                    }
+                ]
+            },
+            "version": "v3"
+        }
+
+