Skip to main content

IT Provisioning - Web Service API RA IT Provisioning Update

                        1. 
                                <span>[Knowledge Base](index.html)</span>
                            
                                            
                </div>
                # &#10;                                                <span id="title-text">&#10;                            Knowledge Base : IT Provisioning - Web Service API RA IT Provisioning Update&#10;                        </span>&#10;                    
            </div>

            <div id="content" class="view">
                <div class="page-metadata">
                    
    


    

    
    
        Created by <span class="author"> Yann Gomez</span>, last modified by <span class="editor"> Erik Graham</span> on Feb 08, 2022
                    </div>
                <div id="main-content" class="wiki-content group">
                **
Receiving Agency Related Guide (RARG)****Summary:

Summary:

This guide is applicable only to Alberta at the moment.

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

ParameterSampleNotes
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
UniqueIDXYZ123Optional parameter, Receiving Agency-specific identifier for the record (e.g. IGUID)
LoginIDrtrumanOptional parameter, Receiving Agency-specific login or network ID
Emailrtruman@xyz.orgOptional parameter, Receiving Agency-issued email address
EmailRequired0Optional parameter, boolean value (*0* or *1*) indicating whether an RA-issued email address is required for this student/instructor
Employee1Optional parameter, boolean value (*0 *or *1*) indicating whether the individual is a current or previous employee of the RA
Overwrite0Optional parameter, boolean value (*0 *or *1*) indicating whether unspecified parameters should overwrite (blank) any existing values on the HSPnet record
            </div>             </div> 
        <div id="footer" role="contentinfo">
            <section class="footer-body">
                Document generated by Confluence on Nov 03, 2023 14:28
                <div id="footer-logo">[Atlassian](https://www.atlassian.com/)</div>
            </section>
        </div>
    </div>
Back to top