GET api/Room/Search?name={name}
Return a list of bookable rooms by type (Http Status 200). If something is wrong HTTP Status: 401 = Unauthorized. 500 = Some runtime exeption.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
name |
The beginning of a room name. For example, "?name=E" gives all rooms in house E, "?name=E2" gives all rooms in house E floor 2. Leave empty to retrieve all rooms. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Return a list of bookable rooms by type (Http Status 200). If something is wrong HTTP Status: 401 = Unauthorized. 500 = Some runtime exeption.
Collection of RoomName | Description | Type | Additional information |
---|---|---|---|
Name |
Room number/name. Example: E2406 The structure of the room names is. The first letter is House (E)2406, the second is the floor E(2)406. |
string |
None. |
Description |
Some kind of description of the room. |
string |
None. |
More |
Any extra description of the room or any equipment or similar. |
string |
None. |
Types |
The types that are connected to the room. The name of the type, if there are several they are seperated with (,). |
string |
None. |
Response Formats
application/json, text/json
[ { "Name": "sample string 1", "Description": "sample string 2", "More": "sample string 3", "Types": "sample string 4" }, { "Name": "sample string 1", "Description": "sample string 2", "More": "sample string 3", "Types": "sample string 4" } ]
application/xml, text/xml
<ArrayOfRoom xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JU.API.Room.Models"> <Room> <Description>sample string 2</Description> <More>sample string 3</More> <Name>sample string 1</Name> <Types>sample string 4</Types> </Room> <Room> <Description>sample string 2</Description> <More>sample string 3</More> <Name>sample string 1</Name> <Types>sample string 4</Types> </Room> </ArrayOfRoom>