Collection Flag
POST {{baseUrl}}/collection/v1/flag/{{collectionId}}
This API is associated with flag Collection on the Sunbird Platform .
- /Collection/ endpoint executes the Flag Collection
request based on parameters provided as metadata in the request body.
- The endpoint for Update Collection is /collection/v1/flag
- It points to knowledge-mw-service - /v1/collection/flag
- {...}refers to a section of review endpoint URL path that needs to be replaced by appropriate Id.
- It is mandatory to provide values for parameters marked with *.
- Mandatory fields cannot be null or empty.
Request Body
{"request"=>{"flagReasons"=>["Copyright Violation"], "flaggedBy"=>"API-DOC-Tester", "versionKey"=>"{{collectionVersionKey}}", "flags"=>["kp-flags", "newKp-flags"]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | (Required) The Content Type entity is the media type of the resource.Possible media types can be:- |
- Application/json |
|
X-Authenticated-User-Token| string | | (Required) The Registered User ID used to execute the API. | |X-Channel-id| string | | The unique ID provided to the State to which the user belongs. | |Authorization| string | | (Required) All content APIs require authorization for use. Specify the authorization key received from the administrator when placing the request for use of the API. | |Accept| string | | |
RESPONSES
status: OK
{"id":"api.collection.flag","ver":"4.0","ts":"2022-01-06T07:11:52ZZ","params":{"resmsgid":"eb628dff-53c6-45f2-9789-0f193988f585","status":"successful"},"responseCode":"OK","result":{"identifier":"do_1134467204859658241168","node_id":"do_1134467204859658241168","versionKey":"1641453112470"}}