IPASIService2018SubmitStudent Method Provincial Approach to Student Information API
The implementation of this service has been removed

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax

SubmitResponse SubmitStudent(
	SubmitStudentRequest request
)

Parameters

request
Type: PASI.DataContract.V2018SubmitStudentRequest

Return Value

Type: SubmitResponse

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.

11001, 11002, 11003, 11004, 11005, 11006, 11007, 11008, 11015, 11016, 11021, 11203, 11204, 11206, 11207, 11208, 11217, 11219, 11220, 11221, 11222, 11223, 11224, 11231, 11251, 11252, 11253, 11254, 11255, 11261, 12006
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
DateOfDeathDateTimeNo
DisclosureRestrictionInfoStudentDisclosureRestrictionInfoNo
DisclosureRestrictionInfo.DisclosureRestrictionCodeStringYesValue must be an appropriate DisclosureRestriction code value
DisclosureRestrictionInfo.DisclosureRestrictionDetailsStringNoValue 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]
DisclosureRestrictionInfo.EffectiveDateDateTimeYes
DisclosureRestrictionInfo.ExpiryDateDateTimeNo
DisclosureRestrictionInfo.IsActiveBooleanYes
DisclosureRestrictionInfo.LastUpdateUtcTimeDateTimeNo
DisclosureRestrictionInfo.RefIdInt32Yes
IdentificationRecordIdentityInfoYes
IdentificationRecord.BirthDateDateTimeYes
IdentificationRecord.DocumentIssueDateDateTimeNo
IdentificationRecord.DocumentNumberStringNoValue 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]
IdentificationRecord.DocumentTypeStringYesValue must be an appropriate SourceDocumentType code value
IdentificationRecord.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentificationRecord.IsNameExactBooleanYes
IdentificationRecord.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentificationRecord.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IdentificationRecord.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
IsDeceasedBooleanYes
PersonalInfoBasicPersonalInfoYes
PersonalInfo.AliasNameNo
PersonalInfo.Alias.FirstNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
PersonalInfo.Alias.LastNameStringYesValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
PersonalInfo.Alias.LastUpdateUtcTimeDateTimeNo
PersonalInfo.Alias.MiddleNameStringNoValue must be no more than 50 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
PersonalInfo.Alias.RefIdInt32Yes
PersonalInfo.Alias.SuffixStringNoValue must be no more than 15 characters Value must only contain letters (A-Z), hyphens (-), apostrophes ('), periods (.), spaces ( ), or accented letters (ÀÁÂÃÄÅÇÈÉÊËÌÍÎÏÑÒÓÔÕÖÙÚÛÜÝàáâãäåçèéêëìíîïñòóôõöùúûüýÿ)
PersonalInfo.AlternateMailingAddressAddressNo
PersonalInfo.AlternateMailingAddress.AddressTypeStringYesValue must be an appropriate AddressType code value
PersonalInfo.AlternateMailingAddress.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]
PersonalInfo.AlternateMailingAddress.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]
PersonalInfo.AlternateMailingAddress.EffectiveDateDateTimeYes
PersonalInfo.AlternateMailingAddress.ExpiryDateDateTimeNo
PersonalInfo.AlternateMailingAddress.LastUpdateUtcTimeDateTimeNo
PersonalInfo.AlternateMailingAddress.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]
PersonalInfo.AlternateMailingAddress.RefIdInt32Yes
PersonalInfo.AlternateMailingAddress.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]
PersonalInfo.AlternateMailingAddress.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]
PersonalInfo.CitizenshipStatusStringNoValue must be an appropriate CitizenshipStatus code value
PersonalInfo.DocumentExpiryDateDateTimeNo
PersonalInfo.ExtendedPersonalInfoExtendedInfoListNo
PersonalInfo.ExtendedPersonalInfo.ListList<ExtendedInfo>Yes
PersonalInfo.ExtendedPersonalInfo.List.NameStringYesValue 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]
PersonalInfo.ExtendedPersonalInfo.List.ValuesList<KeyValuePair>Yes
PersonalInfo.ExtendedPersonalInfo.List.Values.KeyStringYes
PersonalInfo.ExtendedPersonalInfo.List.Values.ValueStringYesPASI.Validation.Schema.IsNotRequired
PersonalInfo.GenderStringYesValue must be an appropriate Gender code value
PersonalInfo.PreferredMailingAddressAddressNo
PersonalInfo.PreferredMailingAddress.AddressTypeStringYesValue must be an appropriate AddressType code value
PersonalInfo.PreferredMailingAddress.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]
PersonalInfo.PreferredMailingAddress.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]
PersonalInfo.PreferredMailingAddress.EffectiveDateDateTimeYes
PersonalInfo.PreferredMailingAddress.ExpiryDateDateTimeNo
PersonalInfo.PreferredMailingAddress.LastUpdateUtcTimeDateTimeNo
PersonalInfo.PreferredMailingAddress.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]
PersonalInfo.PreferredMailingAddress.RefIdInt32Yes
PersonalInfo.PreferredMailingAddress.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]
PersonalInfo.PreferredMailingAddress.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]
PersonalInfo.PreferredPhoneNumberPhoneNumberNo
PersonalInfo.PreferredPhoneNumber.EffectiveDateDateTimeYes
PersonalInfo.PreferredPhoneNumber.ExpiryDateDateTimeNo
PersonalInfo.PreferredPhoneNumber.ExtensionStringNoValue must be no more than 7 characters
PersonalInfo.PreferredPhoneNumber.IsListableStringYesValue must be one of (Y, N, U)
PersonalInfo.PreferredPhoneNumber.LastUpdateUtcTimeDateTimeNo
PersonalInfo.PreferredPhoneNumber.NumberStringYesValue must be no more than 16 characters
PersonalInfo.PreferredPhoneNumber.RefIdInt32Yes
PersonalInfo.PreferredPhoneNumber.TypeStringYesValue must be an appropriate PhoneType code value
PersonalInfo.Section23EligibilityStringNoValue must be an appropriate Section23Eligibility code value
PrimaryStateProvinceIdStringNo
PrimaryStudentPASICoreVersionInt64No
StateProvinceIdStringYes


Response Fields

Full Property NameTypeRequiredOther Attributes
SubmitResponse.IdStringNo
SubmitResponse.PASICoreVersionInt64No
SubmitResponse.RejectionsList<Rejection>No
SubmitResponse.Rejections.CodeStringYes
SubmitResponse.Rejections.DescriptionStringYes
See Also

Reference