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


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


Parameters

Parameter

Type

Description

service

String|Integer

The 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



Service Rating Enums

Hex

Grade

0x1

Grade A

0x2

Grade B

0x4

Grade C

0x8

Grade D

0x10

Grade E

0x20

N/A


Response Tree

.
├── error                            - [Integer]   Error Code Bitmask (See https://docs.tosdr.org/x/MIAF)
├── message                          - [String]    Response message of the API. Can contain useful information on error
└── parameters                       - [Object]    Parameter Object
    ├── id                           - [Integer] The Service ID
    ├── name                         - [String] The Service Name
    ├── created_at                   - [String] Postgres Timestamp of the service creation date
    ├── updated_at                   - [String] Postgres Timestamp of the last update date of the service
    ├── wikipedia                    - [String|Null] The link to the wikipedia page of the service, null if not set.
    ├── keywords                     - [String] Keywords of the service
    ├── related                      - [String] List of related services
    ├── slug                         - [String] Unique slug of the service
    ├── is_comprehensively_reviewed  - [Boolean] True if the service has been reviewed
    ├── rating                       - [Integer] Bitmask of the Rating, see "Service Rating Enums"
    ├── status                       - [String|Null] The status of the service, can be "deleted" or NULL
    ├── image                        - [String] Path to the service's logo
    ├── url                          - [String] Comma separated list of urls of the service
    ├── documents                    - [Array] An array of documents of the service
    │   ├── id                          - [Integer] The ID of the document
    │   ├── name                        - [String] The name of the document
    │   ├── url                         - [String] The url of the document
    │   ├── xpath                       - [String] The xpath of the document
    │   ├── text                        - [String] The content of the document
    │   ├── created_at                  - [String] Postgres Timestamp of the document creation date
    │   └── updated_at                  - [String] Postgres Timestamp of the last update date of the document
    ├── points                       - [Array] An array of points of the service
    │   ├── id                          - [Integer] The ID of the point
    │   ├── title                       - [String] The Title of the point
    │   ├── source                      - [String] The url of the document source
    │   ├── status                      - [String] The status of the point "approved" affect the rating
    │   ├── created_at                  - [String] Postgres Timestamp of the point creation date
    │   ├── updated_at                  - [String] Postgres Timestamp of the last update date of the point
    │   ├── quoteText                   - [String|Null] The excerpt of the document used for the point
    │   ├── case_id                     - [Integer] The ID of the assigned case
    │   ├── document_id                 - [Integer|Null] The ID of the assigned document
    │   ├── quoteStart                  - [Integer|Null] Character index of the document where the quote starts
    │   └── quoteEnd                    - [Integer|Null] Character index of the document where the quote ends
    └── urls                          - [Array<String>] Array of urls
CODE


Dataset Explorer