IElectionsAlbertaService2018GetElectionsAlbertaStudentInformation Method Provincial Approach to Student Information API
The service will return a list of up to 1000 Student records (in version order) who meet the following criteria:
    Has an Elections Alberta Sync Version that is greater than the Last Known Source Version passed into the request, and
    Has Synchronization Status value other than Excluded.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Copy
List<ElectionsAlbertaStudentInformationResponse> GetElectionsAlbertaStudentInformation(
	ElectionsAlbertaStudentInformationRequest request
)

Parameters

request
Type: PASI.DataContract.ElectionsAlberta.V2018ElectionsAlbertaStudentInformationRequest

Return Value

Type: ListElectionsAlbertaStudentInformationResponse

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

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
LastKnownSourceVersionInt64Yes


Response Fields

Full Property NameTypeRequiredOther Attributes
List<ElectionsAlbertaStudentInformationResponse>List<ElectionsAlbertaStudentInformationResponse>No
List<ElectionsAlbertaStudentInformationResponse>.StudentInfoStudentInfoNo
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.BirthDateDateTimeYes
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.GenderStringYesValue must be an appropriate Gender code value
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.IsCanadianCitizenBooleanYes
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.LegalNameNameYes
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.LegalName.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.LegalName.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.LegalName.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.LegalName.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddressAddressNo
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddress.AddressFormatStringYesValue 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]
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddress.CityStringNoValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddress.CountryStringYesValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddress.PostalCodeStringNoValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddress.StateProvinceStringNoValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.MailingAddress.StreetStringYesValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhoneNumberPhoneNumberNo
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhoneNumber.ExtensionStringNoValue must be no more than 7 characters
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhoneNumber.NumberStringYesValue must be no more than 16 characters
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhoneNumber.TypeStringYesValue must be an appropriate PhoneType code value
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddressAddressNo
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddress.AddressFormatStringYesValue 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]
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddress.CityStringNoValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddress.CountryStringYesValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddress.PostalCodeStringNoValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddress.StateProvinceStringNoValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PhysicalAddress.StreetStringYesValue 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<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PreferredNameNameYes
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PreferredName.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PreferredName.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PreferredName.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.PreferredName.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
List<ElectionsAlbertaStudentInformationResponse>.StudentInfo.SecondaryStudentsList<Int32>No
List<ElectionsAlbertaStudentInformationResponse>.StudentKeyInt32Yes
List<ElectionsAlbertaStudentInformationResponse>.SynchronizationStatusStringYesValue must be an appropriate ElectionsAlbertaSyncStatus code value
List<ElectionsAlbertaStudentInformationResponse>.SynchronizationVersionInt64Yes
See Also

Reference

IElectionsAlbertaService2018 Interface
PASI.ServiceContract Namespace