PlayerLogin

 Previous  Home topic  Next  Print this topic Send Feedback

This method returns the URL and HTML code that allows any of the forms/reports/notifications to be played. If the URL and HTML code is used to start the player, the user will automatically be logged in to this player. He or she will not be presented with the login page again.

 

Send Params

Return Params
•linkId - This is the link ID of the form/report/notification.  It is taken from the list XML document that contains data for each form.
•tokenln - This is the security token that is obtained by the previous API call. See API Security for more details.
•embed - This is the HTML code needed to embed the player inside an HTML page.
•link - This is the URL needed to start the player in a new browser window.
•loginID - For advanced use.
•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/portal.asmx HTTP/1.1

Host: testing.perfectforms.com

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

Content-Length: length

SOAPAction: "http://www.PerfectForms.com/Portal/PlayerLogin"

 

<?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>

    <PlayerLogin xmlns="http://www.PerfectForms.com/Portal">

      <tokenIn>string</tokenIn>

      <linkId>string</linkId>

    </PlayerLogin>

  </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>

    <PlayerLoginResponse xmlns="http://www.PerfectForms.com/Portal">

      <PlayerLoginResult>int</PlayerLoginResult>

      <tokenOut>string</tokenOut>

      <loginId>string</loginId>

      <link>string</link>

      <embed>string</embed>

    </PlayerLoginResponse>

  </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/portal.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>

    <PlayerLogin xmlns="http://www.PerfectForms.com/Portal">

      <tokenIn>string</tokenIn>

      <linkId>string</linkId>

    </PlayerLogin>

  </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>

    <PlayerLoginResponse xmlns="http://www.PerfectForms.com/Portal">

      <PlayerLoginResult>int</PlayerLoginResult>

      <tokenOut>string</tokenOut>

      <loginId>string</loginId>

      <link>string</link>

      <embed>string</embed>

    </PlayerLoginResponse>

  </soap12:Body>

</soap12:Envelope>

 

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