Profiles

How can I be notified when a Profile is completed?

Ken Dawson — 2009-06-04T14:36:18Z

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".

Additional information, including the response XML structure, is provided in the documentation and more example code is provided in the Gateway Sample application.

How to add Reference Name to a Professional Reference Order

Ken Dawson — 2010-03-09T17:56:36Z

Joe,

Can you post the results of the call to Service.GetServiceDetail? That may help to track down what needs to be done.

Thanks,
Ken

Race ID

Joe Gotthelf — 2010-03-06T01:20:19Z

The Valid Values are below - apparently these are not yet documented:

AFR

CAU

FEI -- Not sure what this one means.

N/A

What are the values in <ProfSvcStatus></ProfSvcStatus>

Administrator Account — 2009-11-30T22:28:11Z

The ProfSvcStatus element returned by the GetProfileDetail method, will return text like "COMPLETED". The status fields that return integers are:

ProfileStatusID: Profile status
- 0 - Draft
- 1 - In Progress
- 2 - Completed
- 3 - In Review
- 4 - Cancelled
- 5 - Archived
OrderStatus: Status of the individual Order
- 0 - Draft
- 1 - New (the Supplier has not picked it up yet for processing)
- 2 - In Progress (the Supplier is processing the Order)
- 3 - Completed
- 4 - Cancelled
- 5 - Archived

If you are seeing something different in the return XML or if you're calling a different method, please include an example of the XML that is being returned.

How far back does GetProfileReport() work?

Ken Dawson — 2009-10-21T15:00:00Z

It will return any Profile in the system, active or stored. There is no time limit.

How do I make sure an entered social security number is valid?

Kevin Lenahan — 2009-06-26T02:23:26Z

Before saving a Profile, you may want to validate the social security number that was entered.

Here is an example of how you would validate a social security number:

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

/* Validate the social security number. */
XmlNode nodeProfile = gwProfile.ValidateSSN("myUserName", "myPassword", myBOID, "myCustID", "123456789");

}

XML Response:

</ErrorStatus>

<SSN>

</SSN>

</ValidateSSN>

Additional information is provided in the documentation and more example code is provided in the Gateway Sample application.

How do I manually unlock a Profile?

Kevin Lenahan — 2009-06-26T02:14:53Z

While working with a Profile, it is locked in the system using a logical locking scheme to prevent multiple users from opening the Profile and changing it at the same time. Profile locking is generally performed by the system, in the background without any need for additional consideration when programming.

Method calls that indicate the typical end of session with a Profile, will automatically release the lock, for instance Profile.TransmitProfile. Other methods that are typically part of a series of calls on a specific Profile, for instance Profile.AddServiceToProfile, will leave the Profile locked for a period of time (five minutes by default) from the end of the call, until an automatically releasing method is called, or until the lock is manually released using Profile.UnlockProfile. If it is common for users on the site to try and access these Profiles at the same time they are being accessed through Gateway Web Services, then it is good practice to call Profile.UnlockProfile to ensure that the lock has been released.

For example, if finished working with Profile # 2009010112345600 then call Profile.UnlockProfile.

Here is an example of how you would unlock the profile:

/* 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.UnlockProfile("myUserName", "myPassword", myBOID, "myCustID", "2009010112345600");

}

XML Response:

</ErrorStatus>

</Profile>

</UnlockProfile>

Additional information is provided in the documentation and more example code is provided in the Gateway Sample application.