PerfectApps ® Help Guide

•cancelWhenOpen - If set to true, viewing the app is enough to cancel the notification. If set to false, a submit will cancel it.

•emailAddress - This is the e-mail address we want the notification to go to.

•appId - This is the ID of the app we want the notification to be sent from.

•instanceId - This is the ID of the instance of the app we want the notification to be sent from.

•messageBody - This is the body of the notification.

•messageSubject - This is the subject of the notification.

•name - This is the name that is used to display the notification in PerfectApps.

•roleName - This is the workflow role associated with the notification.

•sendEmail - True if we want the email to be sent or false if we only want it to appear as notification without a physical e-mail.

•tokenIn - This is the security token that is obtained by the previous API call. See the API Security topic for more details.

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.

POST /api/API.asmx HTTP/1.1

Host: app.perfectforms.com

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

Content-Length: length

SOAPAction: "http://www.PerfectApps.com/API/Notify"

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

    <Notify xmlns="http://www.PerfectApps.com/API">

      <tokenIn>string</tokenIn>

      <appId>string</appId>

      <instanceId>int</instanceId>

      <attentionLevel>unsignedByte</attentionLevel>

      <name>string</name>

      <roleName>string</roleName>

      <emailAddress>string</emailAddress>

      <sendEmail>boolean</sendEmail>

      <messageSubject>string</messageSubject>

      <messageBody>string</messageBody>

      <cancelWhenOpen>boolean</cancelWhenOpen>

      <minutes>int</minutes>

    </Notify>

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

    <NotifyResponse xmlns="http://www.PerfectApps.com/API">

      <NotifyResult>int</NotifyResult>

      <tokenOut>string</tokenOut>

    </NotifyResponse>

  </soap:Body>

</soap:Envelope>

POST /api/API.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>

    <Notify xmlns="http://www.PerfectApps.com/API">

      <tokenIn>string</tokenIn>

      <appId>string</appId>

      <instanceId>int</instanceId>

      <attentionLevel>unsignedByte</attentionLevel>

      <name>string</name>

      <roleName>string</roleName>

      <emailAddress>string</emailAddress>

      <sendEmail>boolean</sendEmail>

      <messageSubject>string</messageSubject>

      <messageBody>string</messageBody>

      <cancelWhenOpen>boolean</cancelWhenOpen>

      <minutes>int</minutes>

    </Notify>

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

    <NotifyResponse xmlns="http://www.PerfectApps.com/API">

      <NotifyResult>int</NotifyResult>

      <tokenOut>string</tokenOut>

    </NotifyResponse>

  </soap12:Body>

</soap12:Envelope>