Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)

Parameters

request

Type: PASI.DataContract.V201204StudentRequest
Contains a list of StateProvinceIds that the client wishes to retrieve

Return Value

Type: ListStudentResponse
A list of StudentResponse objects. DisclosureRestrictions will only include inactive student disclosure restriction records for Ministry users.

Service Validations

The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.

No additional errors for this service. This service is intended to be used during the data synchronization process using the IsDataAvailable service. See the Expected Versions section for important details on how this service will return data.

Request and Response Class Diagram

Request Fields

Full Property Name	Type	Required	Other Attributes
CallerInfo	CallerInfo	Yes
CallerInfo.ClientMessageID	String	Yes	Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.SentUtcTime	DateTime	Yes
CallerInfo.Software	Software	Yes
CallerInfo.Software.BuildNumber	String	Yes	Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.Manufacturer	String	Yes	Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.Product	String	Yes	Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.Version	String	Yes	Value must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User	User	Yes
CallerInfo.User.IPAddress	String	Yes	Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.LocalID	String	Yes	Value must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.Name	String	Yes	Value must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.OrganizationCode	String	Yes	Value must be no more than 6 characters
StateProvinceIds	List<EntityKeyVersionInfo>	Yes
StateProvinceIds.ExpectedVersion	Nullable`1	No
StateProvinceIds.Key	String	Yes

Response Fields

Full Property Name	Type	Required	Other Attributes
List<StudentResponse>	List<StudentResponse>	No
List<StudentResponse>.AvailabilityStatus	String	No
List<StudentResponse>.Student	StudentInfo	No
List<StudentResponse>.Student.CitizenshipStatuses	List<CitizenshipStatusInfo>	No
List<StudentResponse>.Student.CitizenshipStatuses.AuditUserName	String	Yes
List<StudentResponse>.Student.CitizenshipStatuses.CitizenshipStatus	String	Yes	Value must be an appropriate CitizenshipStatus code value
List<StudentResponse>.Student.CitizenshipStatuses.CountryOfCitizenship	String	No	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.CitizenshipStatuses.CreatedByOrganizationCode	String	Yes	Value must be a valid organization code (e.g. s.1312).
List<StudentResponse>.Student.CitizenshipStatuses.DocumentExpiryDate	Nullable`1	No
List<StudentResponse>.Student.CitizenshipStatuses.EffectiveDate	DateTime	Yes
List<StudentResponse>.Student.CitizenshipStatuses.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.CitizenshipStatuses.ParentGuardianCitizenshipStatus	String	No	Value must be an appropriate CitizenshipStatus code value
List<StudentResponse>.Student.CitizenshipStatuses.ParentGuardianId	Nullable`1	No
List<StudentResponse>.Student.CitizenshipStatuses.RefId	Int32	Yes
List<StudentResponse>.Student.CreatedOnUtc	DateTime	Yes
List<StudentResponse>.Student.DateOfDeath	DateTime	No
List<StudentResponse>.Student.DisclosureRestrictions	List<StudentDisclosureRestrictionInfo>	No
List<StudentResponse>.Student.DisclosureRestrictions.DisclosureRestrictionCode	String	Yes	Value must be an appropriate DisclosureRestriction code value
List<StudentResponse>.Student.DisclosureRestrictions.DisclosureRestrictionDetails	String	No	Value must be no more than 250 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<StudentResponse>.Student.DisclosureRestrictions.EffectiveDate	DateTime	Yes
List<StudentResponse>.Student.DisclosureRestrictions.ExpiryDate	DateTime	No
List<StudentResponse>.Student.DisclosureRestrictions.IsActive	Boolean	Yes
List<StudentResponse>.Student.DisclosureRestrictions.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.DisclosureRestrictions.RefId	Int32	Yes
List<StudentResponse>.Student.EmailAddresses	List<EmailAddress>	No
List<StudentResponse>.Student.EmailAddresses.Address	String	Yes	Value must be no more than 255 characters Value must not contain invalid characters
List<StudentResponse>.Student.EmailAddresses.IsActive	Boolean	Yes
List<StudentResponse>.Student.EmailAddresses.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.EmailAddresses.RefId	Int32	Yes
List<StudentResponse>.Student.Gender	String	Yes	Value must be an appropriate Gender code value
List<StudentResponse>.Student.IdentificationRecord	StudentIdentificationInfo	Yes
List<StudentResponse>.Student.IdentificationRecord.BirthDate	DateTime	Yes
List<StudentResponse>.Student.IdentificationRecord.DocumentIssueDate	DateTime	No
List<StudentResponse>.Student.IdentificationRecord.DocumentNumber	String	No	Value must be 4 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.IdentificationRecord.DocumentReferenceId	Nullable`1	No
List<StudentResponse>.Student.IdentificationRecord.DocumentType	String	No	Value must be an appropriate SourceDocumentType code value
List<StudentResponse>.Student.IdentificationRecord.IsNameExact	Boolean	Yes
List<StudentResponse>.Student.IdentificationRecord.RefId	Int32	Yes
List<StudentResponse>.Student.IsDeactivated	Boolean	Yes
List<StudentResponse>.Student.IsDeceased	Boolean	Yes
List<StudentResponse>.Student.LastUpdateUtcTime	DateTime	Yes
List<StudentResponse>.Student.MaturityDate	DateTime	Yes
List<StudentResponse>.Student.MaturityReason	String	Yes	Value must be an appropriate MaturityReason code value
List<StudentResponse>.Student.MedicalAlerts	List<MedicalAlertInfo>	No
List<StudentResponse>.Student.MedicalAlerts.LastUpdateUtcTime	DateTime	Yes
List<StudentResponse>.Student.MedicalAlerts.MedicalAlertMessage	String	Yes
List<StudentResponse>.Student.MedicalAlerts.MedicalAlertType	String	Yes	Value must be an appropriate code value
List<StudentResponse>.Student.MedicalAlerts.RefId	Int32	Yes
List<StudentResponse>.Student.OriginalNameRefId	Int32	Yes
List<StudentResponse>.Student.OtherPhoneNumbers	List<PhoneNumber>	No
List<StudentResponse>.Student.OtherPhoneNumbers.EffectiveDate	DateTime	Yes
List<StudentResponse>.Student.OtherPhoneNumbers.ExpiryDate	DateTime	No
List<StudentResponse>.Student.OtherPhoneNumbers.Extension	String	No	Value must be no more than 7 characters
List<StudentResponse>.Student.OtherPhoneNumbers.IsListable	String	Yes	Value must be one of (Y, N, U)
List<StudentResponse>.Student.OtherPhoneNumbers.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.OtherPhoneNumbers.Number	String	Yes	Value must be no more than 16 characters
List<StudentResponse>.Student.OtherPhoneNumbers.RefId	Int32	Yes
List<StudentResponse>.Student.OtherPhoneNumbers.Type	String	Yes	Value must be an appropriate PhoneType code value
List<StudentResponse>.Student.ParentGuardians	List<ParentGuardianInfo>	No
List<StudentResponse>.Student.ParentGuardians.EmailAddress	String	No
List<StudentResponse>.Student.ParentGuardians.ExpiryDate	DateTime	No
List<StudentResponse>.Student.ParentGuardians.ExpiryDateOverride	Nullable`1	No
List<StudentResponse>.Student.ParentGuardians.HasSameHomePhoneNumberAsStudent	Boolean	Yes
List<StudentResponse>.Student.ParentGuardians.HasSameMailingAddressAsStudent	Boolean	Yes
List<StudentResponse>.Student.ParentGuardians.HomeNumber	String	No
List<StudentResponse>.Student.ParentGuardians.IsResidingWith	Boolean	Yes
List<StudentResponse>.Student.ParentGuardians.LastUpdateUtcTime	DateTime	Yes
List<StudentResponse>.Student.ParentGuardians.MailingAddress	ParentGuardianAddress	No
List<StudentResponse>.Student.ParentGuardians.MailingAddress.AddressFormat	String	Yes	Value must be an appropriate AddressFormat code value
List<StudentResponse>.Student.ParentGuardians.MailingAddress.City	String	No	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.MailingAddress.Country	String	Yes	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.MailingAddress.Latitude	Nullable`1	No	Value must be between -90 and 90
List<StudentResponse>.Student.ParentGuardians.MailingAddress.Longitude	Nullable`1	No	Value must be between -180 and 180
List<StudentResponse>.Student.ParentGuardians.MailingAddress.PostalCode	String	No	Value must be no more than 15 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.MailingAddress.StateProvince	String	No	Value must be no more than 20 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.MailingAddress.Street	String	Yes	Value must be no more than 140 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<StudentResponse>.Student.ParentGuardians.MobileNumber	String	No
List<StudentResponse>.Student.ParentGuardians.Name	ParentGuardianName	Yes
List<StudentResponse>.Student.ParentGuardians.Name.FirstName	String	Yes	Value must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.ParentGuardians.Name.LastName	String	Yes	Value must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.ParentGuardians.Name.MiddleName	String	No	Value must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.ParentGuardians.Name.Suffix	String	No	Value must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress	ParentGuardianAddress	No
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.AddressFormat	String	Yes	Value must be an appropriate AddressFormat code value
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.City	String	No	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.Country	String	Yes	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.Latitude	Nullable`1	No	Value must be between -90 and 90
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.Longitude	Nullable`1	No	Value must be between -180 and 180
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.PostalCode	String	No	Value must be no more than 15 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.StateProvince	String	No	Value must be no more than 20 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.ParentGuardians.PhysicalAddress.Street	String	Yes	Value must be no more than 140 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<StudentResponse>.Student.ParentGuardians.PhysicalAddressSource	String	Yes	Value must be an appropriate GuardianPhysicalAddressSource code value
List<StudentResponse>.Student.ParentGuardians.RefId	Int32	Yes
List<StudentResponse>.Student.ParentGuardians.RelationshipDescription	String	No
List<StudentResponse>.Student.ParentGuardians.RelationshipType	String	Yes	Value must be an appropriate RelationshipType code value
List<StudentResponse>.Student.ParentGuardians.WorkExtension	String	No
List<StudentResponse>.Student.ParentGuardians.WorkNumber	String	No
List<StudentResponse>.Student.PASICoreVersion	Int64	Yes
List<StudentResponse>.Student.PreferredNameRefId	Int32	Yes
List<StudentResponse>.Student.PreferredPhoneNumber	PhoneNumber	No
List<StudentResponse>.Student.PreferredPhoneNumber.EffectiveDate	DateTime	Yes
List<StudentResponse>.Student.PreferredPhoneNumber.ExpiryDate	DateTime	No
List<StudentResponse>.Student.PreferredPhoneNumber.Extension	String	No	Value must be no more than 7 characters
List<StudentResponse>.Student.PreferredPhoneNumber.IsListable	String	Yes	Value must be one of (Y, N, U)
List<StudentResponse>.Student.PreferredPhoneNumber.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.PreferredPhoneNumber.Number	String	Yes	Value must be no more than 16 characters
List<StudentResponse>.Student.PreferredPhoneNumber.RefId	Int32	Yes
List<StudentResponse>.Student.PreferredPhoneNumber.Type	String	Yes	Value must be an appropriate PhoneType code value
List<StudentResponse>.Student.PrimaryLanguageSpokenAtHome	String	No	Value must be an appropriate LanguageSpoken code value
List<StudentResponse>.Student.PrimaryStateProvinceId	String	No
List<StudentResponse>.Student.ScheduledRecordDisposalDate	DateTime	No
List<StudentResponse>.Student.SecondaryStateProvinceIds	List<String>	No
List<StudentResponse>.Student.Section23Eligibility	String	No	Value must be an appropriate Section23Eligibility code value
List<StudentResponse>.Student.StateProvinceId	String	Yes
List<StudentResponse>.Student.StudentAddresses	List<StudentAddress>	No
List<StudentResponse>.Student.StudentAddresses.AddressFormat	String	Yes	Value must be an appropriate AddressFormat code value
List<StudentResponse>.Student.StudentAddresses.AddressType	String	Yes	Value must be an appropriate AddressType code value
List<StudentResponse>.Student.StudentAddresses.City	String	No	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.StudentAddresses.Country	String	Yes	Value must be no more than 60 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.StudentAddresses.EffectiveDate	DateTime	Yes
List<StudentResponse>.Student.StudentAddresses.ExpiryDate	DateTime	No
List<StudentResponse>.Student.StudentAddresses.ExpiryDateOverride	Nullable`1	No
List<StudentResponse>.Student.StudentAddresses.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.StudentAddresses.Latitude	Nullable`1	No	Value must be between -90 and 90
List<StudentResponse>.Student.StudentAddresses.Longitude	Nullable`1	No	Value must be between -180 and 180
List<StudentResponse>.Student.StudentAddresses.PostalCode	String	No	Value must be no more than 15 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.StudentAddresses.RefId	Int32	Yes
List<StudentResponse>.Student.StudentAddresses.StateProvince	String	No	Value must be no more than 20 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
List<StudentResponse>.Student.StudentAddresses.Street	String	Yes	Value must be no more than 140 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Value must not contain empty lines and each line must be delimited with a carriage return and line feed. Content must not match regular expression: [\x00-\x08]|[\x0E-\x19]|[\x7F-\x9F]|[^\x00-\xFF]|(^|\n)\s*\r|\n\s*(\r|$)|[^\r]\n|\r[^\n]
List<StudentResponse>.Student.StudentNames	List<Name>	Yes
List<StudentResponse>.Student.StudentNames.FirstName	String	Yes	Value must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.StudentNames.LastName	String	Yes	Value must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.StudentNames.LastUpdateUtcTime	DateTime	No
List<StudentResponse>.Student.StudentNames.MiddleName	String	No	Value must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<StudentResponse>.Student.StudentNames.RefId	Int32	Yes
List<StudentResponse>.Student.StudentNames.Suffix	String	No	Value must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)

Reference