AbodeONE

<back to all web services

FindRooms

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/rooms
FindRooms Parameters:
NameParameterData TypeRequiredDescription
BuildingIdsqueryArrayOfIntNo
RoomsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<RoomDTO>No
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 .xml suffix or ?format=xml

HTTP + XML

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

POST //rooms HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindRooms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <BuildingIds xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:Int>0</d2p1:Int>
  </BuildingIds>
</FindRooms>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RoomsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <RoomDTO>
      <Assignable>0</Assignable>
      <BuildingId>0</BuildingId>
      <BuildingName>String</BuildingName>
      <Code>String</Code>
      <Comments>String</Comments>
      <DiagramId>0</DiagramId>
      <Gender>String</Gender>
      <Rate>0</Rate>
      <Room>String</Room>
      <RoomId>0</RoomId>
      <RoomType>String</RoomType>
      <RoomTypeId>0</RoomTypeId>
      <WingId>0</WingId>
      <WingName>String</WingName>
    </RoomDTO>
  </Result>
</RoomsResponse>