Methods

get
Get User

https://fixer-uppers-api.azurewebsites.net/user/:id
This endpoint allows you to retrieve user information
Request
Response
Request
Path Parameters
id
required
string
ID of the user
Response
200: OK
User successfully retrieved
User object
404: Not Found
Could not find a user matching this ID
{
"message": "User not found"
}

get
Get Badge

https://fixer-uppers-api.azurewebsites.net/badge/:id
This endpoint allows you to retrieve badge details
Request
Response
Request
Path Parameters
id
required
string
ID of the badge
Response
200: OK
Badge successfully retrieved
Badge Object
404: Not Found
Could not find a badge matching this ID
{
"message": "Badge not found"
}

post
Create Listing

https://fixer-uppers-api.azurewebsites.net/create-listing
This endpoint allows a user to create a listings
Request
Response
Request
Headers
authorisation
required
string
Author's user ID
Body Parameters
title
required
string
Listing title
description
required
string
Listing description
listing_type
required
string
The type of listing, as defined by ListingType
Response
200: OK
Listing successfully created. This response contains the new listing ID in the body
{
"message": "Listing successfully created",
"id": listing ID
}

get
Search Resources

https://fixer-uppers-api.azurewebsites.net/search
This endpoint allows you to retrieve listings in your local area
Request
Response
Request
Path Parameters
query
required
string
The search string
Response
200: OK
Successfully retrieved search results
Array of Resource objects

get
Get Listings

https://fixer-uppers-api.azurewebsites.net/listings
This endpoint allows you to retrieve all open listings
Request
Response
Request
Response
200: OK
Successfully retrieved listings Note: If no listings are found, this will return an empty array
Array of listing objects

get
Get Listing

https://fixer-uppers-api.azurewebsites.net/listing/:id
This endpoint allows you to retrieve details for a single listing
Request
Response
Request
Path Parameters
optional
string
Response
200: OK
Successfully retrieved listing
Listing object
404: Not Found
Listing not found
{
"message": "Listing not found"
}