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