Appearance
getSpecialties ​
Retrieves a list of specialties as they relate to a profession.
INFO
This is a global list across all countries — a country-specific list of specialties was deemed too complex.
Request ​
http
GET /rest/refdata/specialtiesQuery Parameters ​
| Parameter | Type | Required | Description |
|---|---|---|---|
professionId | integer | Yes | Profession ID (from getProfessions) |
Example ​
http
GET /rest/refdata/specialties?professionId=1Response ​
200 OK ​
json
[
{
"professionId": 1,
"specialtyId": 1,
"specialtyName": "Addiction Medicine"
},
{
"professionId": 1,
"specialtyId": 2,
"specialtyName": "Allergist (Immunologist)"
}
]| Field | Type | Description |
|---|---|---|
professionId | integer | The parent profession ID |
specialtyId | integer | Primary key of the specialty |
specialtyName | string | Name of the specialty |
Errors ​
| Exception | Cause |
|---|---|
WSInvalidParameterException | Missing or invalid professionId |
WSRefDataServiceException | Service error while fetching specialties |
Version ​
http
GET /rest/refdata/specialties/versionjson
{ "version": 1 }