guide to integrating with the nsi - education...

NATIONAL STUDENT

INDEXREST Interface Test Scripts

Version 0.5 – March 2016

Table of Contents

Table of Contents........................................................................................................21 Document Information..........................................................................................3

1.1 Version Control................................................................................................31.2 Related Documentation...................................................................................3

2 Introduction..........................................................................................................42.1 Purpose of REST Interface Testing.................................................................42.2 Intended Audience..........................................................................................42.3 Overview of REST Interface Tests..................................................................42.4 Testing URL....................................................................................................42.5 Tips for Testers...............................................................................................5

3 Search Test Scripts..............................................................................................63.1 SEARCH – NSN..............................................................................................63.2 SEARCH – Name and Birth Date....................................................................73.3 SEARCH – Name Only...................................................................................83.4 SEARCH – Alternative Name..........................................................................9

4 Add Record Test Scripts....................................................................................104.1 ADD – Unverified record – Record A............................................................104.2 ADD – Unverified record with alternative name – Record B..........................124.3 ADD – Verified record – Record C................................................................144.4 ADD – Verified record – Possible match – Record D....................................164.5 ADD – Verified record – Definite match........................................................18

5 Update Record Test Scripts...............................................................................205.1 UPDATE – Name..........................................................................................205.2 UPDATE – Verification information...............................................................225.3 UPDATE – Unsuccessful update attempt.....................................................24

6 Merge Record Test Scripts................................................................................256.1 MERGE – No manual intervention required..................................................256.2 MERGE – Manual intervention required........................................................26

7 Create/Update Student-Provider Relationships.................................................277.1 STUDENT-PROVIDER RELATIONSHIP – Add Relationship.......................277.2 STUDENT-PROVIDER RELATIONSHIP – Update existing Relationship.....29

8 Change Notifications / Challenge student details...............................................308.1 CHANGE NOTIFICATIONS - Retrieve Change Notifications........................308.2 CHALLENGE - Challenge student details.....................................................32

NSI REST Interface Testing, Ministry of Education, v0.5 – March 2016 of 33

1 Document Information

1.1 Version ControlName Date Version CommentsJonathan Semu 29/05/2015 0.1 Newly developed SMS certification

scripts to ensure SMS is thoroughly tested.

Jonathan Semu 23/07/2015 0.2 Rename document to NSI REST Interface Test Scripts Update scripts to be generic for REST Interface testing

Jacqui Smith 15/03/2015 0.3 Minor revisions based on vendor feedbackIncluded Section 8 Change Notifications / Challenge student details

Kerry Pilcher 18/05/2016 0.4 Update REST test scripts Compliance refresh info, reference ESAA & NSI URLs', search - remove reference to Record status

Kerry Pilcher 21/07/2016 0.5 Update Rest test script: (6.2) to request merge via entering NSN’s directly into Merge Request; (7.1 & 7.2 ) to include step to request Service desk confirm successful add / update of SPR.

1.2 Related DocumentationDocument title Version StatusGINS (Guide for Integrating with NSI)

Latest version Available via STEO website. http://steo.govt.nz/nsi/

NSI Informationhttp://www.education.govt.nz/further-education/tertiary-administration/national-student-index-nsi/information-for-users/

Web Published09 July 2015


2 Introduction

2.1 Purpose of REST Interface TestingThe purpose of the REST Interface testing described in this document is to formally test that the implemented programmatic interface between a provider’s student management system (SMS) and the National Student Index (NSI) functions correctly. It is expected that before this testing takes place the provider will have completed their own testing to ensure that the implemented interface works in the way that is required by their own organisation.

The REST Interface testing is intended to provide the SMS vendor, provider and the Ministry of Education with the confidence that the implemented NSI REST interface allows data to be successfully transferred without causing either system to malfunction before the provider commences their use of the live NSI system.

2.2 Intended AudienceThis document is intended for staff carrying out REST Interface testing as part of a SMS Vendor, or a provider organisation or Ministry of Education staff.

2.3 Overview of REST Interface TestsThe REST Interface tests cover all of the areas of NSI functionality that you are able to access via the REST interface. The tests are divided into each of the following main areas:

searching for an existing NSI record; creating a new record; updating an existing record; merging two or more NSI records; creating/updating a Student-Provider relationship retrieving Change Notifications challenge a change that another provider has made to one of your student’s

NSI record

There are test scripts that relate to each of these main areas. These scripts are essentially checklists that detail precisely what is being tested and in what sequence.

2.4 Testing URL

This testing will be done against a non production NSI database. Before starting you will need to update the NSI URL within your SMS to the Compliance URL (See section 5.2 REST Interface in the GINS document):


On successful completion of the testing you should update the NSI URL within your SMS to the Production URL (See section 5 REST interface in the GINS document).:

2.5 Tips for TestersLogin is only required prior to the first NSI transaction. The Login will need to be repeated if you have a period of inactivity that causes your login to be timed out (20 mins).Testing will be most successful if you ensure that:

You enter the exact data in the test script. If all of the data cannot be entered, or alternate data is entered, you should provide an explanation on the template.

You execute the tests in order because the test scripts have been designed to be carried out sequentially, for example the record you create in 4.1 is subsequently updated in 5.1.

You keep a full record of any errors or issues that arise – e.g. take a screen shot of any errors.

The NSI Compliance database is refreshed from Production on the 1st Tuesday of each month. Plese ensure your testing is completed and results forwarded to MoE by the 25th of the month. This will ensure we have enough time to review your tests before the database refresh.


3 Search Test Scripts

These tests are intended to ensure that the provider can use their NSI REST interface to locate existing NSI records.

3.1 SEARCH – NSNProvider is enrolling a new student who has given the provider their National Student Index number (NSN). Provider enrols student and searches for an existing NSI record as part of this process.

Record details are returned from NSI. If all details are correct then the provider uses the existing NSI record.

Please complete the ‘Actual Output’ column and record any comments in the Notes section below.

NSI Action on your SMS

Input Expected Output Actual Output Pass? (Y/N)

Log into NSI Perform Search for student

Student NSN: NSN 100236560

Search executes successfully.

One NSI record is returned that relates to the NSN entered by the provider.

Record was created by NZQA and should have date of birth 14-08-1941

Pera Jones, 14/08/1941

Notes:


3.2 SEARCH – Name and Birth DateProvider is enrolling a new student who has not given the provider an NSN. Provider enrols student and searches for an existing NSI record as part of this process.

Record details are returned from NSI. If an NSN exists and all details are correct then the provider uses the existing NSI record.



Input Expected Output Actual Output Pass? (Y/N)


Student Name: Name: Warner Jeffrey

Roberts Birth date: 03 Jul 1980


NSI record 114931355 is returned.

Other NSI records may also be returned

Notes:


3.3 SEARCH – Name OnlyProvider is enrolling a new student who has not given the provider their NSN. Provider enrols student and searches for an existing NSI record as part of this process.




Input Expected output Actual output Pass? (Y/N)


Student Name: Name: Richard Williamson


NSI record 2890789 (Richard Francis Williamson 12 Aug 1980) is returned. Other NSI records may also be returned.

The returned data (search matches) will include at least student name and date of birth.

Notes:


3.4 SEARCH – Alternative NameProvider is enrolling a new student who has not given the provider their NSN. Provider enrols student and searches for an existing NSI record as part of this process.






Student Name: Name: Alex Carter Birth date: 11/02/1982


Student Resource returned A match is found on student’s

alternative name (match indicator = 2) and NSI record 104399019 (Primary name, ‘Alexandra Carter’) is returned.

Other NSN’s may also be returned.

The search results will include at least student name and date of birth.

Notes:


4 Add Record Test Scripts

These tests are intended to ensure that the provider can use their NSI REST interface to create new NSI records. In completing these tests you will be creating four new NSI records which are referred to in the following scripts as records A, B, C and D. As you will use these records again in later tests it is important that you keep a note of the NSNs that you create for each of these new records.

4.1 ADD – Unverified record – Record AProvider is enrolling a new student who has not given an NSN. Provider enrols student and searches for an existing NSI record as part of this process.

No record can be found on the NSI and the provider creates a new record.





Details to enter: Family name: Street name

where your provider is located

Given name 1: Your own first name

Birth date: Today’s date – 3 years


Message 785 returned (No search results found).

Create student using add function.

Enter student details into add function.

New NSI record saved in the NSI database.

NSN and Message 941

Record the new NSN. (Note – this is the NSN for record A):




Details to enter: Family name: Street name

where your provider is located.


Gender: Your gender Birth date: Today’s date – 3

years Name & Birth date

verification: Unverified Residential status: Unknown Residential status

verification: Unverified

returned (Student record successfully saved. Please note this record has ‘Unverified’ details.)

Record the message returned

Notes:


4.2 ADD – Unverified record with alternative name – Record BProvider is enrolling a new student who has not given an NSN. Provider enrols student and searches for an existing NSI record as part of this process.

No record can be found on the NSI and the provider creates a new record that includes the student’s alternative name (i.e. alias or former name).





Details to enter: Family name: Name of the

suburb/town where your provider is located


Given name 2: Name of the region where your provider is located

Date of Birth: Today’s date – 3 years



Create student using create/insert function.

Enter student details into create function. Family name: Name of the

suburb/town where your provider is located

Given name 1: Your own first


Record correctly shows the student’s alternative family name as an alternative name.

Record the new NSN (Note – this is the NSN for record B):





name Given name 2: Name of the

region where your provider is located

Gender: Male Birth date: Today’s date – 3

years Name & birth date

verification: Unverified Residential status: Unknown Residential status

verification: Unverified Alt Family name:

MacPherson Alt Given name 1: Rob Alt Name Pref: Yes Alt Name & birth date

verification: Unverified

NSN and Message 941 returned (Student record successfully saved. Please note this record has ‘Unverified’ details.)are returned.

Notes:


4.3 ADD – Verified record – Record CProvider is enrolling a new student who has not given an NSN. Provider enrols student and searches for an existing NSI record as part of this process.

No record can be found on the NSI and the provider creates a new record that includes verification of all of the data items.


NSI Actionon your SMS



Details to enter: Family name: Name of your

provider Given name 1: Your own first

name Given name 2: Your own

surname Given name 3: Marie Gender: Female Birth date: Today’s date – 20

days



Create student using create/insert function.

Enter student details into create function. Family name: Name of your


name.


NSN and Message 025 returned (Student record successfully saved) are returned.

Record the new NSN (note this is the NSN for record C):





Given name 2: Your own surname.

Given name 3: Marie Gender: Female Birth date: Today’s date – 20

days. Name/DoB verification: Birth

certificate Residential Status:

Permanent resident Res Stat verification:

Passport

Notes:


4.4 ADD – Verified record – Possible match – Record DProvider is enrolling a new student who has not given an NSN. Provider fully enrols the student and searches for an existing NSI record as part of this process.

The search identifies a potential match but after viewing this record the provider determines that in fact the existing NSI record relates to a different student and so creates a new record that includes verification of all of the data items.




Log into NSI Attempt to create student record using create/insert function.


provider followed by the word ‘House’. E,g. ‘Education House’.

Given name 1: Your own first name.

Given name 2: Your own surname

Given name 3: Marie Gender: Female Birth date: Today’s date – 20

days. Name/DoB verification: Birth

certificate.


Override code & details from potential matching record(s) returned.

Record the override code OR if your system deals with the override code behind the scenes then record the details of the potentially matching NSI record that has been returned.




Residential Status: Citizen Res Stat verification:

Passport

Create student using create/insert function but ensure that the override code1 is added to the input data.

Input data from step 2 above. Override code produced from

first create attempt. (If not managed automatically by your system).


NSN and Message 025 returned (Student record successfully saved) are returned.

Record the new NSN (note this is the NSN for record D):

1 Your interface may deal with the override code behind the scenes and instead your system may advise you that a closely matching record has been found and ask you to confirm that you really do want to create new record.


4.5 ADD – Verified record – Definite matchProvider is enrolling a new student who has not given an NSN. Provider fully enrols the student and searches for an existing NSI record as part of this process.

The search identifies a definite match. The provider is unable to create another record in NSI. If this is required as these actually are two different students, the provider should contact MoE Service Desk to have a new NSN added.




Log into NSI Attempt to create student record using create/insert function.


provider. Given name 1: Your own first

name. Given name 2: Marie Given name 3: Your own

surname Gender: Female Date of Birth: Today’s date –

20 days. Name/DoB verification: Birth

certificate. Residential Status: Citizen Res Stat verification:

Add is unsuccessful. Message 921 returned

stating that a Definitie matching NSI record has been found and the Matching NSN details.

This should be the NSN you added in 4.3 (ADD – Verified record – Record C)




Passport

Notes:


5 Update Record Test Scripts

These tests are intended to ensure that the provider can use their NSI REST interface to update existing NSI records. The records that are updated in the following tests will have been created as part of executing the “Add Record Test Scripts”.

5.1 UPDATE – NameAn existing NSI record is found for the student however the details on the NSI record are now out of date and need to be updated to reflect a change in the student’s name.




Log into NSI.Perform Search for student.

Student Name – from record A2

OR, if your SMS requires you to input NSN prior to changing Student details: Student NSN from record A2


Search returns results, including Record A.

Update the name details on record A

Update name. Family name: Johnstone Given name 1: Henry Given name 2: Your own first

name

Update executes successfully.

Relevant message(s) are returned.

2 Note that record A is the record that you created as part of test script 4.1.


Notes:


5.2 UPDATE – Verification informationProvider attempts to confirm the students’ personal information and verifies the data on the NSI record accordingly.




Log into NSI Perform Search for student.

Student Name – from record B3

OR, if your SMS requires you to input NSN prior to changing Student details: Student NSN from record B3


Search returns results, including Record B.

Update the verification details on record B using the update function.

Update record data: Family name: Johnstone Given name 1: Henry Given name 2: Your own first

name. Given name 3: Alistair Name/DoB Verification:

Other Res. Status ver: Citizen Res. Status ver: Birth

certificate

Update executes successfully.

Relevant message(s) are returned.

3 Record B is the NSI record that you created as part of test script 4.2.


Notes:


5.3 UPDATE – Unsuccessful update attemptThe provider attempts to update the verified record As the NSI record is already verified, an error is returned.




Log into NSI Perform Search for student.

Student Name: Henry Johnstone

OR, if your SMS requires you to input NSN prior to changing Student details: Student NSN from record B4


Search returns results, including record B4

Perform update on record B.

Update name: Family name: Jones Given name 1: Harry

Unsuccessful update – error message returned: Error 034: This record

contains verified name and birth date information. If you wish to update this information please raise a challenge.

Notes:

4 Record B is the NSI record that you created as part of test script 4.2 and also used in test script 5.2


6 Merge Record Test Scripts

These tests are intended to ensure that the provider can use their NSI XML interface to lodge a request for a group of NSI records to be merged. The records that are used in the following tests will have been created or located as part of executing the “Create Record Test Scripts”.

6.1 MERGE – No manual intervention requiredThe provider lodges a request with the NSI Unit for the multiple records to be merged. These records are a close enough match and the merge is processed immediately.

You will need your results from test script 4.1, 4.2 and 4.3 in order to complete this test successfully. Please complete the ‘Actual Output’ column and record any comments in the Notes section below.



Log into NSI.Perform merge request for the two records.

Student on Record A5

Student on Record B6

Merge request executes successfully.

Message 055 returned: Student records have been automatically merged. The master record is <master nsn>.

Record the Master NSN

Notes:

5 Record A is the NSI record that you created as part of test script 4.16 Record B is the NSI record that you created as part of test script 4.2


6.2 MERGE – Manual intervention requiredThe provider lodges a request with the NSI Unit for the multiple records to be merged. AS these records are not a close enough match, the Merge is forwarded for Manual Intervention by MoE Service Desk.





Student NSN on Record A7

Student NSN on Record C8

Merge request executes successfully.

Message 915 returned: Merge request requires manual intervention for the following reason(s). Please contact the MoE Service Desk if you require more information. -<reason for sending to Manual Intervention>

Record the message content.

Notes:

7 Record A is the NSI record that you created as part of test script 4.18 Record C is the NSI record that you created as part of test script 4.3


7 Create/Update Student-Provider Relationships

These tests are intended to ensure that the provider can use their NSI REST interface to create new Student-Provider relationships or Update existing Student-Provider relationships on the NSI system.

7.1 STUDENT-PROVIDER RELATIONSHIP – Add RelationshipProvider is enrolling a new student who has not given an NSN. Provider enrols student and searches for an existing NSI record as part of this process.

An existing NSI record is found for the student and the provider matches against the existing record, but the provider needs to receive notifications of any changes against that record. Provider will submit a request to Create a Student-Provider relationship.Once this step in testing is complete you will need to contact the MoE Service Desk to confirmthe successful add/update of the SPR.Please complete the ‘Actual Output’ column and record any comments in the Notes section below.




Name: Anthony Butler NSN 13


NSN added to student record

Submit request to create SPR with Student

NSN: 13 Provider Code: Blank or your

provider code Until date: Blank or today’s

date + 3 months

SPR created successfully

Notes:


7.2 STUDENT-PROVIDER RELATIONSHIP – Update existing RelationshipProvider is enrolling a student who has previously enrolled at their organisation. Provider enrols student and searches for an existing NSI record as part of this process.

An existing NSI record is found for the student and the provider matches against the existing record, but the provider needs to receive notifications of any changes against that record. Provider will submit a request to Update the Student-Provider relationship.

Once this step in testing is complete you will need to contact the MoE Service Desk to confirmthe successful add/update of the SPR.Please complete the ‘Actual Output’ column and record any comments in the Notes section below.




Student on Record A Search executes successfully.

Submit request to update SPR with Student

NSN: from Student A9

Provider Code: Blank or your provider code

Until date: Today’s date + 3 months

SPR updated successfully Note Student A99 NSN

Notes:

9 Record A is the NSI record that you created as part of test script 4.1


8 Change Notifications / Challenge student details

Retrieving Change NotificationsChallenging a change that another provider has made to one of your student’s NSI record

These tests are intended to ensure that the provider can retrieve Change Notifications into their SMS and can raise a Challenge against a Student record. For most providers, these processes use a combination of the NSI Web Ui and your SMS system. If you have a Batch process to retrieve and process Change Notifications, then you would use this process.Retrieving and processing Change Notifications is an optional process – Your SMS may not provide this feature.If you choose to retrieve and process Change Notifications please advise NSI Unit that you will be doing this process. We also need to know, which format (XML or delimited) you require your Change Notifications & if you need to be informed about changes to your students for a period greater than 1 year.

8.1 CHANGE NOTIFICATIONS - Retrieve Change Notifications

Provider wishes to update their SMS NSI student data with any changes that may have been applied by other provides.


NSI Action on NSI Web UI


Contact NSI Unit

Advise NSI Unit of the NSN’s you created in step 4 (Record A, B, C, D)

Request NSI Unit to modify the gender of at least one of these records




Log into NSI.Select Batch tabSelect Results sub tabSelect Change Notifications

Select View button – Note the default date is

updated once a file is downloaded

Change to at least one of Record A, B, C or D (the modified data is highlighted on the screen)

Note – If you are manually updating Change details into your SMS you may apply the changes into your SMS using this data

Select Download button Note the default date is

updated once a file is downloaded

File will be downloaded Open or save the file and

process into your SMS.

Notes:


8.2 CHALLENGE - Challenge student detailsProvider identifies a change to a student’s details or identifies Student details that they believe are incorrect / they wish to challenge. A challenge to an NSN may be submitted from the Student Details page, and also from the Modify Student page.Please submit any supporting details separately to NSI Unit.NSI Unit will investigate your challenge and keep you updated re the outcome of the Challenge.





Details to enter: Family name: Name of your


name Given name 2: Your own

surname Birth date: Today’s date – 3

months


One or more records returned (ranking should be between 92 and 99)

One of which should be the record you created as NSN C10.

If the ranking is below 92 or = 100, please adjust the birth date and try again.

View Student details for one of the records in the search results

Select the Challenge button Select Challenge type

(Challenge existing details) Enter reason for Challenge Enter your email address

Message showing Challenge Change successfully submitted

Email received containing details of the Challenge

10 Record C is the NSI record that you created as part of test script 4.3




Record this NSN (Record E)

Submit challenge

Search NSN NSN of the record you raised the challenge for (Record E)

Student Details page showing that a challenge has been raised for this student

Notes:


guide to integrating with the nsi - education...

Documents