Wednesday, 16 June, 2010

API: Get Building Details

In this post we'll take a closer look at one of the simplest Space Database API services: 'Get Building Details' API. This service will return a set of building details in response to a building ID. We have built an extensive API support section on our site that will allow developers to easily understand our API functions, data structure and get sample code. The interface provides 'previews' of what the data looks like.

The data returned is available in XML format as well as JSON. These are the two most popular methods for serving up data across the web.

We provide some simple code examples to let developers turn this:

Into this:

Or this:



Here's a list of the data fields and the information that you can retrieve from this service:
<BUILDINGID/>Automatically generated integer to uniquely identify the building.
<BUILDINGNAME/>The name of the building. Very often this is the same as the street address.
<DBLMAXFLOORAREA/>The rentable floor area of the largest floor in the building.
<TOTALAREA/>The total rentable area of the building.
<TOTALNUMOFFLOORS/>Total number of floors in the building.
<STREET/>The full street address of the building.
<CITY/>The municipality where the building is located.
<PROVINCE/>The province or state where the building is located.
<POSTALCODE/>Postal code or zip coded of the building address.
<REGION/>The region name is a grouping name selected by the client company
<COUNTRY/>The name of the country where the building is located.
<LATITUDE/>The latitude of the buildings location. Expressed as decimal degrees
<LONGITUDE/>The longitude of the buildings location. Expressed as decimal degrees
<DESCRIPTION/>A description of the the building. May contain simple html tags to format the text.
<AMENITIES/>A description of the amenities in the building. May contain simple html tags to format the text.
<PHOTOS/>Text for embedded photo widgets. This field can contain code - for embeded widgets etc. If this field is empty, output URL to picture - see below. If there is no code stored in the database, then this field will return a variable number of URLs for building photos.
<LEASINGCONTACTS/>Contact information for leasing. A text field that may have simple html tags such as headings, email hrefs and list items.
<EXTERNALLINKS/>Links related to the building such as websites for owners or brokers. A block of simple html code including list items and href links.
<SKINURL/>A url to the location of the css and logo images for this building.

There's more to come. I'll cover other API services and functions in future posts!

0 comments:

Post a Comment