Loading...

How To Set Up REST access for your organisation

The steps to set up REST access for your organisation differs depending on whether the PTE has their NSI Login Credentials or not.

If you have submitted the testing procedure and the Ministry confirms your REST access activation is successful, please skip to Step 3: Set Up your live account in Wisenet

1

Do you already have NSI Access?

Required Portal Access: Admin

If you do NOT have NSI access OR you have not set up an ESL account within the NSI website OR your NSI login does not connect in Wisenet then you will need to go to STEP 2.

If you already have NSI access that is web service enabled then it is best to first try to see if the connection is successful. To do this you need to configure this in the Portal settings:

  • Navigate to Portal > My Account
  • Under the Actions column for the profile you want to edit, Click Show Settings
  • Scroll to look for the Wisenet heading
  • Enter and Save the following information into these fields:

  • Then, navigate to LRM > Learners
  • On the Left Navigation Bar, Click View All
  • Select a Learner to view the Learner’s Profile
  • Click Actions and Select Edit Personal
  • Next to the NSN Bar, Click on the Binoculars Icon to search for a Learner record by NSN or any other criteria
  • Click Search
  • Verify there are no errors displayed on screen.

If there are no errors, your Wisenet NSN REST Service is live and working. If there are errors then you need to

  • Double check that you entered the settings above correctly, then logout and login to LRM and test again
  • Go through the NSI web service process. See Step 2.

2

Email the Ministry requesting access to NSI REST Interface (web service)

The process to obtain NSI access is controlled by the MoE and can take some time. An overview of the steps:

  1. Send an email to MoE requesting REST access
  2. Engage with MoE to coordinate the REST access process
  3. Will likely need to complete an NSI test process
  4. Only after this is approved will you be able to obtain production access

Follow the instructions below:

Email Details

Email To Address: service.desk@education.govt.nz

Subject: Request NSI Rest Access

Body: 

Hello

We are setting up our organisation to use the Wisenet SMS and need our NSI account to be activated to use the NSI REST Interface.

Our current details are:

TEO Provider Number: enter your details
Username: enter your details

We hope to be able to use the Wisenet compliant NSI interface as soon as possible, could you please provide us with REST access.

Regards,

enter your details

3

Complete the NSI Testing Process

Required Portal Access: Admin

Once you have received the testing procedure, web service username and password from the Ministry, you will need to test that the implemented NSI REST interface functions correctly and send the results back to them.

Please see our detailed How to Test NSI REST Interface guide on how to complete this process.

4

Go Live with NSI integration

Required Portal Access: Admin

Once the MoE approves your NSI REST access you will be able to use your NSI login details to configure the NSI integration. See Step 1 above.

If there are red error messages appearing in your NSI REST interface, please see NSN FAQ to troubleshoot.

Was this Resource helpful?