Api::V1::EntouragesController API

Entourages

Create entourage

POST api/v1/entourages

Parameters

Name Description
token token
entourage[group_type] action
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[outcome][success] whether the action was successful or not
entourage[recipient_consent_obtained] Consent is required when creating an action for someone else
entourage[metadata][display_address] Address
entourage[metadata][city] City
entourage[metadata][close_message] A message to post when closing an action

Request

Headers

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

Route

POST api/v1/entourages

Body

{"token":"foobar45","entourage":{"title":"foobar","location":{"latitude":1.122,"longitude":2.345},"entourage_type":"ask_for_help","display_category":"social","description":null,"category":null,"recipient_consent_obtained":true}}

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/"ce5bafa734990e6e4ef0545f0fda729f"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 15bf3096-8872-43b1-b05e-c4835a6727f3
X-Runtime: 0.207773
Content-Length: 717

Status

201 Created

Body

{
  "entourage": {
    "id": 17,
    "uuid": "ePUju0iRSY3M",
    "title": "Foobar",
    "group_type": "action",
    "entourage_type": "ask_for_help",
    "display_category": "social",
    "status": "open",
    "public": false,
    "metadata": {
      "city": "",
      "display_address": ""
    },
    "postal_code": null,
    "join_status": "accepted",
    "number_of_unread_messages": 0,
    "number_of_people": 1,
    "created_at": "2022-06-02T17:16:43.112+02:00",
    "updated_at": "2022-06-02T17:16:43.112+02:00",
    "description": null,
    "share_url": "https://app.entourage.social/actions/ePUju0iRSY3M",
    "image_url": null,
    "online": false,
    "event_url": null,
    "display_report_prompt": false,
    "author": {
      "id": 47,
      "display_name": "John D.",
      "avatar_url": null,
      "partner": null,
      "partner_role_title": null
    },
    "location": {
      "latitude": 1.122,
      "longitude": 2.345
    }
  }
}