Tell Them What You Think ^beta

• Home
• Search
• Browse
• FAQ
• API/XML

API Functions

• search
  Returns a list of consultations matching your search terms.
• get
  Returns the details of a specific consultation and its documents.
• getdepts
  Returns a list of supported departments.

Get Consultation

Fetches details for a consultation.

Function URI

http://data.tellthemwhatyouthink.org/api/dispatch.php?function=get

Returns

This function returns the details of a consultation and its documents. It is not always possible to retrieve all details for a consultation. When it is not possible to ascertain the value for a field, it will be absent from the data returned by this function. The following fields are guaranteed to be set:

• guid
  A unique identifier for this consultation.
• uri
  The URI at which this consultation was originally published.
• department
  The shortname of the department that published the consultation.
• title
  The consultation's title.
• pubdate
  An RFC 2822-formatted date suitable for use as the consultation's publication date. This is set to the consultation's public start time if it could be determined; otherwise, it is set to the time this consultation was first seen by the indexer.

The following fields are set when they are available:

• start
  The consultation's published start date, formatted per RFC 2822.
• close
  The consultation's published end date, formatted per RFC 2822.
• summary
  A summary of the consultation.
• doclist
  A list of documents relating to the consultation. This field consists of two fields; documents, which contains the list of documents, and count, which holds the number of documents in the list. Each document field contains the following:
  
  
  • guid
    A unique identifier for the document.
  • title
    The document's title
  • uri
    The uri at which the document was originally published.
  • type
    The document's type, one of:

    pdf

    Adobe PDF

    doc

    Microsoft Word

    rtf

    Rich Text Format

    xml

    XML; note that this includes valid XHTML.

    htm

    HTML

    unk

    Unknown

  • size
    The document's size, in bytes.

Arguments

• guid

  The GUID of the consultation to be retrieved.

Example output

      <?xml version="1.0" encoding="UTF-8"?>
      <consultation>
         <guid>con-107-good-practice-guide-paternity-testing-services</guid>
         <uri>http://www.dh.gov.uk/prod_consum_dh/idcplg?IdcService=SS_GET_PAGE&siteId=en&ssTargetNodeId=660&ssDocName=DH_082626</uri>
         <department>DoH</department>
         <title>Good practice guide on paternity testing services</title>
         <pubdate>Mon, 04 Feb 2008 00:00:00 +0000</pubdate>

         <summary><![CDATA[<p>This is a 12-week consultation seeking views from stakeholders on a revised edition of the Code of Practice and Guidance on Genetic Paternity Testing Services (March 2001), which is being amended to reflect changes in the law since 2001.</p>]]></summary>
         <start>Mon, 04 Feb 2008 00:00:00 +0000</start>
         <doclist>
            <count>2</count>
            <documents>
               <document>
                  <guid>doc-315-download-good-practice-revised-pdf-387k</guid>
                  <title>Download Good practice guide on paternity testing services - revised (PDF, 387K)</title>
                  <uri>http://www.dh.gov.uk/prod_consum_dh/idcplg?IdcService=GET_FILE&dID=159176&Rendition=Web</uri>
               </document>
               <document>
                  <guid>doc-316-dear-colleague-letter</guid>
                  <title>Dear Colleague Letter on the consultation</title>
                  <uri>http://www.dh.gov.uk/prod_consum_dh/idcplg?IdcService=SS_GET_PAGE&siteId=en&ssTargetNodeId=597&ssDocName=DH_082620</uri>
               </document>
            </documents>
         </doclist>
      </consultation>
   

Created by Harry Metcalfe. Flames/feedback welcome. Copyright. Sitemap. Blog.