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 PerfectApps notifications sent to the logged on user and display them in that portal. The account setting External Portal must be turned on in the PerfectApps 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 app (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 app 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: app.perfectforms.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.PerfectApps.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.PerfectApps.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.PerfectApps.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: app.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.PerfectApps.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.PerfectApps.com/Portal"> <GetNotificationsListResult>int</GetNotificationsListResult> <tokenOut>string</tokenOut> <list>string</list> </GetNotificationsListResponse> </soap12:Body> </soap12:Envelope> |
See also: GetReportsList
Return to: PerfectApps API, Integration
