GET api/qualifications?name={name}&nameContains={nameContains}&code={code}&codeContains={codeContains}&studyLevelId={studyLevelId}&inactive={inactive}

Get all Qualifications optionally filtered by any of the arguments specified in the query string.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

Optional case-insensitive filter on Qualifications with a name that matches the provided value.

string

None.

nameContains

Optional case-insensitive filter on Qualifications with a name containing the provided value.

string

None.

code

Optional case-insensitive filter on Qualifications with a code that matches the provided value.

string

None.

codeContains

Optional case-insensitive filter on Qualifications with a code containing the provided value.

string

None.

studyLevelId

Optional filter on Qualifications with a studyLevelId that matches the provided value.

integer

None.

inactive

Filter indicating whether to retrieve active or inactive records.

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

QualificationDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database.

integer

None.

Name

string

Required

String length: inclusive between 0 and 100

Code

The client system code for the given record.

string

String length: inclusive between 0 and 100

StudyLevelId

The identifier of the StudyLevel associated with the given record.

integer

Range: inclusive between 1 and 99999999

Inactive

boolean

Required

StudyLevelName

The name of the study level associated with the given record. Ignored for PUT and POST requests sent to the API.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "Code": "sample string 3",
  "StudyLevelId": 1,
  "Inactive": true,
  "StudyLevelName": "sample string 5"
}