API for portals

# Featured Housing Providers

Info

This endpoints are only available for Keaze Marketplace Portal

Featured housing providers are premium clients that have a micro site in the Keaze Marketplace portal.

To get the list of all of them, send a GET to /api/rest/portal/featured-housing-providers

# Response

Every element in the collection is an object with the following structure:

Field name Type Nullable Description
id number false Housing provider reference id in the database
name string false Housing provider name
slug string false Unique slug for the housing provider
logoUrl string true Url of the housing provider logo
logoSmallUrl string true Url of a small version of the housing provider logo

Example

{
    "data": [
        {
            "id": 13,
            "name": "Aster",
            "slug": "aster",
            "logoUrl": "https://static.propertybooking.co.uk/assets/housing-providers/13/logo.jpg",
            "logoSmallUrl": "https://static.propertybooking.co.uk/assets/housing-providers/13/Aster.jpg"
        },
        {
            "id": 18,
            "name": "Clarion",
            "slug": "clarion",
            "logoUrl": "https://static.propertybooking.co.uk/assets/housing-providers/18/logo.jpg",
            "logoSmallUrl": "https://static.propertybooking.co.uk/assets/housing-providers/18/Clarionsmall.png"
        },
        ...
    ]
}

# Housing provider micro site

To get the details for the micro site of an specific housing provider send a GET to /api/rest/portal/featured-housing-providers/{id} or to /api/rest/portal/featured-housing-providers/slug/{housing-provider-slug} if you use friendly urls and don't expose the id of the housing providers, but their slug.

# Response

The response will contain the housing provider micro site details

Field name Type Nullable Description
id number false Housing provider reference id in the database
name string false Housing provider name
slug string false Unique slug for the housing provider
logoUrl string true Url of the housing provider logo
logoSmallUrl string true Url of a small version of the housing provider logo
heroImageUrl string true Url of the hero or banner image
headline string true Headline
htmlInfo string true Main info of the micro site in html format
videoTitle string true Title of the video
videoUrl string true Url of the video
videoEmbedCode string true When video requires a specific video embed code. The value, when not null, will contain the iframe tag
titleTag string true Customized title tag if any
metaDescription string true Customized meta description if any
metaKeywords string true Customized meta keywords if any
socialTitle string true Customized twitter and facebook title if any
socialDescription string true Customized twitter and facebook description if any
featuredListings array true Collection of featured listings to display. Every item is an object using with the listing details, using the same object structure as the ones returned by the search.

Example

{
    "id": 7,
    "name": "Moat",
    "slug": "moat",
    "logoUrl": "https://static.propertybooking.co.uk/assets/housing-providers/7/logo.png",
    "logoSmallUrl": "https://static.propertybooking.co.uk/assets/housing-providers/7/Moat_Homes_Small_new_logo.jpg",
    "heroImageUrl": "https://static.propertybooking.co.uk/assets/housing-providers/7/profile-banners/screenshot-2020-08-07-at-150424.png",
    "headline": null,
    "htmlInfo": "<p><strong><span style=\"text-decoration: underline;\">About us</span></strong></p>\n<p>Moat is a leading housing association, owning and managing over 20,000 homes in the South East. We are proud to provide high quality, affordable homes across a range of tenures for people in the South East of England.</p>\n<p>We are incredibly proud to be:</p>\n<p>&bull; An experienced and compassionate landlord in our communities<br />&bull; Dedicated to building strong relationships with the local authorities in the areas we work in<br />&bull; One of the Homes England delivery partners, developing around 600 new homes every year<br />&bull; Financially strong, allowing us to deliver excellent services to our customers and build new homes<br />&bull; An expert in providing shared ownership</p>",
    "videoTitle": "What is Shared Ownership?",
    "videoUrl": "https://youtu.be/5-x2h_O9U28",
    "videoEmbedCode": "<iframe src=\"https://www.youtube.com/embed/5-x2h_O9U28\" class=\"embed-responsive-item\" frameborder=\"0\" allow=\"accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>",
    "titleTag": null,
    "metaDescription": null,
    "metaKeywords": null,
    "socialTitle": null,
    "socialDescription": null,
    "featuredListings": [...]
}

← Content pages →