Response Format

After sending a request to the CLSI, you will receive a response in one of the following formats:

Successful Response

A response to a successful request will look like:

<?xml version="1.0" encoding="UTF-8"?>
<compile>
  <status>success</status>
  <output>
    <file type="pdf" url="http://clsi.scribtex.com/output/042621e09d8b6fdf9ceaa3c223827cbb/output.pdf" mimetype="application/pdf"/>
  </output>
  <logs>
    <file type="log" url="http://clsi.scribtex.com/output/042621e09d8b6fdf9ceaa3c223827cbb/output.log" mimetype="text/plain"/>
  </logs>
</compile>

The <output>...</output> tags contain a list of compiled files output by LaTeX and friends. The <logs>...</logs> tags contain a list of any log files output by LaTeX and friends. Each <file> tag has the following attributes:

• url – This is the url where the file can be downloaded from.
• type – This is the type of the file and will be either pdf, ps, dvi or log.
• mimetype – This also specifies the type of the file but via it’s mimetype.

Unsuccessful Response

An response to an unsuccessful request will look like:

<?xml version="1.0" encoding="UTF-8"?>
<compile>
  <status>failure</status>
  <error>
    <type>NoOutputProduced</type>
    <message>no compiled documents were produced</message>
  </error>
  <logs>
    <file type="log" url="http://clsi.scribtex.com/output/4c2100ec6ffe6a6dd82792cb507def84/output.log" mimetype="text/plain"/>
  </logs>
</compile>

The <error> tag will contain a <type> and <message> tag containing information about what went wrong. If the compile process was far enough along to have produced any logs then these will be return as well.

Possible error types:

• ParseError – the XML you sent was bad in some way. The message will contain more information
• InvalidToken – The token you supplied was not correct
• UnknownCompiler – The compiler you specified is not supported
• ImpossibleOutputFormat – The output format you specified is not possible with the compiler you specified
• InvalidPath – One of the paths you supplied for the resources is not valid
• NoOutputProduced – The compile did not produce any output, most likely due to a problem with your LaTeX syntax. See the returned log for more details
• Timeout – Part of the compiler process took too long to do and was aborted. Do you have server destroying infinite loops in your LaTeX?