World¶

Resource description¶

The world resource contains the following public fields:

Field	Type	Description
id	string	The world’s ID
title	string	A title for the world
config	object	Various configuration properties
permission_config	object	Permission rules mapping permission keys to lists of traits
domain	string	The FQDN of this world

Endpoints¶

GET /api/v1/worlds/(world_id)/¶

Returns the representation of the selected world.

Example request:

GET /api/v1/worlds/sample/ HTTP/1.1
Accept: application/json, text/javascript

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "id": "sample",
  "title": "Unsere tolle Online-Konferenz",
  "config": {},
  "permission_config": {
      "world.update": ["admin"],
      "world.secrets": ["admin", "api"],
      "world.announce": ["admin"],
      "world.api": ["admin", "api"],
      "room.create": ["admin"],
      "room.announce": ["admin"],
      "room.update": ["admin"],
      "room.delete": ["admin"],
      "chat.moderate": ["admin"],
  },
  "domain": "sample.venueless.events"
}

Status Codes

200 OK – no error
401 Unauthorized – Authentication failure
403 Forbidden – The world does not exist or you have no permission to view it.

PATCH /api/v1/worlds/(world_id)/¶

Updates a world

Example request:

PATCH /api/v1/worlds/sample/ HTTP/1.1
Accept: application/json, text/javascript
Content-Type: application/json

{
  "title": "Happy World"
}

Example response:

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json

{
  "id": "sample",
  "title": "Happy World",
  "config": {},
  "permission_config": {
      "world.update": ["admin"],
      "world.secrets": ["admin", "api"],
      "world.announce": ["admin"],
      "world.api": ["admin", "api"],
      "room.create": ["admin"],
      "room.announce": ["admin"],
      "room.update": ["admin"],
      "room.delete": ["admin"],
      "chat.moderate": ["admin"],
  },
  "domain": "sample.venueless.events"
}

Status Codes

200 OK – no error
400 Bad Request – The world could not be updated due to invalid submitted data.
401 Unauthorized – Authentication failure
403 Forbidden – The requested organizer/event does not exist or you have no permission to create this resource.

POST /api/v1/worlds/(world_id)/delete_user¶

Deletes a given user by ID. You can either supply a user_id with Venueless’ internal ID value, or a token_id with the ID from a JWT authorization.

Example request:

POST /api/v1/worlds/sample/delete_user HTTP/1.1
Accept: application/json, text/javascript
Content-Type: application/json

{
  "user_id": "bbd1f53f-5340-4ba9-a9ff-ea5b843aa602"
}

Example response:

HTTP/1.1 204 OK