Lessonspace Docs

Am I using the correct identifier for a space?

id, uuid, launch_id,room_id slug... All these terms can be confusing and it is easy to get them mixed up. This article is an explanation of the different terms and where to use each of them appropriately.

To generate a Space, the Launch endpoint requires an id parameter. This id must be unique for an organisation but not necessarily across the whole of Lessonspace. A good id would be some sort of relationship identifying the users of the space, for example english_teacher123. If a name parameter is not passed in when creating the Space, id then becomes the name attribute of the generated Space. If the Space already exists, the details of the existing Space with the corresponding id will be retrieved. The Organisation Session List endpoint makes use of this id as a query parameter where the parameter is launch_id.

The launch endpoint returns a room_id parameter which is a UUID. This becomes the slug attribute of the space object. This same slug attribute is used by the Organisation Session List endpoint as a query parameter where the parameter is space. The space object also has an id attribute which is a UUID. Currently, this is the same as the slug attribute. To avoid errors, it is advised to use the slug attribute instead of the id unless when dealing with the id from the launch endpoint.