PeopleAggregator API: method peopleaggregator.exceptionTest

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

Method: peopleaggregator.exceptionTest

Error test method, that takes no arguments and throws an exception.

User documentation for peopleaggregator.exceptionTest 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:

Return value (see also Exceptions)

Type: hash

Attributes:

success

Type: boolean

Should always fail - so false

Example: False

Example REST (XML) request

Request

GET /api/xml/peopleaggregator/exceptionTest? HTTP/1.1

Response

HTTP/1.1 200 OK

Content-Type: application/xml

Content-Length: 90



<response>

 <success>false</success>

</response>

Example REST (JSON) request

Request

GET /api/json/peopleaggregator/exceptionTest? HTTP/1.1

Response

HTTP/1.1 200 OK

Content-Type: application/x-javascript

Content-Length: 18



{"success": false}

Example XML-RPC call

Request

POST /api/xmlrpc HTTP/1.1

Content-Type: text/xml

Content-Length: 431



<?xml version='1.0'?>

 <methodCall>

  <methodName>peopleaggregator.exceptionTest</methodName>

  <params>

   <param>

    <value><struct>

    </struct></value>

   </param>

  </params>

 </methodCall>

Response

HTTP/1.1 200 OK

Content-Type: text/xml

Content-Length: 627



<?xml version='1.0'?>

 <methodResponse>

  <params>

   <param>

    <value><struct>

     <member>

      <name>success</name>

      <value><boolean>0</boolean></value>

     </member>

    </struct></value>

   </param>

  </params>

 </methodResponse>