REST Resource%3A Rooms - DRB-IT/blacktiger GitHub Wiki

This endpoint serves information about meeting rooms.

GET /rooms

Returns by default an array of room objects accessible by the current user. Admin users will have access to all active rooms. An ordinary user will typically only be able to access a single room.

###Parameters###

Parameter	Type	Details
mode	string	'meta' or 'full'. Specifies the amount of data to include for each room. Default 'meta'.

Example Response (mode: meta)

[{
    "id": "09991",
    "name": "DK-9000-1 Aalborg, sal 2",
    "contact": {       
        "name": "Michael Stenner"
        "phoneNumber": "+4512345678",
        "email": "[email protected]",
        "comment": "I'll fix it"
    },
    "postalCode": "9000",
    "city": "DK-9000-1 Aalborg",
    "hallNumber": "sal 2",
    "phoneNumber": "+4500000000",
    "countryCallingCode": "45"
}, .... ]

Example Response (mode: full)

[{
    "id": "09991",
    "name": "DK-9000-1 Aalborg, sal 2",
    "contact": {       
        "name": "Michael Stenner"
        "phoneNumber": "+4512345678",
        "email": "[email protected]",
        "comment": "I'll fix it"
    },
    "postalCode": "9000",
    "city": "DK-9000-1 Aalborg",
    "hallNumber": "sal 2",
    "phoneNumber": "+4500000000",
    "countryCallingCode": "45",
    "participants": [
        {
            "callerId": "H45-0000",
            "channel": "SIP__1",
            "muted": false,
            "phoneNumber": "+4522000000",
            "dateJoined": 1349333576093,
            "name": "Testsal",
            "type": "Hall",
            "host": true
        },{
            "callerId":"L00000000",
            "channel":"SIP___L00000000-00000004",
            "muted":true,
            "phoneNumber":"+4599999900",
            "dateJoined":1414353006342,
            "name":"John Does",
            "type":"Sip",
            "host":false
        }
    ]
}, .... ]

GET /rooms/{roomid}

Returns an object describing general data about the meeting room.

Example Response

{
    "id": "09991",
    "name": "DK-9000-1 Aalborg, sal 2",
    "contact": {       
        "name": "Michael Stenner"
        "phoneNumber": "+4512345678",
        "email": "[email protected]",
        "comment": "I'll fix it"
    },
    "postalCode": "9000",
    "city": "DK-9000-1 Aalborg",
    "hallNumber": "sal 2",
    "phoneNumber": "+4500000000",
    "countryCallingCode": "45"
}

POST /rooms/{roomid}

Updates the information about the room. REMARK: Only contact info can be changed. Changes to information about the room will be ignored.

Example Request

{
    "id": "09991",
    "name": "DK-9000-1 Aalborg, sal 2",
    "contact": {       
        "name": "Michael Stenner"
        "phoneNumber": "+4512345678",
        "email": "[email protected]",
        "comment": "I'll fix it"
    },
    "postalCode": "9000",
    "city": "DK-9000-1 Aalborg",
    "hallNumber": "sal 2",
    "phoneNumber": "+4500000000",
    "countryCallingCode": "45"
}