From 6fa7197105549511abdde6096b31e6b132696f14 Mon Sep 17 00:00:00 2001 From: Charles Kerr Date: Tue, 10 Feb 2009 18:19:09 +0000 Subject: [PATCH] (trunk doc) tweak the RPC spec as suggested by chorlya --- doc/rpc-spec.txt | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/rpc-spec.txt b/doc/rpc-spec.txt index 24d193ce7..c194bcb50 100644 --- a/doc/rpc-spec.txt +++ b/doc/rpc-spec.txt @@ -48,10 +48,16 @@ 2.3. Transport Mechanism HTTP POSTing a JSON-encoded request is the preferred way of communicating - with a Transmission RPC server; however, a simple notation also exists - for sending requests in the query portion of a URL. + with a Transmission RPC server. The current Transmission implementation + has the default URL as http://host:9091/transmission/rpc. Clients + may use this as a default, but should allow the URL to be reconfigured, + since the port and path may be changed to allow mapping and/or multiple + daemons to run on a single server. + + In addition to POSTing, there's also a simple notation for sending + requests in the query portion of a URL. This is not as robust, but can + be useful for debugging and simple tasks. The notation works as follows: - The URL notation works as follows: (1) Any key not "tag" or "method" is treated as an argument. (2) The "arguments" key isn't needed, since data isn't nested. (3) If the value in a key/value pair can be parsed as a number, then it is. @@ -61,6 +67,7 @@ Examples: ?method=torrent-start&ids=1,2 ?method=session-set&speed-limit-down=50&speed-limit-down-enabled=1 + 3. Torrent Requests @@ -244,7 +251,8 @@ { "arguments": { - "fields": [ "id", "name", "totalSize" ] + "fields": [ "id", "name", "totalSize" ], + "ids": [ 7, 10 ] }, "method": "torrent-get", "tag": 39693