Org

<- Voltar ao menu

Org

Org

An org is an entity such as a company or organization.

Attributes

Name	Type	Description	Example
description	nullable string	a description of the org	null
id	integer	unique identifier of the org	42
image	nullable string	an image such as an logo of the org	null
members	nullable array	the members list of the org	null
name	string	the name of the org	"example"
rooms	nullable array	the rooms list of the org	null
user_id	integer	the id of the user that created the org	42

Org List

List of all the current user orgs

GET /org

Curl Example

$ curl -n https://production-room-api.herokuapp.com/org
 -G \
  -d

Response Example

HTTP/1.1 200 OK

null

Org Create

Create a new org

POST /org

Optional Parameters

Name	Type	Description	Example
description	nullable string	a description of the org	null
id	integer	unique identifier of the org	42
image	nullable string	an image such as an logo of the org	null
name	string	the name of the org	"example"
user_id	integer	the id of the user that created the org	42

Curl Example

$ curl -n -X POST https://production-room-api.herokuapp.com/org \
  -d '{
  "id": 42,
  "user_id": 42,
  "name": "example",
  "description": null,
  "image": null
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 201 Created

null

Org Info

Info for existing org.

GET /org/{org_id}

Curl Example

$ curl -n https://production-room-api.herokuapp.com/org/$ORG_ID
 -G \
  -d

Response Example

HTTP/1.1 200 OK

null

Org Add member

It adds the user as a member of the organization

PUT /org/{org_id}/add_member

Optional Parameters

Name	Type	Description	Example
email	email	the email of the user	"[email protected]"
id	integer	unique identifier of the org	42

Curl Example

$ curl -n -X PUT https://production-room-api.herokuapp.com/org/$ORG_ID/add_member \
  -d '{
  "id": 42,
  "email": "[email protected]"
}' \
  -H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK

null