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

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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

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

 string

None.
nameContains

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

 string

None.
code

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

 string

None.
codeContains

Optional case-insensitive filter on campuses with a code 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

CampusDto
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's system code for this record.

 string

Required

String length: inclusive between 0 and 30
Position

The position number among the collection of records.

 integer

Range: inclusive between 1 and 99999999
Inactive

boolean

Required

Response Formats

application/json, text/json

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