Skip to content

GET get_city_project

jokil123 edited this page Feb 12, 2022 · 1 revision

Description

This route will retrieve a city project.

Request

HTTP Verb: GET

/get_city_project/<id>

Dynamic URL segments

  • id

    the id (Primary key) of the row you would like to retrieve.

Headers

  • Authorization header

    the request must include a header authorization. Its value must be the API key you have been given. Every key has access to all get routes and ownership of rows is not enforced.

Response

Data

If the request succeeds the API will respond with a city project JSON object of the following shape:

{
    "id": number,
    "country_id": number,
    "name": string,
    "description": string,
    "visible": number
} 

Status Codes

  • 200 Ok

    This status code will be returned if the request suceeds. It will always be sent along with the response data.
  • 400 Bad Request

    This status code will be returned if the auth header is missing.
  • 401 Unauthorized

    This status code will be returned if the API key is invalid