IAssessmentService2023GetStudent Method Provincial Approach to Student Information API
This service operation will return a list of students that are requested by the client.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
Copy
List<StudentResponse> GetStudent(
	StudentRequest request
)

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.

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.
Remarks
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 NameTypeRequiredOther Attributes
CallerInfoCallerInfoYes
CallerInfo.ClientMessageIDStringYesValue 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.SentUtcTimeDateTimeYes
CallerInfo.SoftwareSoftwareYes
CallerInfo.Software.BuildNumberStringYesValue 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.ManufacturerStringYesValue 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.ProductStringYesValue 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.VersionStringYesValue 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.UserUserYes
CallerInfo.User.IPAddressStringYesValue 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.LocalIDStringYesValue 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.NameStringYesValue 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.OrganizationCodeStringYesValue must be no more than 6 characters
StateProvinceIdsList<EntityKeyVersionInfo>Yes
StateProvinceIds.ExpectedVersionNullable`1No
StateProvinceIds.KeyStringYes


Response Fields

Full Property NameTypeRequiredOther Attributes
List<StudentResponse>List<StudentResponse>No
List<StudentResponse>.AvailabilityStatusStringNo
List<StudentResponse>.StudentStudentInfoNo
List<StudentResponse>.Student.BirthDateDateTimeYes
List<StudentResponse>.Student.CreatedOnUtcDateTimeYes
List<StudentResponse>.Student.HasDisclosureRestrictionsBooleanYes
List<StudentResponse>.Student.IsDeactivatedBooleanYes
List<StudentResponse>.Student.IsDeceasedBooleanYes
List<StudentResponse>.Student.LastUpdateUtcTimeDateTimeYes
List<StudentResponse>.Student.MaturityDateDateTimeYes
List<StudentResponse>.Student.OriginalNameRefIdInt32Yes
List<StudentResponse>.Student.PASICoreVersionInt64Yes
List<StudentResponse>.Student.PreferredNameRefIdInt32Yes
List<StudentResponse>.Student.PrimaryStateProvinceIdStringNo
List<StudentResponse>.Student.ScheduledRecordDisposalDateDateTimeNo
List<StudentResponse>.Student.SecondaryStateProvinceIdsList<String>No
List<StudentResponse>.Student.StateProvinceIdStringYes
List<StudentResponse>.Student.StudentNamesList<Name>Yes
List<StudentResponse>.Student.StudentNames.FirstNameStringYesValue 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.LastNameStringYesValue 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.LastUpdateUtcTimeDateTimeNo
List<StudentResponse>.Student.StudentNames.MiddleNameStringNoValue 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.RefIdInt32Yes
List<StudentResponse>.Student.StudentNames.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
See Also

Reference

IAssessmentService2023 Interface
PASI.ServiceContract Namespace