January 2019

Changes to the API since beginning of December 2018.

Fixed

• PublicationStatus.isVisible is now correct also for project units.
  • Project units appeared as not visible, despite being approved and published. Now they are correctly marked as visible.
• PublicationStatus.hemnetURL could sometimes lead to a "Listing has been removed" page.
  • See the new PublicationStatus.isRemovedBeforeShowing field.
• Some invalid Money and housing form inputs could cause a 500 Internal Server Error rather than a proper 422 Unprocessable Entity response. They should now give back proper validation error messages instead.
  • Thank you to those that reported these issues!

Added

• Leads got two new fields:
  • firstName, which is a deprecated field for the first name part of the full name.
  • lastName, which is a deprecated field for the last name part of the full name.
  • These deprecated fields will continue to work at least until the next version of the API.
• customAreaName was added on Listing, Project, and ProjectUnit.
  • This can be used to show a more fine-grained location name for a listing, even when the location itself isn't an official state-recognized location but still common or recognized among locals.
• PublicationStatus got two new fields:
  • isSearchable - If the record can be found in searches on Hemnet.
  • isRemovedBeforeShowing - If the record is kept searchable for a little longer after being unpublished before a showing. This is not a new state on Hemnet, but it is the first time a broker system is able to detect when it happens. See the field for more information.
• ErrorDocument now contains the request ID.
• The X-Request-Id response header is now documented in the API specification.

Changed

• Clarified wording in "Deprecation" section of API documentation.
  • It used to say that deprecated fields "will be removed" in the next version, but that's not guaranteed. Now it says "may be removed".
• Migration guide: omrade from the old API is no longer deprecated. customAreaName is the new name for this field.
• PublicationStatus documentation was expanded a lot. It should be much easier to understand how the different states relate to each other and what you are able to control yourself.
• If a listing/project/project unit falls under the isRemovedBeforeShowing state, it is no longer shown as isPublished or isVisible.