AbodeONE

<back to all web services

GetBuilding

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/building
GetBuilding Parameters:
NameParameterData TypeRequiredDescription
BuildingIdqueryintNo
BuildingResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformBuildingDTONo
ResponseStatusformResponseStatusNo
BuildingDTO Parameters:
NameParameterData TypeRequiredDescription
BuildingIdformintNo
NameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
PostalformstringNo
FloorsformstringNo
GenderformstringNo
CodeformstringNo
ActiveformboolNo
SiteIdformintNo
AllowLeavesformboolNo
PreapproveLeavesformboolNo
EmailFromAddrformstringNo
EmailReplyAddrformstringNo
EmailFromNameformstringNo
DefaultRoomCheckformTimeSpan?No

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 //building HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetBuilding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <BuildingId>0</BuildingId>
</GetBuilding>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BuildingResponse 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>
    <Active>false</Active>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <AllowLeaves>false</AllowLeaves>
    <BuildingId>0</BuildingId>
    <City>String</City>
    <Code>String</Code>
    <DefaultRoomCheck>PT0S</DefaultRoomCheck>
    <EmailFromAddr>String</EmailFromAddr>
    <EmailFromName>String</EmailFromName>
    <EmailReplyAddr>String</EmailReplyAddr>
    <Floors>String</Floors>
    <Gender>String</Gender>
    <Name>String</Name>
    <Postal>String</Postal>
    <PreapproveLeaves>false</PreapproveLeaves>
    <SiteId>0</SiteId>
    <State>String</State>
  </Result>
</BuildingResponse>