Groups /environment/groups

The groups at which is attached the current person.

Reading

GET /environment/groups HTTP/1.1
Host: localhost:3000

Permissions

  • The applied permissions to retrieve the parent environment are required.

Fields

An array of Group objects attached to the current person and whose its retrieve permissions are granted.

Publishing

POST /environment/groups HTTP/1.1
Host: localhost:3000

Permissions

  • An access token (pointing to an user) with publish_groups permission is required.

Fields

Name Description Type

name

The name of the group.

string

avatar

The ID of the Photo that represents the avatar of the group.
Must be a photo owned by the current person whose its tmp field is set to true.

string

notes

Notes about the group.

string

custom_fields

Custom fields attached to the group.

object

tags

An array of Tag IDs at which is attached the group.

string[]

privacy

The privacy of the group.

string{PUBLIC, PRIVATE, HIDDEN}

Response

If successful :

{
    "success" : true,
    "_id" : "..."
}

Otherwise a relevant error message will be returned.

Updating

You can update groups by using the /group edge.

Deleting

You can delete groups by using the /group edge.