PeopleAggregator API: method peopleaggregator.echoPost

Arguments | Return value | REST (XML) example | REST (JSON) example | XML-RPC example

Method: peopleaggregator.echoPost

POST-type echo test method, that just sends back its input data.
User documentation for peopleaggregator.echoPost on the PeopleAggregator wiki

Arguments (see also Authentication)

If calling by XML-RPC, note that this method takes a single struct as input, with the following keys:

echoText

Type: string
Text to return to the caller.
Example: Iñtërnâtiônàlizætiøn

Return value (see also Exceptions)

Type: hash

Attributes:

success

Type: boolean
True on success, false on failure.
Example: True

echoText

Type: string
The string that was passed by the caller.
Example: Iñtërnâtiônàlizætiøn

Example REST (XML) request

Request

POST /api/xml/peopleaggregator/echoPost HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 43

echoText=I%F1t%EBrn%E2ti%F4n%E0liz%E6ti%F8n

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 216

<response>
 <echoText>I&#241;t&#235;rn&#226;ti&#244;n&#224;liz&#230;ti&#248;n</echoText>
 <success>true</success>
</response>

Example REST (JSON) request

Request

POST /api/json/peopleaggregator/echoPost HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 43

echoText=I%F1t%EBrn%E2ti%F4n%E0liz%E6ti%F8n

Response

HTTP/1.1 200 OK
Content-Type: application/x-javascript
Content-Length: 88

{"echoText": "I\u00f1t\u00ebrn\u00e2ti\u00f4n\u00e0liz\u00e6ti\u00f8n", "success": true}

Example XML-RPC call

Request

POST /api/xmlrpc HTTP/1.1
Content-Type: text/xml
Content-Length: 723

<?xml version='1.0'?>
 <methodCall>
  <methodName>peopleaggregator.echoPost</methodName>
  <params>
   <param>
    <value><struct>
     <member>
      <name>echoText</name>
      <value><string>Iñtërnâtiônàlizætiøn</string></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodCall>
 

Response

HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 924

<?xml version='1.0'?>
 <methodResponse>
  <params>
   <param>
    <value><struct>
     <member>
      <name>echoText</name>
      <value><string>Iñtërnâtiônàlizætiøn</string></value>
     </member>
     <member>
      <name>success</name>
      <value><boolean>1</boolean></value>
     </member>
    </struct></value>
   </param>
  </params>
 </methodResponse>