2002/css-validator/api.html - view

File: [Public] / 2002 / css-validator / api.html
Revision 1.17: download - view: text, annotated - select for diffs
Thu Jan 14 14:10:29 2010 UTC (15 years, 3 months ago) by ylafon
Branches: MAIN
CVS tags: css2010_0, apadktba_0, HEAD

ercim.org -> ercim.eu

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> <title>Documentation of the Programmatic Interface (API) to The W3C CSS Validation Service</title> <link rev="made" href="mailto:www-validator-css@w3.org" /> <link rev="start" href="./" title="Home Page" /> <style type="text/css" media="all"> @import "style/base.css"; </style> <meta name="revision" content="$Id: api.html,v 1.17 2010/01/14 14:10:29 ylafon Exp $" />  </head> <body> <div id="banner"> <h1 id="title"><a href="http://www.w3.org/"><img alt="W3C" width="110" height="61" id="logo" src="./images/w3c.png" /></a> <a href="./"><span>CSS Validation Service</span></a></h1> <p id="tagline"> Check Cascading Style Sheets (CSS) and (X)HTML documents with style sheets </p> </div> <div class="doc"> <h2>CSS Validator Web Service API<br /> SOAP 1.2 validation interface documentation</h2> <h3 id="TableOfContents">Table of Contents</h3> <div id="toc"> <ul> <li><a href="#requestformat">Validation Request Format</a></li> <li><a href="#soap12format">SOAP format description</a> <ul> <li><a href="#soap12_sample">sample SOAP 1.2 validation response</a></li> <li><a href="#soap12response">SOAP1.2 response format reference</a></li> <li><a href="#soap12message">SOAP1.2 atomic message (error or warning) format reference</a></li> </ul> </li> </ul> </div> <p id="skip"></p> <h3 id="requestformat">Validation Request Format</h3> <p>The documentation on how to create a custom request to the CSS validation service is available, with a table of all existing parameters and their values, in the <a href="manual.html">User Manual</a>.</p> <h3 id="soap12format">SOAP format description</h3> <p>When called with parameter <code>output=soap12</code>, the validator will switch to its SOAP 1.2 interface. Below is a sample response, as well as a description of the most important elements of the response.</p> <p>A <a href="http://www.w3.org/2005/09/css-validator.wsdl">WSDL 2 description file</a> is lso available for this service.</p> <h4>sample SOAP 1.2 validation request</h4> <p>It is a simple HTTP GET call to a URI like:</p> <p><code>http://jigsaw.w3.org/css-validator/validator?uri=http%3A%2F%2Fwww.w3.org%2F&warning=0&profile=css2</code></p> <h4 id="soap12_sample">sample SOAP 1.2 validation response</h4> <p>A SOAP response for the validation of a document (invalid) will look like this:</p> <pre style="font-size: smaller"><?xml version='1.0' encoding="utf-8"?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <env:Body> <m:cssvalidationresponse env:encodingStyle="http://www.w3.org/2003/05/soap-encoding" xmlns:m="http://www.w3.org/2005/07/css-validator"> <m:uri>http://www.w3.org/</m:uri> <m:checkedby>http://jigsaw.w3.org/css-validator/</m:checkedby> <m:csslevel>css2</m:csslevel> <m:date>2006.02.23T01:19:57Z</m:date> <m:validity>true</m:validity> <m:result> <m:errors xml:lang="en"> <m:errorcount>0</m:errorcount> </m:errors> <m:warnings xml:lang="en"> <m:warningcount>79</m:warningcount> <m:warninglist> <m:uri>http://www.w3.org/StyleSheets/home.css</m:uri> <m:warning> <m:line>85</m:line> <m:level>0</m:level> <m:message>Properties for other media might not work for usermedium</m:message> </m:warning> </m:warninglist> <m:warninglist> <m:uri>http://www.w3.org/StyleSheets/home-import.css</m:uri> <m:warning> <m:line>167</m:line> <m:level>0</m:level> <m:message>Properties for other media might not work for usermedium</m:message> </m:warning> <m:warning> <m:line>349</m:line> <m:level>0</m:level> <m:message>Properties for other media might not work for usermedium</m:message> </m:warning> <m:warning> <m:line>362</m:line> <m:level>0</m:level> <m:message>Properties for other media might not work for usermedium</m:message> </m:warning> </m:warninglist> </m:warnings> </m:result> </m:cssvalidationresponse> </env:Body> </env:Envelope></pre> <h4 id="soap12response">SOAP1.2 response format reference</h4> <table class="refdoc"> <tbody> <tr> <th>element</th> <th>description</th> </tr> <tr> <th id="soap12_markupvalidationresponse">cssvalidationresponse</th> <td>The main element of the validation response. Encloses all other information about the validation results.</td> </tr> <tr> <th id="soap12_uri">uri</th> <td>the address of the document validated. In <a href="http://www.w3.org/WAI/ER/">EARL</a> terms, this is the <kbd>TestSubject</kbd>.</td> </tr> <tr> <th id="soap12_checkedby">checkedby</th> <td>Location of the service which provided the validation result. In <a href="http://www.w3.org/WAI/ER/">EARL</a> terms, this is the <kbd>Assertor</kbd>.</td> </tr> <tr> <th id="soap12_doctype">csslevel</th> <td>The CSS level (or profile) in use during the validation.</td> </tr> <tr> <th id="soap12_charset">date</th> <td>The actual date of the validation</td> </tr> <tr> <th id="soap12_validity">validity</th> <td>Whether or not the document validated passed or not formal validation (boolean)</td> </tr> <tr> <th id="soap12_errors">errors</th> <td>Encapsulates all data about errors encountered through the validation process</td> </tr> <tr> <th id="soap12_errorcount">errorcount</th> <td>a child of <a href="#soap12_errors">errors</a>, counts the number of errors listed</td> </tr> <tr> <th id="soap12_errorlist">errorlist</th> <td>a child of <a href="#soap12_errors">errors</a>, contains the list of errors (surprise!)</td> </tr> <tr> <th id="soap12_error">error</th> <td>a child of <a href="#soap12_errorlist">errorlist</a>, contains the information on a single validation error.</td> </tr> </tbody> </table> <p><strong>Note</strong>: <code>warnings</code>, <code>warningcount</code>, <code>warninglist</code> and <code>warning</code> are similar to, respectively, <code><a href="#soap12_errors">errors</a></code>, <code><a href="#soap12_errorcount">errorcount</a></code>, <code><a href="#soap12_errorlist">errorlist</a></code> and <code><a href="#soap12_error">error</a></code>.</p> <h4 id="soap12message">SOAP1.2 atomic message (error or warning) format reference</h4> <p>As seen as the example above, the children of the <code><a href="#soap12_error">error</a></code> element, but also the <code>warning</code> element are <code>line</code>, <code>level</code> and <code>message</code>, defined below:</p> <table class="refdoc"> <tbody> <tr> <th>element</th> <th>description</th> </tr> <tr> <th id="soap12_line">line</th> <td>Within the source code of the validated document, refers to the line where the error was detected.</td> </tr> <tr> <th id="soap12_col">level</th> <td>The level of the warning, only the ones whose level is under or equal to the value specified in the request will be displayed.</td> </tr> <tr> <th id="soap12_message">message</th> <td>The actual error or warning message</td> </tr> </tbody> </table> </div> <ul class="navbar" id="menu"> <li><strong><a href="./" title="Home page for the W3C CSS Validation Service">Home</a></strong> <span class="hideme">|</span></li> <li><a href="about.html" title="About this service">About</a> <span class="hideme">|</span></li> <li><a href="documentation.html" title="Documentation for the W3C CSS Validation Service">Documentation</a> <span class="hideme">|</span></li> <li><a href="DOWNLOAD.html" title="Download the CSS validator">Download</a> <span class="hideme">|</span></li> <li><a href="Email.html" title="How to provide feedback on this service">Feedback</a> <span class="hideme">|</span></li> <li><a href="thanks.html" title="Credits and Acknowlegments">Credits</a><span class="hideme">|</span></li> </ul> <div id="footer"> <p id="activity_logos"> <a href="http://www.w3.org/QA/" title="W3C's Quality Assurance Activity, bringing you free Web quality tools and more"><img src="http://www.w3.org/QA/2002/12/qa-small.png" alt="QA" /></a><a href="http://www.w3.org/Style/CSS/learning" title="Learn more about Cascading Style Sheets"><img src="images/woolly-icon" alt="CSS" /></a> </p> <p id="support_logo"> <a href="http://www.w3.org/QA/Tools/Donate"> <img src="http://www.w3.org/QA/Tools/I_heart_validator" alt="I heart Validator logo" title=" Validators Donation Program" /> </a> </p> <p class="copyright"> <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 1994-2009 <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a>® (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>, <a href="http://www.ercim.eu/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>, <a href="http://www.keio.ac.jp/">Keio</a>), All Rights Reserved. W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>, <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>, <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a> and <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-software">software licensing</a> rules apply. Your interactions with this site are in accordance with our <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Public">public</a> and <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Members">Member</a> privacy statements. </p> </div> </body> </html>