Skip to main content

XML feed setup & documentation

The specifications on how to implement our XML feed

Jane Osborne avatar
Written by Jane Osborne
Updated over 10 months ago

View the XML documentation below:

As part of the new customer rollout, if a customer opts for the xml feed to power their property search, the Customer Care team will send an email including the xml feed and supporting documentation to the person or company that manages their website.

How to create a new XML feed

  1. Search for Company Name

  2. Click into company account

  3. Go to ‘Modules’ tab at the top

  4. Scroll down to Website XML Feed section

  5. Enabled = Yes

  6. Sub Type = AI - XML Format

  7. Website URL = leave empty

  8. Save Changes

  9. Now when you scroll down to the Website XML Feed section you will see the feed available as a link as below:

  10. This will need to go into the email below:

    It is worth going to Kato and publishing a couple of properties “to website” so that they appear in the feed, otherwise the feed you send them will be empty. Make sure the properties you choose are ones that are already showing on their existing property search page, then there can't be any push back!

Email template Below

Hello,

Please see XML feed from agentsinsight*. You will need this to power the property search page for mutual client [Company Name] [Insert xml feed link]

See documentation below to help you implement this:

Let us know once you have fully implemented this or if you have any questions

12. Once the web guys have confirmed that they have implemented the XML feed, go to the agencies website and onto their property search
13. Click into a property (on their website) that you know is in the XML feed
14. Check that the id in the URL matches the id we send for that property in the XML feed
15. Copy the URL
16. Paste into the Website URL section in AS Admin > Org > Modules
17. Replace the id number with {id}

18. These steps are important to ensure that any links we have in Kato emails that are supposed to link through to the property, go through to the right property on their website. If we don’t do steps 12 - 18 then the links will be dormant.

FAQs
  • How often do we update the XML feed our end?
    Every hour

  • Why are there no breakpoints in my marketing text but I have put them in when in Kato?
    We provide the data in one format to your web team. From there, they choose / set how to format this.

  • Is the file always updated every hour, regardless of whether there are any property changes?
    It is re-generated every hour. You could use the last_updated date on the property element to determine if the property has changed since the last time & thus if it needs to be updated

  • Is there anything like a webhook to tell us the feed has changed, or do we have to poll this?
    We don't have any webhooks or push events for these. You do need to poll for the file. If you do want to do anything smart without loading the content, there is a "last_updated" date that you could use to check if that element has changed rather than processing the entire property element again.

  • Will this XML file contain the full database of live properties?
    Yes all properties are included the XML file.

  • Is there ever any pagination/splitting up of the file?
    There is no pagination.

  • Will there be authentication on this file when it goes live?
    No. The XML file will be publically available.

  • Is there any difference between id and object_id, do they ever differ? i.e. repeated disposals of the same property?
    You should only care about ID - this is unique to each property. The ID & object ID can be different, but you can safely ignore object_id. (we used this to group records together, but this is only for quite advanced integrations).

  • Can you provide some more information on the email parsing for leads/enquiries? Which email address should we send to?
    When a lead comes through the website obviously you'll want to notify the appropriate users at [Company Name] about this. To have these enquires automatically store in Kato, we ask for you to attach the headers as per the Document we sent. This allows us to scrape the html content from the email and make the appropriate matches to properties & store the correct details from the enquiry. We then send emails to anyone assigned to the properties about the enquiry. To set this up please send enquiries to companyname@parse.agents-society.com

  • I can see that my client is able to add descriptions/labels against the videos. In the XML example and the XSD, no label is present. Will this be added?
    We don't have plans at the moment to add descriptions. I'm assuming more requests for this will come our way given the current climate & the desire for videos sky-rocketing. So this could change in due course. If it does we will do our best to make it a non-breaking change.

  • What contacts / agent info can feed through?

    • Joint Agents = external agents attached to a property record, not D2RE agents and will list under this tag in the feed: <joint_agent>

    • Contacts = internal D2RE agents that are working on the property, listed under this tag in the feed: <contacts>. These list in the order that they choose in the Kato UI

    • PA = to us, this is an admin or PA role at D2RE who may be listed against the property to help manage the marketing of the records, but this is not something we pass through into the XML feed. If D2RE are referring to PA as primary agent, then that will be the first person listed under the <contacts> tag

Did this answer your question?