AbodeONE

<back to all web services

FindBuildings

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/buildings
FindBuildings Parameters:
NameParameterData TypeRequiredDescription
IsActivequerybool?No
BuildingsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<BuildingDTO>No
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST //buildings HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"isActive":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":[{"buildingId":0,"name":"String","address1":"String","address2":"String","city":"String","state":"String","postal":"String","floors":"String","gender":"String","code":"String","active":false,"siteId":0,"allowLeaves":false,"preapproveLeaves":false,"emailFromAddr":"String","emailReplyAddr":"String","emailFromName":"String","defaultRoomCheck":"PT0S"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}