1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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>Appendix A. WebIssues Protocol Reference</title>
<link rel="stylesheet" href="common/style.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.0" />
<meta name="keywords" content="webissues, issue tracking, bug tracking, team collaboration, server" />
<link rel="start" href="index.html" title="The WebIssues Server Manual" />
<link rel="up" href="index.html" title="The WebIssues Server Manual" />
<link rel="prev" href="resources.html" title="Chapter 4. Resources" />
<link rel="next" href="protocol_headers.html" title="Headers" />
</head>
<body>
<div id="header">
<div id="header-bar">
<img id="header-logo" src="common/webissues.png" alt="WebIssues" />
<div id="header-title">The <span class="application">WebIssues Server</span> Manual</div>
<div id="header-abstract">Issue tracking and team collaboration system</div>
</div>
<div id="header-links">
<a accesskey="h" href="index.html">Home</a>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="resources.html">Resources</a></div>
<div class="navright"><a accesskey="n" href="protocol_headers.html">Headers</a> »</div>
</div>
<div class="appendix" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="protocol"></a>Appendix A. <span class="application">WebIssues</span> Protocol Reference</h2>
</div>
</div>
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="protocol_messages"></a>Messages</h2>
</div>
</div>
</div>
<p>The messages used in the <span class="application">WebIssues</span> protocol are based on the HTTP/1.1 specification [<a class="ulink" href="http://www.faqs.org/rfcs/rfc2616.html" target="_top">RFC 2616</a>].</p>
<p>The <span class="application">WebIssues</span> request is a <code class="literal">multipart/form-data</code> message [<a class="ulink" href="http://www.faqs.org/rfcs/rfc2388.html" target="_top">RFC 2388</a>] containing the following fields:</p>
<div class="variablelist">
<dl>
<dt>
<span class="term">command</span>
</dt>
<dd>
<p>required field containing the command to be executed</p>
</dd>
<dt>
<span class="term">file</span>
</dt>
<dd>
<p>optional field containing the uploaded file</p>
</dd>
</dl>
</div>
<p>The <span class="application">WebIssues</span> server response is either a <code class="literal">text/plain</code> message containing the result of the command execution or an <code class="literal">application/octet-stream</code> message containing the downloaded file.</p>
<p>The <span class="application">WebIssues</span> client must correctly handle the Set-Cookie and Cookie headers as described in [<a class="ulink" href="http://www.faqs.org/rfcs/rfc2109.html" target="_top">RFC 2109</a>]. The name of the <span class="application">WebIssues</span> session cookie is <code class="literal">WebIssuesSID</code>.</p>
</div>
</div>
<div class="navlinks">
<div class="navleft">« <a accesskey="p" href="resources.html">Resources</a></div>
<div class="navright"><a accesskey="n" href="protocol_headers.html">Headers</a> »</div>
</div>
<div id="copyright">
<p class="copyright">Copyright © 2007-2008 WebIssues Team</p>
</div>
</body>
</html>
|
