PROs API Documentation

Documentation for the PROs REST API endpoint.

Endpoints

GET /api/v1/pros

Retrieve a list of all pros.

Query Parameters

(none)

Response

{
    "pagination": {
        "total_entries": 190,
        "per_page": 999,
        "current_page": 1,
        "total_pages": 1
    },
    "pros": [
        {
            "id": 0,
            "abbreviation": "DP",
            "country_name": null,
            "url": "https://spondulix.com/api/v1/pros/0"
        },
        {
            "id": 1,
            "abbreviation": "ACUM",
            "country_name": "Israel",
            "url": "https://spondulix.com/api/v1/pros/1"
        },
        etc.
    ]
}

Response Fields

Field	Type	Description
pagination	object	Contains pagination information (PROs are always on a single page)
pros	array	List of PRO objects
id	integer	Society code for the PRO
abbreviation	string	Abbreviation of the PRO’s name
country_name	string	Name of the country the PRO is located in
url	string	URL of the PRO

HTTP Response Codes

Code	Description
`200 OK`	Successful request

GET /api/v1/pros/{id}

Retrieve details of a specific PRO.

Path Parameters

Name	Type	Description	Required
id	integer	Society code of the PRO	Yes

Response

{
    "id": 21,
    "abbreviation": "BMI",
    "country_name": "United States of America (the)",
    "url": "https://spondulix.com/api/v1/pros/21"
}

HTTP Response Codes

Code	Description
`200 OK`	Successful request
`404 Not Found`	Invalid Society code