Skip to main content

directories/{id}

Retrieves details of the structure for the specified directory.

Arguments:

  • api_key (required)
  • id (required

Example request:

http://[domain]/api/directories/2.xml?api_key=[api_key]

Example response:

<?xml version="1.0" encoding="utf-8"?>
<directory id="2" entries="3" public_submission="1">
    <name>d2</name>
    <content><![CDATA[]]></content>
    <categories>
        <category id="20000" name="Category One"/>
    </categories>
    <directoryCategories>
        <directoryCategory id="2" name="Category B"/>
        <directoryCategory id="4" name="Category D"/>
    </directoryCategories>
    <fields>
        <field id="1" name="Care Centre" type="text" mandatory="0"/>
        <field id="2" name="Type of Care" type="text" mandatory="0"/>
        <field id="3" name="Care Centre Contact" type="text" mandatory="0"/>
        <field id="4" name="Care Centre picture" type="text" mandatory="0"/>
        <field id="5" name="Our Address" type="text" mandatory="0"/>
        <field id="6" name="Postcode" type="text" mandatory="0"/>
        <field id="7" name="Web address" type="text" mandatory="0"/>
        <field id="8" name="Telephone number" type="text" mandatory="0"/>
        <field id="9" name="Fax number" type="text" mandatory="0"/>
        <field id="10" name="Email" type="text" mandatory="0"/>
        <field id="11" name="Google Map" type="text" mandatory="0"/>
        <field id="12" name="How to find us" type="text" mandatory="0"/>
        <field id="13" name="NHS" type="text" mandatory="0"/>
        <field id="14" name="Care Centre Grade" type="text" mandatory="0"/>
    </fields>
</directory>