GET /case/v1
Use this interface to retrieve a specific case from our database in json.
Endpoint
CODE
https://api.tosdr.org/case/v1/
Parameters
Parameter | Type | Description |
---|---|---|
case | Integer | The Case ID to retrieve. Omit to list all cases |
page | Integer | The pagination number. Default 1 |
Repository
https://github.com/tosdr/API/tree/master/functions/Case/GET/v1
Implemented Error codes
Error | HTTP Status | Bitmask |
---|---|---|
An invalid case id has been supplied | 404 |
|
JSON Schema
JS
{
"$schema": "http://json-schema.org/draft-06/schema#",
"$ref": "#/definitions/Welcome",
"definitions": {
"Welcome": {
"type": "object",
"additionalProperties": false,
"properties": {
"error": {
"type": "integer"
},
"message": {
"type": "string",
"format": "integer"
},
"parameters": {
"$ref": "#/definitions/Parameters"
}
},
"required": [],
"title": "Welcome"
},
"Parameters": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"classification": {
"type": "string"
},
"score": {
"type": "integer"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"topic_id": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"privacy_related": {
"type": "null"
},
"docbot_regex": {
"type": "string"
}
},
"required": [],
"title": "Parameters"
}
}
}