Welcome to the annual Puppy Bowl! Teams of puppies will compete in a variety of events, including fetching sticks, wagging tails, and looking adorable!
The URL to access a resource in the API is structured as follows:
https://fsa-puppy-bowl.herokuapp.com/api/./2803-PUPPIES/playersFor example, the URL for all players for the 2803 cohort would be:
https://fsa-puppy-bowl.herokuapp.com/api/2803-PUPPIES/players
If a request is successful, the response will be structured as follows:
{
"success": true,
"data": /* whatever you requested */
}
If an error occurs, the response will be structured as follows:
{
"success": false,
"error": {
"name": "ErrorName",
"message": "This is an error message."
}
}
The stars of the show! Get information about the puppies playing in the Puppy Bowl, or draft your own team of puppies to compete!
{- "players": [
- {
- "id": 123,
- "name": "Crumpet",
- "breed": "American Staffordshire Terrier",
- "status": "bench",
- "teamId": 456
}
]
}| name required | string The name of the puppy |
| breed required | string The breed of the puppy |
| status | string Enum: "bench" "field" The status of the puppy.
|
| imageUrl | string The URL to an image of the puppy |
| teamId | number or null The ID of the team this puppy is on, or null if not on a team |
{- "name": "Crumpet",
- "breed": "American Staffordshire Terrier",
- "status": "bench",
- "teamId": 456
}{- "newPlayer": {
- "id": 123,
- "name": "Crumpet",
- "breed": "American Staffordshire Terrier",
- "status": "bench",
- "teamId": 456
}
}| id required | number Example: 123 The ID of the player to retrieve |
object |
{- "player": {
- "id": 123,
- "name": "Crumpet",
- "breed": "American Staffordshire Terrier",
- "status": "bench",
- "teamId": 456,
- "team": {
- "id": 456,
- "name": "Fluff",
- "score": 0,
- "players": [
- {
- "id": 123,
- "name": "Crumpet",
- "breed": "American Staffordshire Terrier",
- "status": "bench",
- "teamId": 456
}
]
}
}
}{- "teams": [
- {
- "id": 456,
- "name": "Fluff",
- "score": 0,
- "players": [
- {
- "id": 123,
- "name": "Crumpet",
- "breed": "American Staffordshire Terrier",
- "status": "bench",
- "teamId": 456
}
]
}
]
}