End points

Various resource types exist within the MyJadu API from the various modules that make up the Jadu Universe platform. Each resource type has its own set of available methods exposing functionality via the API that shall be discussed in turn in the next section of this document.

To check the the supported resources on the site, please check the resources matrix.

categories/all

Retrieves the bespoke category list structures as defined within the Jadu Category Builder.

Arguments

  • api_key (required)

Example request:

http://{domain}/api/categories/all.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<categories>
      <category id="100001" name="Benefits and Council Tax"
        narrower_items="0" broader_items=“0" />
      <category id="200008" name="Benefits" narrower_items="0"
        broader_items="1">
            <broaderItem category_id="100001"/>
      </category>
      <category id="726" name="Benefits - fraud" narrower_items="0"
        broader_items="1">
            <broaderItem category_id="200008"/>
      </category>
      <category id="500180" name="Housing Benefit" narrower_items="0"
        broader_items="1">
            <broaderItem category_id="200008"/>
      </category>
</categories>

categories/{id}/children

Retrieves all of the immediate child categories for the specified parent category id, as defined within the Jadu Category Builder.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/categories/100001/children.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<categories child="100001">
      <category id="200007" name="Asylum and immigration">
            <broaderItem category_id="100001"/>
            <broaderItem category_id="100003"/>
            <broaderItem category_id="100010"/>
      </category>
      <category id="200008" name="Benefits">
            <broaderItem category_id="100001"/>
            <broaderItem category_id="100004"/>
            <broaderItem category_id="100007"/>
            <broaderItem category_id="100008"/>
      </category>
</categories>

categories/{id}/parents

Retrieves all of the parent categories for the specified child category id.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/categories/354/parents.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<categories parent="354">
      <category id="200033" name="Councillors, democracy and elections">
            <broaderItem category_id="100004"/>
      </category>
      <category id="200100" name="Unitary authorities">
            <broaderItem category_id="100004"/>
      </category>
</categories>

categories/{id}/category

Retrieves the details of a single specified category id.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/categories/20005/category.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<category id="20005" name="Subcategory 1.1" narrower_items="0"
  broader_items="1">
      <broaderItem category_id="20000"/>
</category>

categories/categories?{ids=1,2,3}

Retrieves the details of multiple categories as defined by the comma separated list of category identifies.

Arguments:

  • api_key (required)
  • ids (required)

Example request:

http://{domain}/api/categories/categories.xml?api_key={api_key}
  &ids=20009,20005,20030

Example response:

<?xml version="1.0" encoding="utf-8"?>
<categories>
      <category id="20009" name="Subcategory 2.2"
        narrower_items="0" broader_items="1">
            <broaderItem category_id="20001"/>
      </category>
      <category id="20005" name="Subcategory 1.1"
        narrower_items="0" broader_items="1">
            <broaderItem category_id="20000"/>
      </category>
      <category id="20030" name="Subcategory 3.1.1"
        narrower_items="0" broader_items="1">
            <broaderItem category_id="20027"/>
      </category>
</categories>

categories/top

Retrieve details of all top level categories only.

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/categories/top.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<categories>
      <category id="20000" name="Category One"
        narrower_items="3" broader_items="0"/>
      <category id="20001" name="Category Two"
        narrower_items="3" broader_items="0"/>
      <category id="20002" name="Category Three"
        narrower_items="5" broader_items="0"/>
      <category id="20003" name="Category Four"
        narrower_items="0" broader_items="0"/>
      <category id="20004" name="Category Five"
        narrower_items="0" broader_items="0"/>
      <category id="20037" name="Another Cat"
        narrower_items="0" broader_items="0"/>
</categories>

committees/all

Retrieves all committees as defined within the Jadu eGov module.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/committees/all.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<committees page="1" pages="1" per_page="10" total="2">
      <committee id="2">
            <title>My second committee</title>
            <isArchived>0</isArchived>
      </committee>
      <committee id="1">
            <title>My first committee</title>
            <isArchived>0</isArchived>
      </committee>
</committees>

committees/{id}

Retrieves the details for a single committee record.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/committees/1.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<committee id="1">
      <title>Main Leaders committee</title>
      <isArchived>0</isArchived>
</committee>

committees/committees?{ids=1,2,3}

Retrieves the details of multiple committees as defined by the comma separated list of committee identifiers.

Arguments:

  • api_key (required)
  • ids (required)

Example request:

http://{domain}/api/committees/committees.xml?api_key={api_key}&ids=1,2

Example response:

<?xml version="1.0" encoding="utf-8"?>
<committees>
      <committee id="1">
            <title>My first committee</title>
            <isArchived>0</isArchived>
      </committee>
      <committee id="2">
            <title>My second committee</title>
            <isArchived>0</isArchived>
      </committee>
</committees>

councillors/all

Retrieves the details for all councillors.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/councillors/all.xml?api_key={api_key}&per_page=2&page=3

Example response:

<?xml version="1.0" encoding="utf-8"?>
<councillors page="3" pages="48" per_page="2" total="96">
      <councillor id="261">
          <name>Nasrin Ali</name>
          <address>Majority Members Services, MANCHESTER, M60 2LA</address>
          <telephone>07777 777 777</telephone>
          <email>email1@mysite.gov.uk</email>
          <party>Labour</party>
          <imageURL>http://mysite.co.uk/2012-190x190.jpg</imageURL>
          <ward>Levenshulme</ward>
          <position>None</position>
      </councillor>
      <councillor id="128">
          <name>Sameem Ali</name>
          <address>Majority Members Services, MANCHESTER, M60 2LA</address>
          <telephone>07777 777 777</telephone>
          <email>email2@mysite.gov.uk</email>
          <party>Labour</party>
          <imageURL>http://mysite.co.uk/images/one.jpg</imageURL>
          <ward>Moss Side</ward>
          <position>None</position>
      </councillor>
<!/councillors>

councillors/councillorsforward

Retrieves the details for all councillors within a specified ward / location.

Arguments:

  • api_key (required)
  • wardID (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/councillors/councillorsforward.xml?
  api_key={api_key}&wardID=2&per_page=2&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<councillors page="1" pages="2" per_page="2" total="3">
      <councillor id="42">
            <name>Susan Cooley</name>
            <address>43 Example Road, MANCHESTER, M23 2XS</address>
            <telephone>0161 000 0000</telephone>
            <email>cllr.s.cooley@mysite.gov.uk </email>
            <party>Labour</party>
            <imageURL>http://mysite.co.uk/images/one.jpg</imageURL>
            <ward>Brooklands</ward>
            <position>None</position>
      </councillor>
      <councillor id="40">
            <name>Glynn Evans</name>
            <address>38 Example Road, MANCHESTER, M23 9EK</address>
            <telephone>0161 000 0000</telephone>
            <email>cllr.g.evans@mysite.gov.uk</email>
            <party>Labour</party>
            <imageURL>http://mysite.co.uk/images/one.jpg</imageURL>
            <ward>Brooklands</ward>
            <position>None</position>
      </councillor>
</councillors>

councillors/allcouncillorsforparty

Retrieves the details for all councillors of a specified political party.

Arguments:

  • api_key (required)
  • partyID (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/councillors/councillorsforparty.xml?
  api_key={api_key}&partyID=2&per_page=1&page=70

Example response:

<?xml version="1.0" encoding="utf-8"?>
<councillors page="70" pages="86" per_page="1" total="86">
      <councillor id="232">
            <name>Suzannah Reeves</name>
            <address>8 Example Grove, MANCHESTER, M20 3AA</address>
            <telephone>07535 000 000</telephone>
            <email>cllr.s.reeves@mysite.gov.uk</email>
            <party>Labour</party>
            <imageURL>http://mysite.co.uk/images/one.jpg</imageURL>
            <ward>Old Moat</ward>
            <position>None</position>
      </councillor>
</councillors>

councillors/allcouncillorsforwardandparty

Retrieves the details for all councillors of a specified political party, in a particular ward / location.

Arguments:

  • api_key (required)
  • partyID (required)
  • wardID (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/councillors/councillorsforwardandparty.xml?
  api_key={api_key}&partyID=2&wardID=1&per_page=1&page=2

Example response:

<councillors page="2" pages="3" per_page="1" total="3">
      <councillor id="78">
            <name>Harold Lyons</name>
            <address>9 Example Avenue, Manchester, M8 5HH</address>
            <telephone>0161 000 000</telephone>
            <email>cllr.h.lyons@mysite.gov.uk</email>
            <party>Labour</party>
            <imageURL>http://mysite.co.uk/images/one.jpg</imageURL>
            <ward>Higher Blackley</ward>
            <position>None</position>
      </councillor>
</councillors>

directories/all

Retrieves a paginated list of all the directories available and their details.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/directories/all.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<directories page="1" pages="1" per_page="10" total="1">
      <directory id="1" entries="3" public_submission="1">
            <name>My directory</name>
            <content><![CDATA[Content With XHTML embedded.]]></content>
            <categories>
                  <category id="17" name="Category one"/>
            </categories>
      </directory>
</directories>

directories/category/{category_id}

Retrieves a paginated list of all the directories assigned to a particular category.

Arguments:

  • api_key (required)
  • category_id (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/directories/category/17.xml?api_key={api_key}
  &per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<directories category_id="17" page="1" pages="1" per_page="10" total="1">
      <directory id="1" entries="3" public_submission="1">
            <name>My directory</name>
            <content><![CDATA[Content With XHTML embedded.]]></content>
            <categories>
                  <category id="17" name="Category one"/>
            </categories>
      </directory>
</directories>

directories/{id}/fields

Retrieves all of the fields of data that make up a directory record within the specified directory.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/directories/1/fields.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<fields directory_id="1">
      <field id="1" name="Textbox" type="text" mandatory="0"/>
      <field id="2" name="Textarea" type="textarea" mandatory="0"/>
      <field id="3" name="Selectbox" type="select" mandatory="0"/>
      <field id="4" name="Image" type="image" mandatory="0"/>
      <field id="5" name="Radio buttons" type="radio" mandatory="0"/>
      <field id="6" name="Location" type="map" mandatory="0"/>
</fields>

directories/{id}/entries

Retrieves all of the entries / records for the specified directory.

Arguments:

  • api_key (required)
  • id (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/directories/1/entries.xml?api_key={api_key}
  &per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<entries directory_id="1" page="1" pages="1" per_page="10" total="2">
      <entry id="3">
            <title>My house</title>
            <date></date>
            <fields>
                  <field id="1" name="Textbox" type="text">
                    Test
                  </field>
                  <field id="2" name="Textarea" type="textarea">
                    Text
                  </field>
                  <field id="3" name="Selectbox" type="select">
                    Value 1
                  </field>
                  <field id="4" name="Image" type="image">
                    http://mysite.co.uk/images/one.gif
                  </field>
                  <field id="5" name="Radio buttons" type="radio">
                    Value 2
                  </field>
                  <field id="6" name="Location" type="map">
                    52.884600942258906,-2.4169921875
                  </field>
            </fields>
      </entry>
</entries>

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>

directories/entry/{id}

Retrieves the data associated within a single specified record from a directory.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/directories/entry.xml?api_key={api_key}&directory_entry_id=3

Example response:

<?xml version="1.0" encoding="utf-8"?>
<entry id="3">
      <title>Fir Trees</title>
      <date>1357917079</date>
      <fields>
            <field id="1" name="Care Centre" type="text" displayTitle="true">
                Fir Trees
            </field>
            <field id="2" name="Type" type="text" displayTitle="true">
                Residential
            </field>
            <field id="3" name="Manager" type="text" displayTitle="true">
                Anne Dobson
            </field>
            <field id="4" name="Picture" type="text" displayTitle="true">
                worsborough-2.jpg
            </field>
            <field id="5" name="Our Address" type="text" displayTitle="true">
                Gorse Hall Road Dukinfield
            </field>
            <field id="6" name="Postcode" type="text" displayTitle="true">
              EG16 5HN
            </field>
            <field id="7" name="Web address" type="text" displayTitle="true">
              http://www.mysite.co.uk/firtrees
            </field>
            <field id="8" name="Telephone" type="text" displayTitle="true">
                0161 000 0000
            </field>
            <field id="9" name="Fax number" type="text" displayTitle="true">
                0161 000 0001
            </field>
            <field id="10" name="Email" type="text" displayTitle="true">
              marketing@example.com
            </field>
            <field id="11" name="Google Map" type="text" displayTitle="true">
                53.475301619861355,-2.0665104396175593
            </field>
            <field id="12" name="Location" type="text" displayTitle="true">
              How to find us
            </field>
            <field id="13" name="NHS" type="text" displayTitle="true">
              No
            </field>
            <field id="14" name="Grade" type="text" displayTitle="true">
              B
            </field>
      </fields>
</entry>

directories/search

Retrieves all directory records / entries that match the specified search criteria within the specified directory.

Arguments:

  • api_key (required)
  • id (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • query (optional)
  • postcode (optional) or lat/long (optional) note: Lat/long & postcode are mutually exclusive distance (optional)

Example requests:

http://{domain}/api/directories/3/search.xml?api_key={api_key}
  &query=test&postcode=LE19&distance=7&per_page=1&page=2

http://{domain}/api/directories/3/search.xml?api_key={api_key}
  &query=test&distance=7&per_page=1&page=2&lat=52.627150034225096
  &long=-1.1221504211425781

Example response:

<?xml version="1.0" encoding="utf-8"?>
<entries page="2" pages="2" per_page="1" total="2">
      <origin lat="52.595156" long="-1.203261"/>
      <entry id="6">
            <title>record 3</title>
            <date>1359899378</date>
            <fields>
                  <field id="15" name="One" type="text" displayTitle="true">
                    Test Field 2
                  </field>
                  <field id="16" name="Two" type="text" displayTitle="true">
                    Test Field 3
                  </field>
                  <field id="17" name="Three" type="text" displayTitle="true">
                    Test Field 1
                  </field>
                  <field id="18" name="Four" type="map" displayTitle="true">
                    52.627150034225096,-1.1221504211425781
                  </field>
            </fields>
      </entry>
</entries>

documents/all

Retrieves a paginated list of all the documents that are live and approved within the Platform.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)

Example request:

http://{domain}/api/documents/all.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<documents page="1" pages="162" per_page="10" total="1618">
      <document id="66" pages="1" visible="true">
            <title>Councils in Greater Manchester</title>
            <date>1263480553</date>
            <categories>
                  <category id="100004" name="Category one"/>
            </categories>
      </document>
      <document id="67" pages="4" visible="true">
            <title>Comments, compliments and complaints</title>
            <date>1300201434</date>
            <categories>
                  <category id="200025" name="Category one"/>
            </categories>
      </document>
      <document id="69" pages="1" visible="true">
            <title>How to use this website</title>
            <date>1283353336</date>
            <categories>
                  <category id="200116" name="Category one"/>
            </categories>
      </document>
</documents>

documents/category/{category_id}

Retrieves all the documents within a specified category.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • category_id (required)

Example request:

http://{domain}/api/documents/category/21.xml?api_key={api_key}
    &per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<documents category_id="21" page="1" pages="1" per_page="10" total="1">
      <document id="1" pages="2" requires_password="true">
            <title>Document</title>
            <date>1227625251</date>
            <categories>
                  <category id="21" name="Category one"/>
            </categories>
    </document>
</documents>

documents/{document_id}/pages

Retrieves all the pages defined within a specified document within the Platform. If a document had the insufficient_privileges attribute set as true then you will not be able to retrieve the pages for the document. Similarly if the requires_password attribute is set as true then you will need to provide the correct password argument.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • document_id (required)
  • password (required depending on document access restrictions)

Example request:

http://{domain}/api/documents/2/pages.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<pages document_id="2344" page="1" pages="1" per_page="10" total="3">
      <page id="8544" page_number="1">
            <title>Longsight Ward Co-ordination</title>
            <image>http://mysite.co.uk/images/image.jpg</image>
            <date>1235998197</date>
            <content><![CDATA[First page of content here.]]></content>
      </page>
      <page id="14183" page_number="2">
            <title>Longsight Ward Map</title>
            <image></image>
            <date>1227170511</date>
            <content><![CDATA[Second page of content here.]]></content>
      </page>
</pages>

documents/documents?{ids=1,2,3}

Retrieves the details of multiple documents as defined by the comma separated list of document identifiers.

Arguments:

  • api_key (required)
  • ids (required)

Example request:

http://{domain}/api/documents/documents.xml?api_key={api_key}&ids=1,2

Example response:

<?xml version="1.0" encoding="utf-8"?>
<documents>
      <document id="1" pages="1" visible="true">
            <title>New Document</title>
            <date>1357232282</date>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </document>
      <document id="2" pages="1" visible="true">
            <title>fb32889 </title>
            <date>1357748245</date>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </document>
</documents>

documents/{id}/document

Retrieves the details for a single specified document.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/documents/2/document.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<document id="2" pages="1" visible="true">
      <title>fb32889 </title>
      <date>1357748245</date>
      <categories>
            <category id="20000" name="Category One"/>
      </categories>
<!/document>

downloads/all

Retrieves a list of all the downloads that are live and approved within the Platform.

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/downloads/all.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<downloads page="1" pages="1" per_page="10" total="4" order_by="">
      <download id="4">
            <title>Galaxy nebulae</title>
            <date>1359711565</date>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
            <file id="5" title="Galaxy nebulae image" size="52138"
              filename="one.png" modDate="1359711565"/>
      </download>
      <download id="5">
            <title>Caldwell 12 - Fireworks</title>
            <date>1359711719</date>
            <categories>
                  <category id="20001" name="Category Two"/>
            </categories>
            <file id="6" title="Caldwell 12 - Fireworks image" size="73341"
              filename="one.png" modDate="1359711719"/>
      </download>
      <download id="6">
            <title>Andromeda</title>
            <date>1359711819</date>
            <categories>
                  <category id="20002" name="Category Three"/>
            </categories>
            <file id="7" title="Andromeda image" size="70592"
              filename="one.png" modDate="1359711814"/>
      </download>
      <download id="7">
            <title>Jadu</title>
            <date>1359712886</date>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
            <file id="8" title="Jadu image" size="58679"
              filename="one.png" modDate="1359712879"/>
      </download>
</downloads>

downloads/category/{category_id}

Retrieves a paginated list of all Downloads within a specified category.

Arguments:

  • api_key (required)
  • category_id (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • order_by (optional - default none)

Example request:

http://{domain}/api/downloads/category/20000.xml?api_key={api_key}
  &per_page=1&order_by=id

Example response:

<?xml version="1.0" encoding="utf-8"?>
<downloads category_id="20000" page="1" pages="1"
  per_page="10" total="2" order_by="">
      <download id="4">
            <title>Galaxy nebulae</title>
            <date>1359711565</date>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
            <file id="5" title="Galaxy nebulae image" size="52138"
              filename="one.png" modDate="1359711565"/>
      </download>
      <download id="7">
            <title>Jadu</title>
            <date>1359712886</date>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
            <file id="8" title="Jadu image" size="58679"
              filename="one.png" modDate="1359712879"/>
      </download>
</downloads>

downloads/id/{id}

Retrieves a paginated list of one Download with a given id.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/downloads/id/4.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<download>
    <download id="4">
        <title>Galaxy nebulae</title>
        <date>1359711565</date>
        <categories>
            <category id="20000" name="Category One"/>
        </categories>
        <file id="5" title="Galaxy nebulae image" size="52138"
          filename="one.png" modDate="1359711565"/>
    </download>
</download>

events/all

Retrieves all the events in the Platform.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)

Example request:

http://{domain}/api/events/all.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<events page="1" pages="1" per_page="10" total="1">
    <event id="9" pick_of_week="0">
        <title>My event</title>
        <start_time></start_time
        <end_time></end_time>
        <start_date>1230163200</start_date>
        <end_date>1230163200</end_date>
        <next_date>1230163200</next_date>
        <interval>1</interval>
        <location>Leicester</location>
        <cost>£10.00</cost>
        <content><![CDATA[Description]]></content>
        <categories/>
    </event>
</events>

events/date/{date}

Retrieves all the events that occur on a given date.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • date (required)

Example request:

http://{domain}/api/events/date/2008-12-25.xml?api_key={api_key}
  &per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<events date="2008-12-25" category_id="21" page="1"
  pages="1" per_page="10" total="1">
    <event id="9" pick_of_week="0">
        <title>My event</title>
        <start_time></start_time>
        <end_time></end_time>
        <start_date>1230163200</start_date>
        <end_date>1230163200</end_date>
        <next_date>1230163200</next_date>
        <interval>1</interval>
        <location>Leicester</location>
        <cost>£10.00</cost>
        <content><![CDATA[Description]]></content>
        <categories>
            <category id="21" name="Category one”/>
        </categories>
    </event>
</events>

events/from/{date_from}/to/{date_to}

Retrieves all live events that occur between a given date range.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • date_from (required)
  • date_to (required)

Example request:

http://{domain}/api/events/from/2008-12-01/to/2008-12-25.xml?api_key={api_key}
  &per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<events date_from="2008-12-01" date_to="2008-12-25" category_id="21"
  page="1" pages="1" per_page="10" total="1">
    <event id="9" pick_of_week="0">
        <title>My event</title>
        <start_time></start_time>
        <end_time></end_time>
        <start_date>1230163200</start_date>
        <end_date>1230163200</end_date>
        <next_date>1230163200</next_date>
        <interval>1</interval>
        <location>Leicester</location>
        <cost>£10.00</cost>
        <content><![CDATA[Description]]></content>
        <categories>
            <category id="21" name="Category one”/>
        </categories>
    </event>
</events>

events/category/{category_id}

Retrieves all the events assigned to a specified category.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • category_id (required)

Example request:

http://{domain}/api/events/category/21.xml?
  api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<events category_id="21" page="1" pages="1" per_page="10" total="1">
      <event id="9" pick_of_week="0">
            <title>My event</title>
            <start_time/>
            <end_time/>
            <start_date>1230163200</start_date>
            <end_date>1230163200</end_date>
            <next_date>1230163200</next_date>
            <interval>1</interval>
            <location>Leicester</location>
            <cost>£10.00</cost>
            <content><![CDATA[Description]]></content>
            <categories>
                  <category id="21" name="Category one”/>
            </categories>
      </event>
</events>

events/future

Retrieves all live future events.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/events/future.xml?api_key={api_key}&per_page=5

Example response:

<?xml version="1.0" encoding="utf-8"?>
<events date_from="2013-02-04" date_to="2014-02-04" page="1" pages="1"
  per_page="5" total="3">
      <event id="2463" pick_of_week="0">
            <title>Demon Drink? Temperance and the Working Class</title>
            <start_time></start_time>
            <end_time></end_time>
            <start_date>1341010800</start_date>
            <end_date>1361664000</end_date>
            <next_date>1359936000</next_date>
            <interval>1</interval>
            <location>People’s History Museum</location>
            <cost>Free</cost>
            <content><![CDATA[<p>Visitors will be...]]></content>
            <categories>
                  <category id="500004" name="Category one"/>
            </categories>
      </event>
      <event id="1544" pick_of_week="0">
            <title>Community Tennis Club - Thursday</title>
            <start_time>19:00</start_time>
            <end_time>21:00</end_time>
            <start_date>1330560000</start_date>
            <end_date>1388016000</end_date>
            <next_date>1360195200</next_date>
            <interval>2</interval>
            <location>Chorlton Park Tennis Courts</location>
            <cost>Free</cost>
            <content><![CDATA[<p>Contact: 0161 881 9014</p>]]></content>
            <categories>
                  <category id="100009" name="Category one"/>
                  <category id="500043" name="Category two"/>
                  <category id="500045" name="Category three"/>
            </categories>
      </event>
      <event id="2195" pick_of_week="0">
            <title>Health Walk - Blackley Forest</title>
            <start_time>2pm</start_time>
            <end_time>3Pm</end_time>
            <start_date>1330560000</start_date>
            <end_date>1376265600</end_date>
            <next_date>1360195200</next_date>
            <interval>4</interval>
            <location>Blackley Forest, Victoria Avenue entrance</location>
            <cost>Free</cost>
            <content><![CDATA[<p>Half an hour&#39;s ...]]></content>
            <categories>
                  <category id="500004" name="Category one"/>
                  <category id="500039" name="Category two"/>
                  <category id="500069" name="Category three"/>
            </categories>
      </event>
</events>

events/{id}

Retrieves the specified live event details.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/events/2463..xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<event id="2463" pick_of_week="0">
      <title>Demon Drink? Temperance and the Working Class</title>
      <start_time></start_time>
      <end_time></end_time>
      <start_date>1341010800</start_date>
      <end_date>1361664000</end_date>
      <next_date>1359936000</next_date>
      <interval>1</interval>
      <location>People’s History Museum</location>
      <cost>Free</cost>
      <content><![CDATA[<p>Visitors will be...]]></content>
      <categories>
            <category id="500004" name="Category one"/>
      </categories>
</event>

faqs/all

Retrieves all live FAQ records from within the Platform.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)

Example request:

http://{domain}/api/faqs/all.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<faqs page="1" pages="1" per_page="10" total="1">
      <faq id="2">
            <title>FAQ</title>
            <date>1228826568</date>
            <question>What colour is Red mixed with Yellow?</question>
            <answer><![CDATA[I know this one! Orange]]></answer>
            <categories/>
      </faq>
</faqs>

faqs/id/{id}

Retrieves the specified FAQ via the id provided.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/faqs/id.xml?api_key={api_key}&id=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<faqs id="1" page="1" pages="1" per_page="1" total="1">
      <faq id="1">
            <title>Implementation</title>
            <date>1336737326</date>
            <question>How long is the implementation?</question>
            <answer><![CDATA[Jadu is an instant on...]]></answer>
            <categories>
                  <category id="20002" name="About"/>
            </categories>
      </faq>
</faqs>

faqs/ids?{ids=1,2,3}

Retrieves the details of multiple FAQ records as defined by the comma separated list of faq identifiers.

Arguments:

  • api_key (required)
  • ids (required)

Example request:

http://{domain}/api/faqs/ids.xml?api_key={api_key}&ids=1,2,3,4

Example response:

<?xml version="1.0" encoding="utf-8"?>
<faqs ids="1,2,3,4" page="1" pages="1" per_page="4" total="4">
      <faq id="1">
            <title>Implementation</title>
            <date>1336737326</date>
            <question>How long is the implementation?</question>
            <answer><![CDATA[Jadu is an instant on...]]></answer>
            <categories>
                  <category id="20002" name="About"/>
            </categories>
      </faq>
      <faq id="2">
            <title>Training</title>
            <date>1336737566</date>
            <question>Do I need training?</question>
            <answer><![CDATA[<p>We have made the...]]></answer>
            <categories>
                  <category id="20001" name="Tutorials"/>
            </categories>
      </faq>
      <faq id="3">
            <title>Instances</title>
            <date>1336737626</date>
            <question>If we have separate websites...</question>
            <answer><![CDATA[Yes - these are separate...]]></answer>
            <categories>
                  <category id="20002" name="About"/>
            </categories>
      </faq>
      <faq id="4">
            <title>MappApp</title>
            <date>1336737699</date>
            <question>Can I use another mapping service</question>
            <answer><![CDATA[<p>At the moment ...]]></answer>
            <categories>
                  <category id="20002" name="About"/>
            </categories>
      </faq>
</faqs>

faqs/category/{category_id}

Retrieves a paginated list of all FAQs within a specified category.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • category_id (required)

Example request:

http://{domain}/api/faqs/category/26.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<faqs category_id="" page="1" pages="1" per_page="10" total="1">
    <faq id="2">
        <title>FAQ</title>
        <date>1228826568</date>
        <question>Question text here</question>
        <answer><![CDATA[Answer text here]]></answer>
        <categories>
            <category id="21" name="Childcare - services for childminders”/>
        </categories>
    </faq>
</faqs>

forms/all

Retrieves all live Forms records from within the platforms.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • order_by (optional - default null)

Example request:

http://{domain}/api/forms/all.xml?api_key={api_key}
  &per_page=1&page=2&order_by=title

Example response:

<?xml version="1.0" encoding="utf-8"?>
<forms page="1" pages="1" per_page="10" total="2" order_by="">
    <form id="139">
        <title>Test form 1</title>
        <categories>
            <category id="20000" name="Category One"/>
        </categories>
        <channels>
            <web>
              http://mysite.co.uk/site/scripts/xforms_form.php?formID=139
            </web>
        </channels>
    </form>
    <form id="142">
        <title>Test form 2</title>
        <categories>
            <category id="20001" name="Category Two"/>
        </categories>
        <channels>
            <web>
              http://mysite.co.uk/site/scripts/xforms_form.php?formID=142
            </web>
        </channels>
    </form>
</forms>

forms/category/{category_id}

Retrieves a paginated list of all Forms within a specified category.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • category_id (required)
  • order_by (optional - default null)

Example request:

http://{domain}/api/forms/category/20000.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<forms category_id="20000" page="1" pages="1" per_page="10" total="1"
  order_by="">
    <form id="139">
        <title>Test form 1</title>
        <categories>
            <category id="20000" name="Category One"/>
        </categories>
        <channels>
            <web>
              http://mysite.co.uk/site/scripts/xforms_form.php?formID=139
            </web>
        </channels>
    </form>
</forms>

forms/id/{id}

Retrieves the specified Form details via the id provided.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/forms/id/139.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<form>
    <form id="139">
        <title>Test form 1</title>
        <categories>
            <category id="20000" name="Category One"/>
        </categories>
        <channels>
            <web>
              http://mysite.co.uk/site/scripts/xforms_form.php?formID=139
            </web>
        </channels>
    </form>
</form>

meetingattachments/meetingattachments

Retrieve all meeting attachments for a specified meeting id.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • meetingID (required)

Example request:

http://{domain}/api/meetingattachments/meetingattachments.xml?
  api_key={api_key}&meetingID=4

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingAttachments page="1" pages="1" per_page="10" total="3">
      <meetingAttachment id="1">
            <meetingID>4</meetingID>
            <title>Download the asdasd</title>
            <typeID>1</typeID>
            <contentType>file</contentType>
            <content><![CDATA[one.png]]></content>
            <size>57.3 KB</size>
            <position>1</position>
            <dateCreated>1359720800</dateCreated>
      </meetingAttachment>
      <meetingAttachment id="2">
            <meetingID>4</meetingID>
            <title>Download the asdasd2</title>
            <typeID>1</typeID>
            <contentType>file</contentType>
            <content><![CDATA[one.png]]></content>
            <size>71.62 KB</size>
            <position>2</position>
            <dateCreated>1359720869</dateCreated>
      </meetingAttachment>
      <meetingAttachment id="3">
            <meetingID>4</meetingID>
            <title>Download the asdasd2</title>
            <typeID>1</typeID>
            <contentType>file</contentType>
            <content><![CDATA[one.png]]></content>
            <size>71.62 KB</size>
            <position>3</position>
            <dateCreated>1359721109</dateCreated>
      </meetingAttachment>
<!/meetingAttachments>

meetingattachments/meetingattachment

Retrieves a single meeting attachment record.

Arguments:

  • api_key (required)
  • meetingAttachmentID (required)

Example request:

http://{domain}/api/meetingattachments/meetingattachment.xml?
  api_key={api_key}&meetingAttachmentID=2

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingAttachment id="2">
      <meetingID>4</meetingID>
      <title>Download the asdasd2</title>
      <typeID>1</typeID>
      <contentType>file</contentType>
      <content><![CDATA[Screen_Shot_2013_02_01_at_09.36.43.png]]></content>
      <size>71.62 KB</size>
      <position>2</position>
      <dateCreated>1359720869</dateCreated>
<!/meetingAttachment>

meetingattachmenttypes/attachmenttype

Retrieves details of a single meeting attachment type as specified by the id.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/meetingattachmenttypes/1/attachmenttype.xml?
  api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<attachmentType id="1">
      <type>Test Type 1</type>
      <priority>1</priority>
</attachmentType>

meetings/all

Retrieve all meetings.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/meetings/all.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingMinutes page="1" pages="1" per_page="10" total="1">
      <meetingMinute id="4">
            <headerID>3</headerID>
            <live>1</live>
            <adminID>1</adminID>
            <meetingMinutesDate>1359676800</meetingMinutesDate>
            <dateCreated>1359720720</dateCreated>
            <modDate>1359720872</modDate>
            <showAsEvent>0</showAsEvent>
      </meetingMinute>
</meetingMinutes>

meetings/meetingsforcommittee

Retrieve all meetings for a specified committee.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • committeeID (required)

Example request:

http://{domain}/api/meetings/meetingsforcommittee.xml?
  api_key={api_key}&committeeID=3

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingMinutes page="1" pages="1" per_page="10" total="1">
      <meetingMinute id="4">
            <headerID>3</headerID>
            <live>1</live>
            <adminID>1</adminID>
            <meetingMinutesDate>1359676800</meetingMinutesDate>
            <dateCreated>1359720720</dateCreated>
            <modDate>1359720872</modDate>
            <showAsEvent>0</showAsEvent>
      </meetingMinute>
</meetingMinutes>

meetings/meetingminuteswithcategory

Retrieve all meetings with the specified category id applied.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • categoryID (required)

Example request:

http://{domain}/api/meetings/meetingminuteswithcategory.xml?
  api_key={api_key}&categoryID=20000

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingMinutes page="1" pages="1" per_page="10" total="1">
      <meetingMinute id="4">
            <headerID>3</headerID>
            <live>1</live>
            <adminID>1</adminID>
            <meetingMinutesDate>1359676800</meetingMinutesDate>
            <dateCreated>1359720720</dateCreated>
            <modDate>1359720872</modDate>
            <showAsEvent>0</showAsEvent>
      </meetingMinute>
</meetingMinutes>

meetings/lastxmeetingminutes

Retrieve last x meeting minutes.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • numberOfMeetings (required)
  • inPast (optional - true/false value: 1 or 0)

Example request:

http://{domain}/api/meetings/lastxmeetingminutes.xml?api_key={api_key}
  &numberOfMeetings=10&inPast=0&per_page=2&page=5

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingMinutes page="5" pages="5" per_page="2" total="10">
      <meetingMinute id="1786">
            <headerID>10</headerID>
            <live>1</live>
            <adminID>12</adminID>
            <meetingMinutesDate>1363219200</meetingMinutesDate>
            <dateCreated>0</dateCreated>
            <modDate>1330646400</modDate>
            <showAsEvent>0</showAsEvent>
      </meetingMinute>
      <meetingMinute id="1757">
            <headerID>18</headerID>
            <live>1</live>
            <adminID>12</adminID>
            <meetingMinutesDate>1363132800</meetingMinutesDate>
            <dateCreated>0</dateCreated>
            <modDate>1326067200</modDate>
            <showAsEvent>0</showAsEvent>
      </meetingMinute>
</meetingMinutes>

meetings/upcomingmeetingminutes

Retrieve the upcoming meeting minutes

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • days (optional - default 7)

Example request:

http://{domain}/api/meetings/upcomingmeetingminutes.xml?api_key={api_key}
  &days=500

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingMinutes page="1" pages="1" per_page="10" total="1">
      <meetingMinute id="4">
            <headerID>3</headerID>
            <live>1</live>
            <adminID>1</adminID>
            <meetingMinutesDate>1389657600</meetingMinutesDate>
            <dateCreated>1359720720</dateCreated>
            <modDate>1359724801</modDate>
            <showAsEvent>0</showAsEvent>
      </meetingMinute>
</meetingMinutes>

meetings/getmeetingminutesheader

Retrieve a specified meeting header.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/meetings/3/getmeetingminutesheader.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<meetingHeader id="3">
      <title>Test Committee</title>
      <isArchived>1</isArchived>
</meetingHeader>

news/all

Retrieve all News.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/news/all.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<newsItems page="1" pages="1" per_page="10" total="4">
      <news id="2">
            <title>3D printed moon building designs revealed</title>
            <summary>The architects behind ...</summary>
            <content><![CDATA[<p>An inflatable structure...]]></content>
            <imageURL></imageURL>
            <newsDate>1359729360</newsDate>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </news>
      <news id="3">
            <title>British army stages record-breaking virtual battle</title>
            <summary>The British army has...</summary>
            <content><![CDATA[<p>The experiment was carried out...]]></content>
            <imageURL></imageURL>
            <newsDate>1359729420</newsDate>
            <categories>
                  <category id="20001" name="Category Two"/>
            </categories>
      </news>
      <news id="4">
            <title>Samsung gains tablet market share</title>
            <summary>Samsung doubled its ...</summary>
            <content><![CDATA[<p>Samsung, which makes...]]></content>
            <imageURL></imageURL>
            <newsDate>1359729540</newsDate>
            <categories>
                  <category id="20002" name="Category Three"/>
                  <category id="20013" name="Subcategory 3.3"/>
            </categories>
      </news>
</newsItems>

news/{id}

Retrieve a single news item by the specified id.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/news/single.xml?api_key={api_key}&newsID=2

Example response:

<?xml version="1.0" encoding="utf-8"?>
<news id="2">
      <title>3D printed moon building designs revealed</title>
      <summary>The architects behind ...</summary>
      <content><![CDATA[<p>An inflatable structure ...]]></content>
      <imageURL></imageURL>
      <newsDate>1359729360</newsDate>
      <categories>
            <category id="20000" name="Category One"/>
      </categories>
</news>

news/category?{category_id}

Retrieves all news within a given category.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)
  • category_id (required)

Example request:

http://{domain}/api/news/category.xml?api_key={api_key}&category_id=20000

Example response:

<?xml version="1.0" encoding="utf-8"?>
<newsItems category_id="20000" page="1" pages="1" per_page="10" total="1">
      <news id="2">
            <title>3D printed moon building designs revealed</title>
            <summary>The architects behind...</summary>
            <content><![CDATA[<p>An inflatable structure ...]]></content>
            <imageURL></imageURL>
            <newsDate>1359729360</newsDate>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </news>
</newsItems>

news/latest

Retrieves a paginated list of News in date order

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/news/latest.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<newsItems page="1" pages="1" per_page="10" total="3">
      <news id="4">
            <title>Samsung gains tablet market share</title>
            <summary>Samsung doubled its ...</summary>
            <content><![CDATA[<p>Samsung, which makes ...]]></content>
            <imageURL></imageURL>
            <newsDate>1359729540</newsDate>
            <categories>
                  <category id="20002" name="Category Three"/>
                  <category id="20013" name="Subcategory 3.3"/>
            </categories>
      </news>
      <news id="3">
            <title>British army stages record-breaking virtual battle</title>
            <summary>The British army has ...</summary>
            <content><![CDATA[<p>The experiment was ...]]></content>
            <imageURL></imageURL>
            <newsDate>1359729420</newsDate>
            <categories>
                <category id="20001" name="Category Two"/>
            </categories>
      </news>
      <news id="2">
            <title>3D printed moon building designs revealed</title>
            <summary>The architects ...</summary>
            <content><![CDATA[<p>An inflatable structure...>]]></content>
            <imageURL></imageURL>
            <newsDate>1359729360</newsDate>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </news>
</newsItems>

resources/all

Retrieves all of the different possible API resources available within the platform (including those provided by additional modules).

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/resources/all.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<resources>
      <resource name="admintasks" enabled="1"/>
      <resource name="categories" enabled="1"/>
      <resource name="committees" enabled="1"/>
      <resource name="councillors" enabled="1"/>
      <resource name="directories" enabled="1"/>
      <resource name="documents" enabled="1"/>
      <resource name="downloads" enabled="1"/>
      <resource name="events" enabled="1"/>
      <resource name="faqs" enabled="1"/>
      <resource name="forms" enabled="1"/>
      <resource name="meetingAttachments" enabled="1"/>
      <resource name="meetingAttachmentTypes" enabled="1"/>
      <resource name="meetings" enabled="1"/>
      <resource name="news" enabled="1"/>
      <resource name="rupa" enabled="1"/>
      <resource name="services" enabled="1"/>
      <resource name="sharepointdocuments" enabled="1"/>
      <resource name="sharepointpages" enabled="1"/>
      <resource name="status" enabled="1"/>
      <resource name="userForms" enabled="1"/>
      <resource name="wards" enabled="1"/>
</resources>

resources/enabled

Retrieves only the enabled API resources available within the platform (including those provided by additional modules). Enabled resources are managed via the Utilities module within the Jadu Control Centre.

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/resources/enabled.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <resource name="admintasks" enabled="1"/>
    <resource name="categories" enabled="1"/>
    <resource name="committees" enabled="1"/>
    <resource name="councillors" enabled="1"/>
    <resource name="directories" enabled="1"/>
    <resource name="documents" enabled="1"/>
    <resource name="downloads" enabled="1"/>
    <resource name="events" enabled="1"/>
    <resource name="faqs" enabled="1"/>
    <resource name="forms" enabled="1"/>
    <resource name="meetingAttachments" enabled="1"/>
    <resource name="meetingAttachmentTypes" enabled="1"/>
    <resource name="meetings" enabled="1"/>
    <resource name="news" enabled="1"/>
    <resource name="rupa" enabled="1"/>
    <resource name="services" enabled="1"/>
    <resource name="sharepointdocuments" enabled="1"/>
    <resource name="sharepointpages" enabled="1"/>
    <resource name="status" enabled="1"/>
    <resource name="userForms" enabled="1"/>
    <resource name="wards" enabled="1"/>
</resources>

resources/disabled

Retrieves only the disable API resources available within the platform (including those provided by additional modules). Enabled resources are managed via the Utilities module within the Jadu Control Centre.

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/resources/disabled.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <resource name="categories" enabled="0"/>
    <resource name="directories" enabled="0"/>
</resources>

rupa/collections

Retrieves all configured search collections as defined within the Rupa module.

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/rupa/collections.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<collections pages="1" page="1" total="3">
      <collection>
            <name>Clearwater</name>
            <collection_name>one</collection_name>
            <image>http://mysite.co.uk/images/one.jpg</image>
      </collection>
      <collection>
            <name>Test Collection one</name>
            <collection_name>two</collection_name>
            <image>http://mysite.co.uk/images/two.png</image>
      </collection>
      <collection>
            <name>Caldwell 12 collection</name>
            <collection_name>three</collection_name>
            <image>http://mysite.co.uk/images/three.png</image>
      </collection>
</collections>

rupa/search

rupa search returns collections and search result urls.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/status/index.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<search total="0" per_page="10" pages="1" page="1">
    <link rel="alternate" href="results.php?q=" type="text/html"/>
    <link rel="search-within"
      href="http://{domain}/api/rupa/search.xml?pre_q="/>
    <link rel="date"
      href="http://{domain}/api/rupa/search.xml?sortBy=date"/>
    <collections>
        <search url="http://{domain}/api/rupa/collections/one/search.xml?">
            <name>Clearwater</name>
            <image src="/images/one.jpg"/>
        </search>
        <search url="http://{domain}/api/rupa/collections/two/search.xml?">
            <name>Test Collection one</name>
            <image src="/images/two.png"/>
        </search>
        <search url="http://{domain}/api/rupa/collections/three/search.xml?">
            <name>Caldwell 12 collection</name>
            <image src="/images/three.png"/>
        </search>
    </collections>
</search>

services/all

Retrieves all of the services defined within the A-Z Services area of the eGov module.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)

Example request:

http://{domain}/api/services/all.xml?api_key={api_key}&per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<services page="1" pages="1" per_page="10" total="4">
      <service id="1">
            <title>Abandoned bicycles</title>
            <eligibility>Eligibility</eligibility>
            <accessibility>Accessibility</accessibility>
            <availability>Availability</availability>
            <content><![CDATA[<p>Abandoned Vehicles</p>]]></content>
            <contacts/>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </service>
      <service id="2">
            <title>Abandoned miscellaneous</title>
            <eligibility>Eligibility</eligibility>
            <accessibility>Accessibility</accessibility>
            <availability>Availability</availability>
            <content>
              <![CDATA[<p>Primary Service content here...</p>]]>
            </content>
            <contacts/>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </service>
</services>

services/category/{category_id}

Retrieves all of the services that are assigned to the specified category.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • category_id (required)

Example request:

http://{domain}/api/services/category/21.xml?api_key={api_key}
  &per_page=10&page=1

Example response:

<?xml version="1.0" encoding="utf-8"?>
<services category_id="21" page="1" pages="13" per_page="10" total="123">
      <service id="306">
            <title>Abandoned vehicles</title>
            <eligibility/>
            <accessibility/>
            <availability>Normal office hours</availability>
            <content><![CDATA[If you see a vehicle ...]]></content>
            <contacts>
                  <contact name="Neighbourhood Environmental Action Team"
                    department="" email="team@mydomain.gov.uk"
                    telephone="01706 252565 / 252556" fax=""
                    website="" address="Team, Stubbylee Hall, Bacup,
                    Lancs, OL13 0DE”/>
            </contacts>
            <categories>
                  <category id="21" name="Category One"/>
            </categories>
      </service>
      <service id="1011">
            <title>Abnormal loads</title>
            <eligibility/>
            <accessibility/>
            <availability/>
            <content><![CDATA[The movement of large...]]></content>
            <contacts>
                  <contact name="Lancashire Highways Partnership"
                    department="" email="highways@mydomain.gov.uk"
                    telephone="0845 053 0011" fax=""
                    website="http://highways.mydomain.gov.uk/"
                    address="Guild House, PO Box 9, Cross Street,
                      Preston, Lancashire, PR1 8RD"/>
            </contacts>
            <categories>
                  <category id="21" name="Category One"/>
            </categories>
      </service>
</services>

services/letter/{letter}

Retrieves all of the services that begin with the given letter.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • letter (required)

Example request:

http://{domain}/api/services/letter/a.xml?api_key={api_key}
  &per_page=10&page=1&letter=A

Example response:

<?xml version="1.0" encoding="utf-8"?>
<services letter="a" page="1" pages="1" per_page="10" total="2">
      <service id="1">
            <title>Abandoned bicycles</title>
            <eligibility>Eligibility</eligibility>
            <accessibility>Accessibility</accessibility>
            <availability>Availability</availability>
            <content><![CDATA[<p>Abandoned Vehicles</p>]]></content>
            <contacts/>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </service>
      <service id="2">
            <title>Abandoned miscellaneous</title>
            <eligibility>Eligibility</eligibility>
            <accessibility>Accessibility</accessibility>
            <availability>Availability</availability>
            <content>
              <![CDATA[<p>Primary Service content here...</p>]]>
            </content>
            <contacts/>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </service>
</services>

services/search.xml?query={query}

Retrieves all A-Z service records that match the specified query string.

Arguments:

  • api_key (required)
  • per_page (optional - default 25)
  • page (optional - default 1)
  • query (required)

Example request:

http://{domain}/api/services/search.xml?api_key={api_key}&query=Ab

Example response:

<?xml version="1.0" encoding="utf-8"?>
<services page="1" pages="1" per_page="10" total="2">
      <service id="1">
            <title>Abandoned bicycles</title>
            <eligibility>Eligibility</eligibility>
            <accessibility>Accessibility</accessibility>
            <availability>Availability</availability>
            <content><![CDATA[<p>Abandoned Vehicles</p>]]></content>
            <contacts/>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </service>
      <service id="2">
            <title>Abandoned miscellaneous</title>
            <eligibility>Eligibility</eligibility>
            <accessibility>Accessibility</accessibility>
            <availability>Availability</availability>
            <content>
                <![CDATA[<p>Primary Service content here...</p>]]>
            </content>
            <contacts/>
            <categories>
                  <category id="20000" name="Category One"/>
            </categories>
      </service>
</services>

services/single.xml?id={id}

Retrieves a single service by the specified id.

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/services/1/single.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<service id="1">
      <title>Abandoned bicycles</title>
      <eligibility>Eligibility</eligibility>
      <accessibility>Accessibility</accessibility>
      <availability>Availability</availability>
      <content><![CDATA[<p>Abandoned Vehicles</p>]]></content>
      <contacts/>
      <categories>
            <category id="20000" name="Category One"/>
      </categories>
</service>

status/index

Retrieves the Jadu Continuum CMS version information.

Arguments:

  • api_key (required)

Example request:

http://{domain}/api/status/index.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<status>
      <version>1.0.6.12</version>
</status>

userForms/getstatusandcomments/{id}

Gets the status and comments of the specified form submission reference (XForms Professional and standard).

Arguments:

  • api_key (required)
  • id (required)

Example request:

http://{domain}/api/userForms/getstatusandcomments/123456.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<userForm id="123456">
      <status>0</status>
      <comments/>
</userForm>

userForms/setstatusandcomments/{id}

Sets the status and comments of the specified form submission reference (XForms Professional and standard). The append, status and comments values must be sent as POST values in order to update these values.

Arguments:

  • api_key (required)
  • id (required)
  • append (required POST - append to or overwrite existing comments)
  • status (required POST - new status of the user form record)
  • comments (required POST)

Valid status values include:

  • 0 [Pending] The first state for a user form "Pending" i.e. not yet in progress, pending review.
  • 1 [Progressing] The second state for a user form "Progressing" i.e. in progress, pending review.
  • 2 [Completed Approved] The third state for a user form "Completed Approved" i.e. completed, successful application.
  • 3 [Completed Declined] The fourth state for a user form "Completed Declined" i.e. completed, unsuccessful application.
  • 4 [Completed Data removed] The fifth state for a user form "Completed" and personal data removed.
  • 5 [Terminated] The sixth state for a user form "Terminate" i.e. reviewed and found to be dummy "mickey mouse" like applications.

Example request:

http://{domain}/api/userForms/setstatusandcomments/123456.xml?api_key={api_key}

Example response:

<?xml version="1.0" encoding="utf-8"?>
<userForm id="123456">
      <status>1</status>
      <comments>Status updated by CRM action.</comments>
</userForm>

wards/all

Retrieve all Wards as configured within the eGov module.

Arguments:

  • api_key (required)
  • per_page (optional - default 10)
  • page (optional - default 1)

Example request:

http://{domain}/api/wards/all.xml?api_key={api_key}&per_page=3&page=5

Example response:

<?xml version="1.0" encoding="utf-8"?>
<wards page="5" pages="11" per_page="3" total="32">
      <ward id="48">
            <name>Didsbury East</name>
            <code>DE</code>
      </ward>
      <ward id="50">
            <name>Didsbury West</name>
            <code>DW</code>
      </ward>
      <ward id="44">
            <name>Fallowfield</name>
            <code>F</code>
      </ward>
</wards>

results matching ""

    No results matching ""