Skip to content
arfelio1980 edited this page Oct 12, 2018 · 20 revisions

The locations feed should contain an array of locations, matching our specification.

  • If new locations are found in the feed, they'll be created in our database and activated.
  • If existing locations change their attributes, they'll be updated in our database.
  • If locations are no longer present in the feed, they will be deactivated in our database.

To see a full example of what we need, have a look at the feed samples of this wikis repository.

Below is an explanation of the attributes.

Mandatory attributes

id [string]

A unique and never changing key that identifies the location, typically a uuid or a database autoincrementing id. We need it to reliably tell locations apart.

kind [string]

The type of location. Can be "office", "warehouse", "store", "business_center", "coworking", "meeting_room", "parking" and "virtual_office". It's important to set this value correctly, as it affects where the location will show up on our website and it affects the kind of leads you'll receive. If it doesn't match any of these, we'll ignore it! :-(

title [string]

The title for the presentation of the location. E.g. "Newly-renovated offices with a great ocean view"

description [string]

The full description of the location. You may use HTML if you do it gracefully, but otherwise plain text with appropriate newlines will do just fine. We'll run it through a markdown processor either way to produce paragraph tags.

address_line_1 [string]

The full street address, e.g. "Lærkevej 54, 2. th"

postal_code [string]

The postal code for the location. You do not need to provide the city/district name - we resolve it automatically based on the postal code.

area [area interval object]

An object describing how much space is available for rent, specified in squaremeters. The object should have a "from" attribute and optionally a "to" attribute, holding a numeric value. If it's possible to rent part of the advertised location, think of "to" as being the entire lease for rent and "from" as being the smallest available section for rent. If, however, it's not possible to rent part of the location, put the same value in both attributes. This field is not mandatory if location kind is "virtual_office" or "parking".

{
  "from": 310,
  "to": 950
}
primary_contact [contact object]

The primary contact for the location. If a client orders information about the location, these contact details will be shared with the client and an e-mail will be sent to the contact with information about the client.

The contact object is described on this wiki page.

parking_type [string]

The type of parking, mandatory only if location kind is "parking". Can be "underground_parking", "outdoor_parking", "parking_house" and "garage".

amount_of_spaces [amount of spaces interval object]

An object describing how many parking lot spaces is available for rent, mandatory only if location kind is "parking". The object should have a "from" attribute and optionally a "to" attribute, holding a numeric value.

monthly_rent_per_space [money interval object]

The monthly rent per space used for location where kind is "parking" or "virtual_office". It mandatory a "from" for "virtual_office" kind attribute and optionally a "to" attribute for both kinds and both holding numeric values.

Optional attributes

photos [array of strings]

A list of urls with photos of the location. Psync will download an encounted image only once, so if you edit an existing photo, Psync won't sync the changes unless you change the url of that image as well, in which case it will remove the old version and add the new version. The order of the urls control the display order on our website, so if you have a particular good photo, put it first and we will use it as the thumbnail whenever we display the location!

Don't worry about scaling, just provide us a sufficiently high resolution image url and we'll handle the rest. We support both JPEG, GIF and PNG images.

floor_plans [array of strings]

Same thing as with photos, except we won't display them anywhere other than the floor plan tab on the location page.

prospectus_url [string]

A url where we can download the prospectus. Like with images, we won't reload a prospectus once we've already downloaded it, but if you change the url, Psync will delete the old prospectus and download the new one. The resource MUST be a pdf-file.

facilities [array of strings]

A list of facilities, features or distinguishing qualities that the location offers. While you can add anything you want from up-to-date list of already approved facilities here: https://www.lokalebasen.dk/lease/api/facilities

Please constrain yourself to less than 10 facilities. While you can add more, it might make your location page appear clunky.

secondary_kinds [array of strings]

A list of additional kinds for location. Can be "office", "warehouse", "store", "business_center", "coworking" and "meeting_room". It's important to set this value correctly, as it affects where the location will show up on our website.

coordinates [coordinates object]

Read more about coordinates here.

yearly_rent_per_m2 [money interval object]

The yearly rent per square meter of space. It should contain a "from" attribute and optionally a "to" attribute, both holding numeric values. The rent is assumed to be specified in official currency used on the site, e.g. DKK.

{
  "from": 900,
  "to": 1100
}
yearly_operational_cost_per_m2 [money interval object]

Self-explanatory. Same format as yearly_rent_per_m2.

yearly_heating_cost_per_m2 [money interval object]

Self-explanatory. Same format as yearly_rent_per_m2.

yearly_water_cost_per_m2 [money interval object]

Self-explanatory. Same format as yearly_rent_per_m2.

yearly_electricity_cost_per_m2 [money interval object]

Self-explanatory. Same format as yearly_rent_per_m2.

energy_rating [string]

The energy rating of the location, it must be one of the following values: ["A", "B", "C", "D", "E", "F", "G"]

exempted_from_energy_rating [boolean]

If the location is exempted from energy rating, you can set this attribute to true. This is useful for buildings that are protected/under conservation. That clients can then see why the energy rating is missing.

provider_website_link [string]

A direct url to the location page on your website. If your terms with Lokalebasen covers it, this link will be shown on your location page alongside your contact details.

parking_prices [string]

The parking prices for location with "parking" kind. In this text field can be additional extended information about parking prices.

parking_opening_hours [string]

The parking prices for location with "parking" kind. In this text field can information about parking opening hours.

workstations_count [workstations count interval object]

Self-explanatory.

{
  "from": 1,
  "to": 10
}
workstation_cost_per_month [workstation cost per month interval object]

Self-explanatory.

{
  "from": 1000,
  "to": 5000
}

That's it!

Send us the URL of a JSON feed containing a list of your locations matching this specification, and we'll set up the rest!

Clone this wiki locally