Web Services

Web Services consist of two distinct products:
1. Data Integration
2. Single Sign-on (SSO)

For every request to these services, the user requesting the data must be validated and approved. Access to these services is restricted to users with both DBA Full and Security Full roles.

Note: Troubleshooting Web Services can be performed in Campus.

Note: The web services are run through a PCR Educator application called DataLine.

Note: Each additional vendor connecting through the SOAP API should have their own user. These users are configured under Security as follows:
- No roles beyond DBA Full and Security Full
- No association with any school divisions
- No profile associations to teachers, households, or students
- No associations to any ledgers
- A valid email address owned by the vendor

Data Integration

Data integration allows another vendor to pull data from the PCR Educator database to their system.
1. Data Integration - Configuration
2. Data Integration - Parties
3. Data Integration - Faculty
4. Data Integration - Parent
5. Data Integration - Student
6. Data Integration - Household
7. Data Integration - Course

Data Integration - Configuration

Data Integration - Configuration is a web service which provides a list of the configuration settings for the web services. Web Service name: Configuration.asmx

Available functions:
- GetConfigurationSettings returns a list of the current Web Service settings.

Name	Type	Default	Description
FacultyHouseholdEmailType	String	Household	Determines the email type returned for the household email.
IncludeHouseholdEmailInFaculty	Boolean	True	If True, Household Email is placed in Email slot 1 of Faculty and all others are shifted down a slot resulting in 4 emails per faculty.
IncludeHouseholdEmailInParents	Boolean	True	If True, Household Email is placed in Email slot 1 for Parents and all others are shifted down a slot resulting in 4 emails per parent.
IncludeToBeNewlyEnrolled	Boolean	False	Determines if To Be Newly Enrolled students and households are returned.
ParentHouseholdEmailType	String	Household	Determines the email type returned for the household email.
PrimaryFacultyEmailIndicator	String	School	Determines which of the 3 emails is the primary email.
PrimaryFacultyPhoneIndicator	String	School	Determines which of the 4 phone numbers is the primary phone.
PrimaryParentEmailIndicator	String	Work	Determines which of the 3 parent emails is the primary email.
PrimaryParentPhoneIndicator	String	Work	Determines which of the 4 parent phone numbers is the primary phone.
StudentEmailType	String	Personal	Determines the email type returned for the Student email.
StudentPhoneType	String	Mobile	Determines the phone type returned for the Student phone.
UnicIdProvider	String	PcrId	Controls the ID type used by PCR Dataline. It will either return the unique id for the User or the Alternate Id for the record if the value is “AltId”.

- GetServerTime returns the local date and UTC date of the server.

Data Integration - Parties

Data Integration - Parties is a web service which provides a list of all users registered in the PCR Educator database. Parties enables the web service consumer to query the PCR Educator logins. Web Service name: Parties.asmx

Available functions:
- GetAllParties retrieves all users. Note: Only student users for currently year enrolled students are returned. All faculty and parent users are returned.
- GetPartiesByModifiedDate retrieves all the users that have been modified since the specified date. Note: Only student users for students enrolled for the current year are returned. All faculty and parent users are returned.
- GetPartyCredentialsByModifiedDate retrieves user and modified date information for recorded modified on or after the specified date.
- GetPartyCredentialsByUnicId retrieves the information for the specified unique id.
- GetPartyCredentialsByUserName retrieve the information for the specified username.
- ValidateUser is deprecated and should not be used.
- ValidateUserV2 tests the specified username and password to see if they are valid.

Note: Passwords are encrypted and unavailable to be transmitted to a 3rd party through the web services. GetCredentials functions return a password column which is always blank for backwards compatibility.

Note: UnicId links the user record to the data record.

Data Integration - Faculty

Data Integration - Faculty is a web service which provides a list of all teacher registered in the PCR Educator database. Web Service name: Faculty.asmx

Available functions:
- GetAllFacultyMembers retrieves all teachers and their household information.
- GetFacultyMembersByModifiedDate retrieves all teachers and their household information that have been modified since the specified date.

Note: Teachers must have a user associated with their teacher record in order to be returned by these functions.

Data Integration - Parent

Data Integration - Parent is a web service which provides a list of all parents with enrolled students registered in the PCR Educator database. Web Service name: Parents.asmx

Available functions:
- GetAllParents retrieves all parents of enrolled students.
- GetParentByID retrieves the parent record for the specified id.
- GetParentsByModifiedDate retrieves all parents of enrolled students that have been modified since the specified date.
- GetParentsByModifiedDateAndStatus retrieves all parents for students with the specified status, school year and division. The Status does not permit wildcards. School year is 0 for current year or 1 for next year. School id is the integer school id or -1 for any school division.
- GetParentsByStudentId retrieves the parents for the student with the specified UnicId.
- GetParentsCredentials retrieves the parent with the specified UnicId.

Note: Parents must have a user associated with their household record in order to be returned by these functions.

Data Integration - Student

Data Integration - Student is a web service which provides a list of all enrolled students registered in the PCR Educator database.
Web Service name: Students.asmx

Available functions:
- GetAllStudents retrieves all students enrolled in the current year.
- GetStudentsByModifiedDate retrieves all enrolled students that have been modified since the specified date.
- GetStudentsByModifiedDateAndStatus retrives all students with the specified status for the specified school year and school division. The studentStatus does not permit wildcards. The divisionId is an integer number for the specific school division, or -1 for any school division. The statusYear is 0 to check the current year status or 1 to check the next year status.

Note: Students must have a user associated with their student record in order to be returned by these functions.

Data Integration - Household

Data Integration - Household is a web service which provides a list of all household addresses of enrolled students registered in the PCR Educator database. Web Service name: Households.asmx

Available functions:
- GetAllHouseholds retrieves all households of students enrolled for the current year.
- Get HouseholdByID retrieves the household by the integer household id.
- GetHouseholdsByModifiedDate retrieves all households enrolled students that have been modified since the specified date.
- GetHouseholdsByModifiedDateAndStatus retrieves the households for students with the specified status, school year and division. The Status does not permit wildcards. School year is 0 for current year or 1 for next year. School id is the integer school id or -1 for any school division. Note: Teacher households will also be returned based on modified date regardless of student associations.
- GetHouseholdsByStudent retrieves address information for the specified student record.
- GetHouseholdsIdByModifiedDate retrieves teacher households or households of Enrolled students modified since the specified date.

Data Integration - Course

Data Integration - Course is a web service which provides course and student schedules in the PCR database. Web Service name: Courses.asmx

Available functions:
- GetCourseSections retrieves all scheduled course sections for the current school year.
- GetStudentCourses retrieves all student enrollment into course sections from GetCourseSections.

Single Sign-on

Single Sign-on (SSO) is a feature that allows an outside vendor to authenticate users against PCR Educator's database. This feature allows users to access PCR Educator's software directly from other software without a need to login. You can also use PCR Educator single sign-on to send a user from one PCR Educator application to another without requiring a separate login attempt.

Single Sign-on consists of 3 parts.
- Initial sign-in. There are two approaches for handling the initial sign-in:
1. PCR Educator stores the users and passwords. The vendor queries PCR Educator using the ValidateUserV2 from Data Integration - Parties to verify the username and password combination. Note: If PCR Educator is not the database of record for users, you still need to have the Username and connections created in PCR Educator. The password won't matter as much since password verification will be performed by the vendor.

2. PCR Educator only has placeholder users, which link to the appropriate household, student or teacher. The vendor verifies the username and password combination against their database.

- Pass-thru Authentication: After the user is validated, a passthrough mechanism allows the vendor to seamlessly redirect the user to PCR Educator software without requiring a new login attempt. This passthrough is based on matching the passthrough user to an existing PCR username.

- Forgot Password: Forgot Password is a public page which enables resetting of a PCR Educator password. Passwords can only be reset. They cannot be read or exported as they are encrypted. Note: If the vendor is storing the username and password for initial verification, then PCR Educator version of Forgot Password cannot be used. All changes to the user password need to happen with the vendor in this situation.

Troubleshooting Web Service

Choose the appropriate Data Integration function you wish to test. Most likely, you are testing one of the following:
1. Troubleshooting Data Integration - Parties if the user is unable to log in
2. Troubleshooting Data Integration - Household if there is no record of a family in the vendor database, or the record information is wrong.
3. Troubleshooting Data Integration - Student if there is no record of the student in the vendor database, or the record information is wrong.

Note: Always double check that the vendor's user is approved, unlocked, and has both the Security Full and DBA Full roles. The vendor must have access to such a user in the Campus users list, or they will not be able to access the web services.

Troubleshooting Web Service - Parties

Scenario: A user - parent, student, or teacher - is unable to log into the 3rd party website.

What you need: The username that cannot log in. Your own user, which must have Security Full and DBA Full roles.

For Troubleshooting Web Service issues involving logins, first provide your own password in the password box. This is to authenticate you against the web service.

Next choose Parties, then ValidateUserV2. Put in the username and password. And click Run. You will receive one of 3 results:
1. A result of “True” indicates that the username and password are correct.

2. A result of “False” indicates that the username or password is incorrect, or that the user is locked or unapproved.

3. An error exception. This exception could mean one of the following:
- Your user is missing the DBA Full role. Solution: add the DBA Full role to your user.
- Your user has the DBA Full role. Solution: Contact PCR Educator Support

If the user validates successfully, choose GetAllParties from the second drop down and run it. Confirm that the Login is appearing in the list of available users.
1. The user appears in this list. Solution: Contact the Vendor. All the necessary information is being provided from PCR Educator.

2. The user does not appear in the list. Solution: Make sure you have created a user for that student / parent / teacher, and that it is correctly linked to the student, parent or teacher record. Make sure that in the case of a parent record, the household indicator is properly specified. If the user is for the parent of a student or a student, make sure the student is Enrolled.

Troubleshooting Web Service - Household

Scenario: Household information is not retrievable by the vendor, or the household information sent to the vendor is incorrect.

What you need: The username that cannot log in. Your own user, which must have Security Full and DBA Full roles.

For Troubleshooting Web Service issues involving households, first provide your own password in the password box. This is to authenticate you against the web service.

Next choose Households, then GetAllHouseholds, and click Run. You will receive one of 2 results:
1. A list of all households for enrolled students.

2. An error exception. This exception could mean one of the following:
- Your user is missing the DBA Full role. Solution: add the DBA Full role to your user.
- Your user has the DBA Full role. Solution: Contact PCR Educator Support

Try to locate the missing household.
1. The household appears in this list. Solution: Double check that the user is associated to the correct household. Contact the Vendor. All the necessary information is being provided from PCR Educator.

2. The household does not appear in the list. Solution: Make sure the household has an enrolled student associated. Make sure you have created a user for that household, and that it is correctly linked to the household. Make sure that the household indicator is properly specified.

Troubleshooting Web Service - Student

Scenario: Student information is not retrievable by the vendor, or the student information sent to the vendor is incorrect.

What you need: The username that cannot log in. Your own user, which must have Security Full and DBA Full roles.

For Troubleshooting Web Service issues involving students, first provide your own password in the password box. This is to authenticate you against the web service.

Next choose Students, then GetAllStudents, and click Run. You will receive one of 2 results:
1. A list of all enrolled students.

2. An error exception. This exception could mean one of the following:
- Your user is missing the DBA Full role. Solution: add the DBA Full role to your user.
- Your user has the DBA Full role. Solution: Contact PCR Educator Support

Try to locate the missing student.
1. The student appears in this list. Solution: Double check that the user is associated to the correct student. Contact the Vendor. All the necessary information is being provided from PCR Educator.

2. The student does not appear in the list. Solution: Make sure the student is enrolled. Make sure you have created a user for that student, and that it is correctly linked to the student record.

Schedule Demo

Please, make sure that all required fields (marked with *) are completed.

School Name *

Relation to School *

select

Last Name *

Your First Name *

Your Email *

Your Phone # *

PCR Educator School Information System is an online database engineered for schools and universities to deliver the highest level of flexibility, unique experience, transparent communication and customized design.