GET api/Colleges?name={name}

Get a specified school by the school name

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

The name of the college to search for

string

Required

Body Parameters

None.

Response Information

Resource Description

List of colleges returned by search results

Collection of College
NameDescriptionTypeAdditional information
id

The unique identifier for the school

integer

None.

college_name

The name of the school

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "college_name": "sample string 2"
  },
  {
    "id": 1,
    "college_name": "sample string 2"
  }
]

text/xml

Sample:
<ArrayOfCollege xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JoomieApi.Models">
  <College>
    <college_name>sample string 2</college_name>
    <id>1</id>
  </College>
  <College>
    <college_name>sample string 2</college_name>
    <id>1</id>
  </College>
</ArrayOfCollege>