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 .jsv suffix or ?format=jsv

HTTP + JSV

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-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	buildingId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}