Skip to content

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/specialties

Query Parameters ​

ParameterTypeRequiredDescription
professionIdintegerYesProfession ID (from getProfessions)

Example ​

http
GET /rest/refdata/specialties?professionId=1

Response ​

200 OK ​

json
[
  {
    "professionId": 1,
    "specialtyId": 1,
    "specialtyName": "Addiction Medicine"
  },
  {
    "professionId": 1,
    "specialtyId": 2,
    "specialtyName": "Allergist (Immunologist)"
  }
]
FieldTypeDescription
professionIdintegerThe parent profession ID
specialtyIdintegerPrimary key of the specialty
specialtyNamestringName of the specialty

Errors ​

ExceptionCause
WSInvalidParameterExceptionMissing or invalid professionId
WSRefDataServiceExceptionService error while fetching specialties

Version ​

http
GET /rest/refdata/specialties/version
json
{ "version": 1 }