AbodeONE

<back to all web services

GetRoom

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/room
GetRoom Parameters:
NameParameterData TypeRequiredDescription
RoomIdqueryintNo
RoomResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformRoomDTONo
ResponseStatusformResponseStatusNo
RoomDTO Parameters:
NameParameterData TypeRequiredDescription
RoomIdformintNo
WingIdformintNo
RoomformstringNo
CodeformstringNo
GenderformstringNo
AssignableformshortNo
Rateformdecimal?No
CommentsformstringNo
DiagramIdformint?No
RoomTypeformstringNo
RoomTypeIdformint?No
BuildingIdformintNo
BuildingNameformstringNo
WingNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /room HTTP/1.1 
Host: api.oau.abodehms.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"roomId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"roomId":0,"wingId":0,"room":"String","code":"String","gender":"String","assignable":0,"rate":0,"comments":"String","diagramId":0,"roomType":"String","roomTypeId":0,"buildingId":0,"buildingName":"String","wingName":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}