Annotation of 2002/css-validator/api.html, revision 1.15
1.1 ylafon 1: <?xml version="1.0"?>
2: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4: <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5: <head>
1.15 ! ot 6: <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
1.1 ylafon 7: <title>Documentation of the Programmatic Interface (API) to The W3C CSS
8: Validation Service</title>
9: <link rev="made" href="mailto:www-validator-css@w3.org" />
10: <link rev="start" href="./" title="Home Page" />
11: <style type="text/css" media="all">
1.7 ot 12: @import "style/base.css";
1.5 ot 13: </style>
1.1 ylafon 14: <meta name="revision"
1.15 ! ot 15: content="$Id: api.html,v 1.14 2009/01/08 22:40:33 ot Exp $" />
! 16: <!-- SSI Template Version: $Id: api.html,v 1.14 2009/01/08 22:40:33 ot Exp $ -->
1.1 ylafon 17: </head>
18:
19: <body>
1.5 ot 20: <div id="banner">
1.10 ot 21: <h1 id="title"><a href="http://www.w3.org/"><img alt="W3C" width="110" height="61" id="logo" src="./images/w3c.png" /></a>
22: <a href="./"><span>CSS Validation Service</span></a></h1>
23: <p id="tagline">
24: Check Cascading Style Sheets (CSS) and (X)HTML documents with style sheets
25: </p>
26: </div>
1.1 ylafon 27:
1.10 ot 28: <div class="doc">
1.1 ylafon 29: <h2>CSS Validator Web Service API<br />
30: SOAP 1.2 validation interface documentation</h2>
31:
32: <h3 id="TableOfContents">Table of Contents</h3>
33:
34: <div id="toc">
35: <ul>
36: <li><a href="#requestformat">Validation Request Format</a></li>
37: <li><a href="#soap12format">SOAP format description</a>
38: <ul>
39: <li><a href="#soap12_sample">sample SOAP 1.2 validation
40: response</a></li>
41: <li><a href="#soap12response">SOAP1.2 response format reference</a></li>
42: <li><a href="#soap12message">SOAP1.2 atomic message (error or warning)
43: format reference</a></li>
44: </ul>
45: </li>
46: </ul>
47: </div>
48:
49: <p id="skip"></p>
50:
51: <h3 id="requestformat">Validation Request Format</h3>
52:
1.5 ot 53: <p>The documentation on how to create a custom request to the CSS validation service is available,
1.6 ot 54: with a table of all existing parameters and their values, in the <a href="manual.html">User Manual</a>.</p>
1.1 ylafon 55:
56: <h3 id="soap12format">SOAP format description</h3>
57:
58: <p>When called with parameter <code>output=soap12</code>, the validator will
59: switch to its SOAP 1.2 interface. Below is a sample response, as well as a
60: description of the most important elements of the response.</p>
61:
1.9 ot 62: <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>
63:
1.1 ylafon 64: <h4>sample SOAP 1.2 validation request</h4>
65:
66: <p>It is a simple HTTP GET call to a URI like:</p>
67:
68: <p><code>http://jigsaw.w3.org/css-validator/validator?uri=http%3A%2F%2Fwww.w3.org%2F&warning=0&profile=css2</code></p>
69:
70: <h4 id="soap12_sample">sample SOAP 1.2 validation response</h4>
71:
72: <p>A SOAP response for the validation of a document (invalid) will look like
73: this:</p>
74: <pre style="font-size: smaller"><?xml version='1.0' encoding="utf-8"?>
75: <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope">
76: <env:Body>
77: <m:cssvalidationresponse
78: env:encodingStyle="http://www.w3.org/2003/05/soap-encoding"
79: xmlns:m="http://www.w3.org/2005/07/css-validator">
80: <m:uri>http://www.w3.org/</m:uri>
81: <m:checkedby>http://jigsaw.w3.org/css-validator/</m:checkedby>
82: <m:csslevel>css2</m:csslevel>
83: <m:date>2006.02.23T01:19:57Z</m:date>
84: <m:validity>true</m:validity>
85: <m:result>
86: <m:errors xml:lang="en">
87: <m:errorcount>0</m:errorcount>
88: </m:errors>
89: <m:warnings xml:lang="en">
90: <m:warningcount>79</m:warningcount>
91: <m:warninglist>
92: <m:uri>http://www.w3.org/StyleSheets/home.css</m:uri>
93: <m:warning>
94: <m:line>85</m:line>
95: <m:level>0</m:level>
96: <m:message>Properties for other media might not work for usermedium</m:message>
97: </m:warning>
98: </m:warninglist>
99: <m:warninglist>
100: <m:uri>http://www.w3.org/StyleSheets/home-import.css</m:uri>
101: <m:warning>
102: <m:line>167</m:line>
103: <m:level>0</m:level>
104: <m:message>Properties for other media might not work for usermedium</m:message>
105: </m:warning>
106: <m:warning>
107: <m:line>349</m:line>
108: <m:level>0</m:level>
109: <m:message>Properties for other media might not work for usermedium</m:message>
110: </m:warning>
111: <m:warning>
112: <m:line>362</m:line>
113: <m:level>0</m:level>
114: <m:message>Properties for other media might not work for usermedium</m:message>
115: </m:warning>
116: </m:warninglist>
117: </m:warnings>
118: </m:result>
119: </m:cssvalidationresponse>
120: </env:Body>
121: </env:Envelope></pre>
122:
123: <h4 id="soap12response">SOAP1.2 response format reference</h4>
124:
125: <table class="refdoc">
126: <tbody>
127: <tr>
128: <th>element</th>
129: <th>description</th>
130: </tr>
131: <tr>
132: <th id="soap12_markupvalidationresponse">cssvalidationresponse</th>
133: <td>The main element of the validation response. Encloses all other
134: information about the validation results.</td>
135: </tr>
136: <tr>
137: <th id="soap12_uri">uri</th>
138: <td>the address of the document validated. In <a
139: href="http://www.w3.org/WAI/ER/">EARL</a> terms, this is the
140: <kbd>TestSubject</kbd>.</td>
141: </tr>
142: <tr>
143: <th id="soap12_checkedby">checkedby</th>
144: <td>Location of the service which provided the validation result. In <a
145: href="http://www.w3.org/WAI/ER/">EARL</a> terms, this is the
146: <kbd>Assertor</kbd>.</td>
147: </tr>
148: <tr>
149: <th id="soap12_doctype">csslevel</th>
150: <td>The CSS level (or profile) in use during the validation.</td>
151: </tr>
152: <tr>
153: <th id="soap12_charset">date</th>
154: <td>The actual date of the validation</td>
155: </tr>
156: <tr>
157: <th id="soap12_validity">validity</th>
158: <td>Whether or not the document validated passed or not formal
159: validation (boolean)</td>
160: </tr>
161: <tr>
162: <th id="soap12_errors">errors</th>
163: <td>Encapsulates all data about errors encountered through the
164: validation process</td>
165: </tr>
166: <tr>
167: <th id="soap12_errorcount">errorcount</th>
168: <td>a child of <a href="#soap12_errors">errors</a>, counts the number
169: of errors listed</td>
170: </tr>
171: <tr>
172: <th id="soap12_errorlist">errorlist</th>
173: <td>a child of <a href="#soap12_errors">errors</a>, contains the list
174: of errors (surprise!)</td>
175: </tr>
176: <tr>
177: <th id="soap12_error">error</th>
178: <td>a child of <a href="#soap12_errorlist">errorlist</a>, contains the
179: information on a single validation error.</td>
180: </tr>
181: </tbody>
182: </table>
183:
184: <p><strong>Note</strong>: <code>warnings</code>, <code>warningcount</code>,
185: <code>warninglist</code> and <code>warning</code> are similar to,
186: respectively, <code><a href="#soap12_errors">errors</a></code>, <code><a
1.4 ylafon 187: href="#soap12_errorcount">errorcount</a></code>, <code><a
188: href="#soap12_errorlist">errorlist</a></code> and <code><a
189: href="#soap12_error">error</a></code>.</p>
1.1 ylafon 190:
191: <h4 id="soap12message">SOAP1.2 atomic message (error or warning) format
192: reference</h4>
193:
194: <p>As seen as the example above, the children of the <code><a
1.8 ot 195: href="#soap12_error">error</a></code> element, but also the
1.2 ylafon 196: <code>warning</code> element are <code>line</code>, <code>level</code> and
1.1 ylafon 197: <code>message</code>, defined below:</p>
198:
199: <table class="refdoc">
200: <tbody>
201: <tr>
202: <th>element</th>
203: <th>description</th>
204: </tr>
205: <tr>
206: <th id="soap12_line">line</th>
207: <td>Within the source code of the validated document, refers to the
208: line where the error was detected.</td>
209: </tr>
210: <tr>
211: <th id="soap12_col">level</th>
212: <td>The level of the warning, only the ones whose level is under or
213: equal to the value specified in the request will be displayed.</td>
214: </tr>
215: <tr>
216: <th id="soap12_message">message</th>
217: <td>The actual error or warning message</td>
218: </tr>
219: </tbody>
220: </table>
1.10 ot 221: </div>
1.5 ot 222: <ul class="navbar" id="menu">
223:
224: <li><strong><a href="./" title="Home page for the W3C CSS Validation Service">Home</a></strong> <span class="hideme">|</span></li>
1.6 ot 225: <li><a href="about.html" title="About this service">About</a> <span class="hideme">|</span></li>
1.5 ot 226:
1.6 ot 227: <li><a href="documentation.html" title="Documentation for the W3C CSS Validation Service">Documentation</a> <span class="hideme">|</span></li>
228: <li><a href="DOWNLOAD.html" title="Download the CSS validator">Download</a> <span class="hideme">|</span></li>
1.5 ot 229:
1.6 ot 230: <li><a href="Email.html" title="How to provide feedback on this service">Feedback</a> <span class="hideme">|</span></li>
231: <li><a href="thanks.html" title="Credits and Acknowlegments">Credits</a><span class="hideme">|</span></li>
1.5 ot 232:
233: </ul>
234:
1.10 ot 235: <div id="footer">
1.5 ot 236: <p id="activity_logos">
1.10 ot 237:
1.5 ot 238: <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>
239:
240: </p>
241:
242: <p id="support_logo">
1.14 ot 243: <a href="http://www.w3.org/QA/Tools/Donate">
244: <img src="http://www.w3.org/QA/Tools/I_heart_validator" alt="I heart Validator logo" title=" Validators Donation Program" />
245: </a>
1.5 ot 246: </p>
247:
248: <p class="copyright">
1.13 ot 249: <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/ipr-notice#Copyright">Copyright</a> © 1994-2009
1.5 ot 250: <a href="http://www.w3.org/"><acronym title="World Wide Web Consortium">W3C</acronym></a>®
251:
252: (<a href="http://www.csail.mit.edu/"><acronym title="Massachusetts Institute of Technology">MIT</acronym></a>,
253: <a href="http://www.ercim.org/"><acronym title="European Research Consortium for Informatics and Mathematics">ERCIM</acronym></a>,
254: <a href="http://www.keio.ac.jp/">Keio</a>),
255: All Rights Reserved.
256: W3C <a href="http://www.w3.org/Consortium/Legal/ipr-notice#Legal_Disclaimer">liability</a>,
257: <a href="http://www.w3.org/Consortium/Legal/ipr-notice#W3C_Trademarks">trademark</a>,
258: <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-documents">document use</a>
259:
260: and <a rel="Copyright" href="http://www.w3.org/Consortium/Legal/copyright-software">software licensing</a>
261:
262: rules apply. Your interactions with this site are in accordance
263: with our <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Public">public</a> and
264: <a href="http://www.w3.org/Consortium/Legal/privacy-statement#Members">Member</a> privacy
265: statements.
266: </p>
267:
1.10 ot 268: </div>
1.5 ot 269: </body>
270:
1.1 ylafon 271: </html>
1.5 ot 272:
273:
Webmaster
![[BACK]](/prx/000/https/dev.w3.org/cvsweb/icons/back.gif,_ANDesc=img,){kind=icon}
Return to api.html CVS log ![[TXT]](/prx/000/https/dev.w3.org/cvsweb/icons/text.gif,_ANDesc=img,){kind=icon}
![[DIR]](/prx/000/https/dev.w3.org/cvsweb/icons/dir.gif,_ANDesc=img,){kind=icon}
Up to [Public] / 2002 / css-validator