% pandoc -f native -t rst --list-tables
[Para [Str "Here",Space,Str "is",Space,Str "an",Space,Str "example",Space,Str "of",Space,Str "a",Space,Str "request",Space,Str "packet",Space,Str "sent",Space,Str "to",Space,Str "the",Space,Str "Plesk",Space,Str "server:"]
,Table [] [AlignDefault,AlignDefault] [0.5,0.5]
[[]
,[]]
[[[CodeBlock ("",[],[]) "POST /enterprise/control/agent.php HTTP/1.1\nHost: 10.58.83.1:8443\nAccept: */*\nHTTP_AUTH_LOGIN: admin\nHTTP_AUTH_PASSWD: setup\nPragma: no-cache\nContent-Length: 1398\nContent-Type: text/xml"]
,[Para [Str "HTTP",Space,Str "header"]
,Para [Str "The",Space,Str "HTTP",Space,Str "header",Space,Str "indicates",Space,Str "that",Space,Str "the",Space,Str "HTTP",Space,Str "method",Space,Str "used",Space,Str "is",Space,Str "POST,",SoftBreak,Str "the",Space,Str "handling",Space,Str "agent",Space,Str "is",Space,Str "located",Space,Str "at",SoftBreak,Code ("",["docutils","literal"],[]) "/enterprise/control/agent.php,",Space,Str "and",Space,Str "the",Space,Str "HTTP",Space,Str "version",Space,Str "is",SoftBreak,Str "1.1.",Space,Str "The",Space,Code ("",["docutils","literal"],[]) "Host",Space,Str "element",Space,Str "specifies",Space,Str "the",Space,Str "IP",Space,Str "address",Space,Str "and",Space,Str "port",Space,Str "of",SoftBreak,Str "the",Space,Str "server",Space,Str "to",Space,Str "which",Space,Str "the",Space,Str "message",Space,Str "is",Space,Str "addressed.",SoftBreak,Code ("",["docutils","literal"],[]) "HTTP_AUTH_LOGIN",Space,Str "and",Space,Code ("",["docutils","literal"],[]) "HTTP_AUTH_PASSWD",Space,Str "elements",Space,Str "hold",Space,Str "the",SoftBreak,Str "Administrator's",Space,Str "credentials.",Space,Str "The",Space,Code ("",["docutils","literal"],[]) "Content-Type",Space,Str "must",Space,Str "be",SoftBreak,Str "\"text/xml\".",Space,Str "The",Space,Str "length",Space,Str "of",Space,Str "the",Space,Str "passed",Space,Str "message",Space,Str "is",Space,Str "also",Space,Str "required."]]]
,[[CodeBlock ("",[],[]) "<?xml version=\"1.0\" encoding=\"UTF-8\" ?>"]
,[Plain [Str "XML",Space,Str "declaration"]]]
,[[CodeBlock ("",[],[]) "<packet>"]
,[Plain [Str "Packet",Space,Str "header"]]]
,[[CodeBlock ("",[],[]) "<customer>\n <add>\n <gen_info>\n <cname>LogicSoft Ltd.</cname>\n <pname>Stephen Lowell</pname>\n <login>stevelow</login>\n <passwd>Jhtr66fBB</passwd>\n <status>0</status>\n <phone>416 907 9944</phone>\n <fax>928 752 3905</fax>\n <email>host@logicsoft.net</email>\n <address>105 Brisbane Road, Unit 2</address>\n <city>Toronto</city>\n <state/>\n <pcode/>\n <country>CA</country>\n </gen_info>\n </add>\n</customer>", Plain [Str "Packet",Space,Str "header"]]
,[Para [Str "Packet",Space,Str "body"]
,Para [Str "Always",Space,Str "starts",Space,Str "from",Space,Str "the",Space,Str "tag",Space,Str "of",Space,Str "the",Space,Str "related",Space,Str "operator."]
,Para [Str "This",Space,Str "particular",Space,Str "packet",Space,Str "uses",Space,Str "the",Space,Str "customer",Space,Str "operator",Space,Str "to",Space,Str "create",Space,Str "a",SoftBreak,Str "customer",Space,Str "account.",Space,Str "The",Space,Str "elements",Space,Str "nested",Space,Str "within",Space,Str "the",Space,Code ("",["docutils","literal"],[]) "gen_info",Space,Str "node",SoftBreak,Str "contain",Space,Str "the",Space,Str "profile",Space,Str "details."]
,Para [Str "The",Space,Str "structure",Space,Str "of",Space,Str "the",Space,Str "packet",Space,Str "body",Space,Str "is",Space,Str "compliant",Space,Str "with",Space,Str "the",SoftBreak,Code ("",["docutils","literal"],[]) "client_input.xsd",Space,Str "XML",Space,Str "schema",Space,Str "of",Space,Str "XML",Space,Str "API",Space,Str "1.6.3.0."]]]
,[[CodeBlock ("",[],[]) "</packet>"]
,[Plain [Str "Trailing",Space,Str "tag",Space,Str "closing",Space,Str "the",Space,Str "packet"]]]]]
^D
Here is an example of a request packet sent to the Plesk server:
.. list-table::
:widths: 36 36
-
- ::
POST /enterprise/control/agent.php HTTP/1.1
Host: 10.58.83.1:8443
Accept: */*
HTTP_AUTH_LOGIN: admin
HTTP_AUTH_PASSWD: setup
Pragma: no-cache
Content-Length: 1398
Content-Type: text/xml
- HTTP header
The HTTP header indicates that the HTTP method used is POST,
the handling agent is located at
``/enterprise/control/agent.php,`` and the HTTP version is 1.1.
The ``Host`` element specifies the IP address and port of the
server to which the message is addressed. ``HTTP_AUTH_LOGIN``
and ``HTTP_AUTH_PASSWD`` elements hold the Administrator's
credentials. The ``Content-Type`` must be "text/xml". The
length of the passed message is also required.
-
- ::
<?xml version="1.0" encoding="UTF-8" ?>
- XML declaration
-
- ::
<packet>
- Packet header
-
- ::
<customer>
<add>
<gen_info>
<cname>LogicSoft Ltd.</cname>
<pname>Stephen Lowell</pname>
<login>stevelow</login>
<passwd>Jhtr66fBB</passwd>
<status>0</status>
<phone>416 907 9944</phone>
<fax>928 752 3905</fax>
<email>host@logicsoft.net</email>
<address>105 Brisbane Road, Unit 2</address>
<city>Toronto</city>
<state/>
<pcode/>
<country>CA</country>
</gen_info>
</add>
</customer>
Packet header
- Packet body
Always starts from the tag of the related operator.
This particular packet uses the customer operator to create a
customer account. The elements nested within the ``gen_info``
node contain the profile details.
The structure of the packet body is compliant with the
``client_input.xsd`` XML schema of XML API 1.6.3.0.
-
- ::
</packet>
- Trailing tag closing the packet
Zero widths are not allowed in rST so we omit them
% pandoc -f native -t rst --list-tables
[Table [] [AlignDefault,AlignDefault] [0.0,0.0]
[[]
,[]]
[[[Para [Str "1 1"]]
,[Para [Str "1 2"]]]
,[[CodeBlock ("",[],[]) "2 1"]
,[Plain [Str "2 2"]]]]]
^D
.. list-table::
-
- 1 1
- 1 2
-
- ::
2 1
- 2 2