GetNotificationsList

 Previous  Home topic  Next  Print this topic Send Feedback

The method was added to facilitate external portal integration. This method can allow a user with an external portal to retrieve a list of all active PerfectForms™ notifications sent to the logged on user and display them in that portal. The account setting External Portal must be turned on in the PerfectForms™ application for that user in order for this method to work.

 

Send Params

Return Params

tokenln - This is the security token that is obtained by the previous API call. See API Security for more details.
•list - This is the XML document which contains data for each form (name, etc.)

 

•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/GetNotificationsList"

 

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

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

      <tokenIn>string</tokenIn>

    </GetNotificationsList>

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

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

      <GetNotificationsListResult>int</GetNotificationsListResult>

      <tokenOut>string</tokenOut>

      <list>string</list>

    </GetNotificationsListResponse>

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

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

      <tokenIn>string</tokenIn>

    </GetNotificationsList>

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

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

      <GetNotificationsListResult>int</GetNotificationsListResult>

      <tokenOut>string</tokenOut>

      <list>string</list>

    </GetNotificationsListResponse>

  </soap12:Body>

</soap12:Envelope>

 

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