| |
| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| |
| |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| |
| <title>Welcome to XDATA API’s documentation! — XDATA API 2.1.1 documentation</title> |
| |
| <link rel="stylesheet" href="_static/default.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT: '', |
| VERSION: '2.1.1', |
| COLLAPSE_INDEX: false, |
| FILE_SUFFIX: '.html', |
| HAS_SOURCE: true |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| <link rel="top" title="XDATA API 2.1.1 documentation" href="#" /> |
| <link rel="next" title="Quick Start" href="getting_started.html" /> |
| </head> |
| <body> |
| <div class="related"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="genindex.html" title="General Index" |
| accesskey="I">index</a></li> |
| <li class="right" > |
| <a href="getting_started.html" title="Quick Start" |
| accesskey="N">next</a> |</li> |
| <li><a href="#">XDATA API 2.1.1 documentation</a> »</li> |
| </ul> |
| </div> |
| |
| <div class="document"> |
| <div class="documentwrapper"> |
| <div class="bodywrapper"> |
| <div class="body"> |
| |
| <div class="section" id="welcome-to-xdata-api-s-documentation"> |
| <h1>Welcome to XDATA API’s documentation!<a class="headerlink" href="#welcome-to-xdata-api-s-documentation" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Quick Start</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="getting_started.html#install">Install</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="getting_started.html#register">Register</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="getting_started.html#log-a-user-action">Log a USER action</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="getting_started.html#log-a-sys-action">Log a SYS action</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="log_reqs.html">Draper Activity Logging API Requirements</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#activity-log-message-requirements">Activity Log Message Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#user-action-log-message-requirements">User Action Log Message Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#describing-user-actions">Describing User Actions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#definition-of-user-workflow-states">Definition of User Workflow States</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#system-action-log-message-requirements">System Action Log Message Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#ui-layout-log-message-requirements">UI Layout Log Message Requirements</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#dom-logging">DOM Logging</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="log_reqs.html#subject-and-data-security">Subject and data security</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="how_to.html">How-to Guide for Implementing the Activity Logging API</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="how_to.html#javascript">Javascript</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to.html#python">Python</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to.html#java">Java</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to.html#c">C#</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="how_to.html#future-implementations-of-the-logging-api-a-k-a-hey-you-dont-support-my-favorite-programming-language">Future Implementations of the Logging API (A.K.A. “Hey! You don’t support my favorite programming language _____”)</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="server.html">Logging Server Implementation Details</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="server.html#json-messages-using-http-post-requests">JSON messages using HTTP POST requests.</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="server.html#why-json-http">Why JSON + HTTP?</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="server.html#activity-log-data-as-json-strings">Activity Log Data as JSON Strings</a></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <div class="section" id="appendix"> |
| <h1>Appendix<a class="headerlink" href="#appendix" title="Permalink to this headline">¶</a></h1> |
| <div class="toctree-wrapper compound"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="app.html">Worflow Coding Transition</a></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar"> |
| <div class="sphinxsidebarwrapper"> |
| <h3><a href="#">Table Of Contents</a></h3> |
| <ul> |
| <li><a class="reference internal" href="#">Welcome to XDATA API’s documentation!</a><ul> |
| </ul> |
| </li> |
| <li><a class="reference internal" href="#appendix">Appendix</a><ul> |
| </ul> |
| </li> |
| </ul> |
| |
| <h4>Next topic</h4> |
| <p class="topless"><a href="getting_started.html" |
| title="next chapter">Quick Start</a></p> |
| <h3>This Page</h3> |
| <ul class="this-page-menu"> |
| <li><a href="_sources/index.txt" |
| rel="nofollow">Show Source</a></li> |
| </ul> |
| <div id="searchbox" style="display: none"> |
| <h3>Quick search</h3> |
| <form class="search" action="search.html" method="get"> |
| <input type="text" name="q" /> |
| <input type="submit" value="Go" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| <p class="searchtip" style="font-size: 90%"> |
| Enter search terms or a module, class or function name. |
| </p> |
| </div> |
| <script type="text/javascript">$('#searchbox').show(0);</script> |
| </div> |
| </div> |
| <div class="clearer"></div> |
| </div> |
| <div class="related"> |
| <h3>Navigation</h3> |
| <ul> |
| <li class="right" style="margin-right: 10px"> |
| <a href="genindex.html" title="General Index" |
| >index</a></li> |
| <li class="right" > |
| <a href="getting_started.html" title="Quick Start" |
| >next</a> |</li> |
| <li><a href="#">XDATA API 2.1.1 documentation</a> »</li> |
| </ul> |
| </div> |
| <div class="footer"> |
| © Copyright 2014, Draper . |
| Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. |
| </div> |
| </body> |
| </html> |