This is a common question when setting up integrations with other systems, like an ATS or HRIS.  The automated delivery of reports via e-mail will make sure that a person(s) is informed of the completed Profile, but how do we let another system know?

The NotificationRequest method on the Profile web service provides the solution.  When this method is called for a Profile, the Profile will be monitored for changes in status.  When the Profile is completed or cancelled, a notification will be sent based on the settings that were provided.

For example, if Profile # 2009010112345678 is set for notification with the type of “URL” and a value of http://notify.test.com/notify.aspx, upon completion or cancellation the system will call the given page with the querystring variables attached. Notification call: http://notify.test.com/notify.aspx?prof_no=2009010112345678&custid=ABC_00001&status=COMPLETED        

Here is an example of how you could call this method for the above scenario:

/* Get a reference to the web service */
using (GatewaySample.net.clearstar.gateway.profile.Profile gwProfile = new GatewaySample.net.clearstar.gateway.profile.Profile())
{

/* Release the lock on the Profile. */
XmlNode nodeProfile = gwProfile.NotificationRequest("myUserName", "myPassword", myBOID, "myCustID", "2009010112345678", "URL", "https://notify.test.com/notify.aspx");

}

Currently, only URL notification (sNotificationType = "URL") is supported.  When the URL is called, three querystring variables will be added to the URL that you provide in the sNotificationValue parameter - prof_no, custid, and status.  prof_no will be the Profile ID for the Profile.  custid will be the Customer ID for the Profile.  status will be that status of the Profile and the value will be either "COMPLETED" or "CANCELLED".