An API for retrieving and manipulating data on college football teams and conferences in the FBS.
A successful response returns an array of all college football teams in the FBS.
GET /api/v1/teams
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the team |
school | string | Name of the university |
mascot | string | School's mascot name |
conference | string | Name of the conference in which the school belongs |
Example: [ { "id": 131, "school": "Example School", "mascot": "Fish", "conference": "ACC" }, { "id": 132, "school": "Example University", "mascot": "Bear", "conference": "SEC" } ]
A successful response returns an array of all college football conferences in the FBS.
GET /api/v1/conferences
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the conference |
name | string | Official name of the conference |
abbreviation | string | Abbreviated name of the conference |
Example: [ { "id": 34, "name": "Example Conference", "abbreviation": "EC" }, { "id": 35, "name": "Southern Example", "abbreviation": "" } ]
A successful response returns data for a certain college football team selected by id.
GET /api/v1/teams/:id
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the team |
school | string | Name of the university |
mascot | string | School's mascot name |
conference | string | Name of the conference in which the school belongs |
Example: { "id": 131, "school": "Example School", "mascot": "Fish", "conference": "ACC" }
A successful response returns data for a certain college football conference selected by id.
GET /api/v1/conferences/:id
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the conference |
name | string | Official name of the conference |
abbreviation | string | Abbreviated name of the conference |
Example: { "id": 34, "name": "Example Conference", "abbreviation": "EC" }
A successful response returns the id of the new team that was just added.
POST /api/v1/teams
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the team |
school | string | Name of the university |
mascot | string | School's mascot name |
conference | string | Name of the conference in which the school belongs |
Example: { "school": "Example School", "mascot": "Fish", "conference": "ACC" }
Example: { "id": 131 }
A successful response returns the id of the new conference that was just added.
POST /api/v1/conferences
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the conference |
name | string | Official name of the conference |
abbreviation | string | Abbreviated name of the conference |
Example: { "name": "Example Conference", "abbreviation": "EC" }
Example: { "id": 34 }
A successful response returns a message confirming that the team matching the provided id was deleted.
DELETE /api/v1/teams/:id
Name | Type | Description |
---|---|---|
id | integer | Unique identifier of the team |
school | string | Name of the university |
mascot | string | School's mascot name |
conference | string | Name of the conference in which the school belongs |
Example: Team 25 deleted