Read

Read rooms

POST https://event.talque.com/api/v1/room/read

This endpoint allows you to load multiple room records in a single request.

Request Body

Name	Type	Description
roomIdList*	array	List of room ids
orgId*	string	Unique identifier of the organization

200 Rooms successfully retrieved.

{
    "orgId":"RVZA0drygVK5NbrZuQnB",
    "reason":"SUCCESS",
    "reasonEnum":"RoomReadReason",
    "roomById":{
        "LwigI249nA0THrXyFX7I":{
            "model":{
                "capacity":99,
                "color":"#123abc",
                "mtime":1502884800000,
                "name":{
                    "DE_DE":"Hilbertraum \u00e4\u00f6\u00fc\u00df",
                    "EN_US":"Hilbertspace \u00e4\u00f6\u00fc\u00df"
                },
                "order":2,
                "roomId":"LwigI249nA0THrXyFX7I"
            },
            "reason":"SUCCESS",
            "success":true
        }
    },
    "success":true
}

404 Could not find a room matching this query. Note that the request status is actually 200, the failure of returning a room is in the per-room reason field.

{
    "orgId":"RVZA0drygVK5NbrZuQnB",
    "reason":"SUCCESS",
    "reasonEnum":"RoomReadReason",
    "roomById":{
        "HLIC20uvsrivzlrhwJlj":{
            "model":null,
            "reason":"NOT_FOUND",
            "success":false
        }
    },
    "success":true
}

Example Request

{ 
    "orgId": "qRY08MFxsIo97DecfEPk",
    "roomIdList": ["DTa0z30HX5SKmdQDVZpy"] 
}

Example Response

{
  "roomById": {
    "DTa0z30HX5SKmdQDVZpy": {
      "model": {
        "capacity": 35,
        "name": {
          "DE_DE": "Workshop Studio - Berlin",
          "EN_US": "Workshop Studio - Berlin"
        },
        "mtime": 1675864611589,
        "color": "#ced2d3",
        "roomId": "DTa0z30HX5SKmdQDVZpy",
        "order": 4,
        "extId": null
      },
      "reason": "SUCCESS",
      "success": true
    }
  },
  "reason": "SUCCESS",
  "orgId": "qRY08MFxsIo97DecfEPk",
  "success": true,
  "reasonEnum": "RoomReadReason"
}