getProfessions

Retrieves a list of professions.

Version Note

Current version = 3 — removed field en_US and replaced with the locale parameter.

Request

GET /rest/refdata/professions

Query Parameters

Parameter	Type	Required	Description
professionId	integer	No	Filter by a single profession ID
professionName	string	No	Filter by profession name
locale	string	No	Locale for translated names

Examples

GET /rest/refdata/professions
GET /rest/refdata/professions?professionId=1
GET /rest/refdata/professions?professionName=Doctor

Response

200 OK

[
  {
    "professionId": 1,
    "professionName": "Doctor",
    "professionOrder": 1
  },
  {
    "professionId": 2,
    "professionName": "Nurse",
    "professionOrder": 2
  }
]

Field	Type	Description
professionId	integer	Primary key of the profession
professionName	string(255)	Name of the profession
professionOrder	integer	Display order

Errors

Exception	Cause
WSInvalidParameterException	Invalid parameter value
WSRefDataServiceException	Service error while fetching professions

Version

GET /rest/refdata/professions/version

{ "version": 3 }