Get Education Account Connection

This service is used to retrieve myPass Connection in PASI Core. This service can be used to:

  1. Retrieve information about a myPass Connection from PASI Core, and
  2. Obtain updates about a myPass Connection from the PASI Core as part of the Is Data Available data synchronization processes.

This request can be completed for a specific student connection or a list of myPass connections.

Security

The service can be accessed by systems with the Ministry Client User role.

Request Information

The following information is provided when using this service is a list of:

Request Validations

There are no validations performed on the service request.

Service Functionality

Information the identified student connections in the request will be retrieved from the PASI Core and returned in the response. If a list of records has been requested, they will be processed in the order provided.

Response Information

The following information is returned after a successful request has been processed:

Note: Data is only returned for organization code O.1.

IsDisabled - Data Contract property

ValueCondition
FalseThis property is false if the PASI calculated myPass Connection Connection Status is Active, Student Hold, or Expired.
TrueThis property is true if PASI calculated myPass Connection Connection Status to something other than the three above (i.e. Pending, Suspended, or Deleted).

NOTE: When IsDisabled is false, It is expected that the caller will check the AccessExpiresOn property to confirm if the connection has expired. Using just the isDisabled of being false is not enough to consider the connection “Active”.