GetListOfUsers

 Previous  Home topic  Next  Print this topic Send Feedback

The GetListOfUsers method allows you to retrieve the list of users through the API.

 

int GetListOfUsers(string tokenIn, out string tokenOut, out string usersList)

 

 

Send Params

Return Params
•tokenIn - This is the security token that is obtained by the previous API call. See the API Security topic for more details.
•usersList - This is the list of users.

tokenOut - This is the new security token that should be used for the next Web service call after this one. See the API Security topic for more details.

 

 

Test

The test form is only available for requests from the local machine.

 

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/API/GetListOfUsers"

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetListOfUsers xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

    </GetListOfUsers>

  </soap:Body>

</soap:Envelope>

 

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Body>

    <GetListOfUsersResponse xmlns="http://www.PerfectForms.com/API">

      <GetListOfUsersResult>int</GetListOfUsersResult>

      <tokenOut>string</tokenOut>

      <usersList>string</usersList>

    </GetListOfUsersResponse>

  </soap:Body>

</soap:Envelope>

 

 

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

 

POST /api/API.asmx HTTP/1.1

Host: testing.perfectforms.com

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <GetListOfUsers xmlns="http://www.PerfectForms.com/API">

      <tokenIn>string</tokenIn>

    </GetListOfUsers>

  </soap12:Body>

</soap12:Envelope>

 

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

 

<?xml version="1.0" encoding="utf-8"?>

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">

  <soap12:Body>

    <GetListOfUsersResponse xmlns="http://www.PerfectForms.com/API">

      <GetListOfUsersResult>int</GetListOfUsersResult>

      <tokenOut>string</tokenOut>

      <usersList>string</usersList>

    </GetListOfUsersResponse>

  </soap12:Body>

</soap12:Envelope>

 

Updated: 06/12/2011  Page url: http://www.perfectforms.com/Documentation/manual/html/?fg_getlistofusers.htm
PerfectForms™ -- forms software, workflow software, and business process management