Api::V1::EntouragesController API

Entourages

Create outing

POST api/v1/entourages

Parameters

Name Description
token token
entourage[group_type] outing
entourage[title] Title
entourage[location][latitude] Latitude
entourage[location][longitude] Longitude
entourage[entourage_type] contribution or ask_for_help
entourage[display_category] mat_help, social, resource, info, skill, event or other
entourage[status] Entourage status
entourage[description] Entourage description
entourage[category] mat_help, non_mat_help or social
entourage[public] deprecated
entourage[metadata][starts_at] Start date
entourage[metadata][place_name] Place name
entourage[metadata][street_address] Street address
entourage[metadata][google_place_id] Google place ID
entourage[metadata][landscape_url] Path to a 1125 x 375px image url
entourage[metadata][landscape_thumbnail_url] Path to a thumbnail of 1125 x 375px image url
entourage[metadata][portrait_url] Path to a 300 x 492px image url
entourage[metadata][portrait_thumbnail_url] Path to a thumbnail of 300 x 492px image url

Request

Headers

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

Route

POST api/v1/entourages

Body

{"token":"foobar47","entourage":{"group_type":"outing","title":"foobar","location":{"latitude":48.854367553785,"longitude":2.27034058909627},"metadata":{"starts_at":"2022-06-03T19:00:00.000+02:00","place_name":"Café la Renaissance","street_address":"44 rue de l’Assomption, 75016 Paris, France","google_place_id":"foobar","landscape_url":null,"landscape_thumbnail_url":null,"portrait_url":null,"portrait_thumbnail_url":null}}}

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/"2b3b8cdf2113465c445755439b0453ee"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d2823fad-caff-4965-83c4-657d2ef05920
X-Runtime: 0.119721
Content-Length: 1118

Status

201 Created

Body

{
  "entourage": {
    "id": 18,
    "uuid": "euKaRPcwAoho",
    "title": "Foobar",
    "group_type": "outing",
    "entourage_type": "contribution",
    "display_category": null,
    "status": "open",
    "public": false,
    "metadata": {
      "ends_at": "2022-06-03T22:00:00.000+02:00",
      "starts_at": "2022-06-03T19:00:00.000+02:00",
      "place_name": "Café la Renaissance",
      "previous_at": null,
      "portrait_url": null,
      "landscape_url": null,
      "street_address": "44 rue de l’Assomption, 75016 Paris, France",
      "display_address": "Café la Renaissance, 44 rue de l’Assomption, 75016 Paris",
      "google_place_id": "foobar",
      "portrait_thumbnail_url": null,
      "landscape_thumbnail_url": null
    },
    "postal_code": null,
    "join_status": "accepted",
    "number_of_unread_messages": 0,
    "number_of_people": 1,
    "created_at": "2022-06-02T17:16:43.344+02:00",
    "updated_at": "2022-06-02T17:16:43.344+02:00",
    "description": null,
    "share_url": "https://app.entourage.social/actions/euKaRPcwAoho",
    "image_url": null,
    "online": false,
    "event_url": null,
    "display_report_prompt": false,
    "author": {
      "id": 49,
      "display_name": "John D.",
      "avatar_url": null,
      "partner": null,
      "partner_role_title": null
    },
    "location": {
      "latitude": 48.854367553785,
      "longitude": 2.27034058909627
    }
  }
}