Api::V1::NeighborhoodsController API

Get neighborhoods

GET /api/v1/neighborhoods

Parameters

Name	Description
token	User token
q	Search text

Request

Headers

Content-Type: application/json
Host: example.org
Cookie: 

Route

GET /api/v1/neighborhoods?token=foobar110&q=foo

Query Parameters

token: foobar110
q: foo

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,POST,PUT,PATCH,DELETE
Access-Control-Allow-Headers: Origin,Accept,Content-Type,X-Requested-With,X-CSRF-Token,X-API-KEY
Content-Type: application/json; charset=utf-8
ETag: W/"b4476caafd860b5a7900c942a3383269"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: e49a6aba-4191-402e-a9ce-aa72560d0611
X-Runtime: 0.018848
Content-Length: 476

Status

200 OK

Body

{
  "neighborhoods": [
    {
      "id": 12,
      "name": "foobar",
      "description": "Pour les passionnés de foot du 17è",
      "welcome_message": null,
      "member": false,
      "members_count": 1,
      "image_url": null,
      "interests": [
        "sport"
      ],
      "ethics": null,
      "past_outings_count": 0,
      "future_outings_count": 0,
      "has_ongoing_outing": false,
      "address": {
        "latitude": 48.86,
        "longitude": 2.35,
        "display_address": ""
      },
      "user": {
        "id": 111,
        "display_name": "John D.",
        "avatar_url": null
      },
      "members": [
        {
          "id": 111,
          "display_name": "John D.",
          "avatar_url": null
        }
      ]
    }
  ]
}