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

Parameters

request

Type: PASI.DataContract.V201204StudentPersonalProfileRequest
Contains StateProvinceId that is used to identify the student, IsLimitedProfileRequested flag to indicate the amount of personal student records is preferred to be returned and MinimumExpectedPASICoreVersion to specify the minimum version of the student personal profile to be returned.

Return Value

Type: StudentPersonalProfileResponse
The requested student's personal profile and AssociationTypeToStudent code type to indicate what association type a calling PASI client has with a student. If calling PASI client has no association (None) to student, a limited profile is always return. If a PASI client that has full access to student, requested a limited profile (set IsLimitedProfileRequested = True) then the AssociationTypeToStudent of None is always return.

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.

9002, 9014 This service returns the student personal profile for a given StateProvinceId and the AssociationTypeToStudent code type to indicate what association type a calling PASI client has with a student.

If a student is associated to the calling PASI client, the client has the option to either have a full personal profile returned; or a limited personal profile returned. The IsLimitedProfileRequested flag is for use to request a limited personal profile to be returned. If a student is not associated to the calling PASI client, a limited personal profile will always be returned; regardless of what the IsLimitedProfileRequested flag is. If a limited personal profile is returned, the AssociationTypeToStudent of None is always returned.

The difference between full and limited personal profile is a limited personal profile does not returned any phone number and active disclosure restriction record for the student. The HasDisclosureRestrictions flag allow a calling PASI client to identify if a student has active disclosure restriction record when only a limited personal profile is returned.

PASI Client can only see inactive student disclosure restriction record if client is associated to the student and client's certificate has MinistryClientUser role. However, PASI client can see active disclosure restriction record if client is associated to the student even if client's certificate does not have MinistryClientUser role.

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
IsLimitedProfileRequested	Boolean	Yes
MinimumExpectedPASICoreVersion	Int64	Yes
StateProvinceId	String	Yes	Value must be in the form of a number between '000000001' and '999999999'

Response Fields

Full Property Name	Type	Required	Other Attributes
StudentPersonalProfileResponse.AssociationTypeToStudent	String	Yes
StudentPersonalProfileResponse.StudentPersonalProfile	StudentPersonalProfileInfo	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.CitizenshipStatuses	List<CitizenshipStatusInfo>	No
StudentPersonalProfileResponse.StudentPersonalProfile.CitizenshipStatuses.CitizenshipStatus	String	Yes	Value must be an appropriate CitizenshipStatus code value
StudentPersonalProfileResponse.StudentPersonalProfile.CitizenshipStatuses.DocumentExpiryDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.CitizenshipStatuses.EffectiveDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.CitizenshipStatuses.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.CitizenshipStatuses.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.CreatedOnUtc	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.DateOfDeath	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions	List<StudentDisclosureRestrictionInfo>	No
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions.DisclosureRestrictionCode	String	Yes	Value must be an appropriate DisclosureRestriction code value
StudentPersonalProfileResponse.StudentPersonalProfile.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]
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions.EffectiveDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions.ExpiryDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions.IsActive	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.DisclosureRestrictions.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.EmailAddresses	List<EmailAddress>	No
StudentPersonalProfileResponse.StudentPersonalProfile.EmailAddresses.Address	String	Yes	Value must be no more than 255 characters Value must not contain invalid characters
StudentPersonalProfileResponse.StudentPersonalProfile.EmailAddresses.IsActive	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.EmailAddresses.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.EmailAddresses.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.Gender	String	Yes	Value must be an appropriate Gender code value
StudentPersonalProfileResponse.StudentPersonalProfile.HasDisclosureRestrictions	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IdentificationRecord	StudentIdentificationInfo	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IdentificationRecord.BirthDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IdentificationRecord.DocumentIssueDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.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]
StudentPersonalProfileResponse.StudentPersonalProfile.IdentificationRecord.DocumentType	String	Yes	Value must be an appropriate SourceDocumentType code value
StudentPersonalProfileResponse.StudentPersonalProfile.IdentificationRecord.IsNameExact	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IdentificationRecord.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IsAssociated	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IsConnectedToMyPass	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IsDeactivated	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.IsDeceased	Boolean	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.MaturityDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.MaturityReason	String	No	Value must be an appropriate MaturityReason code value
StudentPersonalProfileResponse.StudentPersonalProfile.OriginalNameRefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses	List<Address>	No
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.AddressType	String	Yes	Value must be an appropriate AddressType code value
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.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]
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.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]
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.EffectiveDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.ExpiryDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.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]
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.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]
StudentPersonalProfileResponse.StudentPersonalProfile.OtherAddresses.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]
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers	List<PhoneNumber>	No
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.EffectiveDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.ExpiryDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.Extension	String	No	Value must be no more than 7 characters
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.IsListable	String	Yes	Value must be one of (Y, N, U)
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.Number	String	Yes	Value must be no more than 16 characters
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.OtherPhoneNumbers.Type	String	Yes	Value must be an appropriate PhoneType code value
StudentPersonalProfileResponse.StudentPersonalProfile.PASICoreVersion	Int64	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress	Address	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.AddressType	String	Yes	Value must be an appropriate AddressType code value
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.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]
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.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]
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.EffectiveDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.ExpiryDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.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]
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.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]
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredMailingAddress.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]
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredNameRefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber	PhoneNumber	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.EffectiveDate	DateTime	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.ExpiryDate	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.Extension	String	No	Value must be no more than 7 characters
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.IsListable	String	Yes	Value must be one of (Y, N, U)
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.Number	String	Yes	Value must be no more than 16 characters
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.PreferredPhoneNumber.Type	String	Yes	Value must be an appropriate PhoneType code value
StudentPersonalProfileResponse.StudentPersonalProfile.PrimaryStateProvinceId	String	No
StudentPersonalProfileResponse.StudentPersonalProfile.SecondaryStateProvinceIds	List<String>	No
StudentPersonalProfileResponse.StudentPersonalProfile.Section23Eligibility	String	No	Value must be an appropriate Section23Eligibility code value
StudentPersonalProfileResponse.StudentPersonalProfile.StateProvinceId	String	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.StudentNames	List<Name>	No
StudentPersonalProfileResponse.StudentPersonalProfile.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 (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
StudentPersonalProfileResponse.StudentPersonalProfile.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 (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
StudentPersonalProfileResponse.StudentPersonalProfile.StudentNames.LastUpdateUtcTime	DateTime	No
StudentPersonalProfileResponse.StudentPersonalProfile.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 (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
StudentPersonalProfileResponse.StudentPersonalProfile.StudentNames.RefId	Int32	Yes
StudentPersonalProfileResponse.StudentPersonalProfile.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