GET api/studyareas?name={name}&nameContains={nameContains}&inactive={inactive}

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

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

 string

None.
nameContains

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

 string

None.
inactive

Filter indicating whether to retrieve active or inactive records.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

StudyAreaDto
NameDescriptionTypeAdditional information
Id

The primary key of the record in the Hobsons database.

 integer

None.
Name

The name of the study area Ignored for PUT requests sent to the API.

 string

Required

String length: inclusive between 0 and 100
Position

Can be used for ordering a collection of records if configured.

 integer

Range: inclusive between 1 and 99999999
Inactive

boolean

Required

Response Formats

application/json, text/json

Sample: 
{
  "Id": 1,
  "Name": "sample string 2",
  "Position": 1,
  "Inactive": true
}