Use this interface to retrieve a specific service from our database in json.

Deprecated

This version is deprecated. Please look into an upgrade.

Endpoint

https://api.tosdr.org/rest-service/v1/<service>.json
CODE

Parameters

ParameterTypeDescription
serviceString|IntegerThe Slug or ID of a service


Global Rate Limit

BenefitSecondHourDay
Guest151000

15000

Staff15000100000150000
Office15000100000150000
Partner1501000050000

This rate limit applies to all interfaces. Each Interface and method may implement its own rate limit.


Implemented Error codes

Error Code
INVALID_SERVICE


JSON Schema

{
    "$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"
                },
                "name": {
                    "type": "string"
                },
                "url": {
                    "type": "string"
                },
                "created_at": {
                    "type": "string"
                },
                "updated_at": {
                    "type": "string"
                },
                "wikipedia": {
                    "type": "string",
                    "format": "uri",
                    "qt-uri-protocols": [
                        "https"
                    ]
                },
                "keywords": {
                    "type": "string"
                },
                "related": {
                    "type": "string"
                },
                "slug": {
                    "type": "string"
                },
                "is_comprehensively_reviewed": {
                    "type": "boolean"
                },
                "user_id": {
                    "type": "null"
                },
                "rating": {
                    "type": "string"
                },
                "status": {
                    "type": "null"
                },
                "nice_service": {
                    "type": "string"
                },
                "has_image": {
                    "type": "boolean"
                },
                "image": {
                    "type": "string",
                    "format": "uri",
                    "qt-uri-protocols": [
                        "https"
                    ],
                    "qt-uri-extensions": [
                        ".svg",
						".png"
                    ]
                },
                "documents": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Document"
                    }
                },
                "points": {
                    "type": "array",
                    "items": {
                        "$ref": "#/definitions/Point"
                    }
                },
                "urls": {
                    "type": "array",
                    "items": {
                        "type": "string"
                    }
                }
            },
            "required": [],
            "title": "Parameters"
        },
        "Document": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "integer"
                },
                "name": {
                    "type": "string"
                },
                "url": {
                    "type": "string",
                    "format": "uri",
                    "qt-uri-protocols": [
                        "https"
                    ]
                },
                "xpath": {
                    "$ref": "#/definitions/Xpath"
                },
                "text": {
                    "type": "string"
                },
                "created_at": {
                    "type": "string"
                },
                "updated_at": {
                    "type": "string"
                },
                "service_id": {
                    "type": "integer"
                },
                "reviewed": {
                    "anyOf": [
                        {
                            "type": "boolean"
                        },
                        {
                            "type": "null"
                        }
                    ]
                },
                "user_id": {
                    "type": "null"
                },
                "status": {
                    "type": "null"
                },
                "crawler_server": {
                    "type": "null"
                }
            },
            "required": [],
            "title": "Document"
        },
        "Point": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "discussion": {
                    "type": "string",
                    "format": "uri",
                    "qt-uri-protocols": [
                        "https"
                    ]
                },
                "id": {
                    "type": "integer"
                },
                "needsModeration": {
                    "type": "boolean"
                },
                "document": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/Document"
                        },
                        {
                            "type": "null"
                        }
                    ]
                },
                "quote": {
                    "anyOf": [
                        {
                            "type": "null"
                        },
                        {
                            "type": "string"
                        }
                    ]
                },
                "services": {
                    "type": "array",
                    "items": {
                        "type": "string",
                        "format": "integer"
                    }
                },
                "set": {
                    "$ref": "#/definitions/Set"
                },
                "slug": {
                    "type": "null"
                },
                "title": {
                    "type": "string"
                },
                "topics": {
                    "type": "array",
                    "items": {}
                },
                "case": {
                    "$ref": "#/definitions/Case"
                }
            },
            "required": [],
            "title": "Point"
        },
        "Case": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "id": {
                    "type": "integer"
                },
                "classification": {
                    "$ref": "#/definitions/Classification"
                },
                "score": {
                    "type": "integer"
                },
                "title": {
                    "type": "string"
                },
                "description": {
                    "type": "string"
                },
                "topic_id": {
                    "type": "integer"
                },
                "created_at": {
                    "type": "string",
                },
                "updated_at": {
                    "type": "string",
                },
                "privacy_related": {
                    "anyOf": [
                        {
                            "type": "boolean"
                        },
                        {
                            "type": "null"
                        }
                    ]
                },
                "docbot_regex": {
                    "anyOf": [
                        {
                            "type": "null"
                        },
                        {
                            "type": "string"
                        }
                    ]
                }
            },
            "required": [],
            "title": "Case"
        },
        "Xpath": {
            "type": "string",
            "title": "Xpath"
        },
        "Classification": {
            "type": "string",
            "enum": [
                "bad",
                "good",
                "neutral",
                "blocker"
            ],
            "title": "Classification"
        },
        "Set": {
            "type": "string",
            "enum": [
                "set+service+and+topic"
            ],
            "title": "Set"
        }
    }
}

JS