IT Provisioning - Web Service API RA IT Provisioning Update
Receiving Agency Related Guide (RARG)
This guide is applicable only to Alberta at the moment.
Summary:
Authorized users can use this Web Service to update RA IT Provisioning details on student profiles.
Background
For agencies using the RA IT Provisioning functionality (described in the IT Provisioning - Information for Receiving Agency Automation - Entry of student information (for Placing and Receiving Coordinators) guide), a user with API access can automate the entry and update of the Receiving Agency-specific data fields on student profiles.
Accessing the Web Service
Authorized users will be provided with the URL for their province, web service, and account ID, such as:
https://localservername/HSPnetxx/WebServices/ITProvisioningService.asmx/RAITProvisionUpdate?user=YOURUSERID&pw=YOURPASSWORD&usertype=Student&firstname=Roberta&lastname=Truman&hspnetid=2705&uniqueid=&loginid=rtruman&Email=&EmailRequired=&Employee=1&overwrite=0
The highlighted variables above must be specified for each request via the web service:
|
localservername |
To be provided by Help Desk for each new web service account |
|
HSPnetxx |
|
|
YOURUSERID |
HSPnet user ID to be sent via automated email when the account is created |
|
YOURPASSWORD |
Permanent password to be set by the user upon their first login |
The following parameters are available for updating:
| Parameter | Sample | Notes |
|---|---|---|
| UserType | Student | Mandatory parameter identifying whether the record to update is a Student or Instructor in HSPnet |
| FirstName | Roberta | Mandatory parameter, first name on HSPnet record |
| LastName | Truman | Mandatory parameter, last name on HSPnet record |
| HSPnetID | 2705 | Mandatory parameter, HSPnet ID of the record to be updated |
| UniqueID | XYZ123 | Optional parameter, Receiving Agency-specific identifier for the record (e.g. IGUID) |
| LoginID | rtruman | Optional parameter, Receiving Agency-specific login or network ID |
| rtruman@xyz.org | Optional parameter, Receiving Agency-issued email address | |
| EmailRequired | 0 | Optional parameter, boolean value (*0* or *1*) indicating whether an RA-issued email address is required for this student/instructor |
| Employee | 1 | Optional parameter, boolean value (*0 *or *1*) indicating whether the individual is a current or previous employee of the RA |
| Overwrite | 0 | Optional parameter, boolean value (*0 *or *1*) indicating whether unspecified parameters should overwrite (blank) any existing values on the HSPnet record |