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

Parameters

request

Type: PASI.DataContract.V2017SubmitSchoolAuthorityInformationRequest
Contains the details of the School Authority being updated/added Addresses, Classification and Name lists should contain historical records as well. For example if the school authority has changed its name once it is expected that two name records would be sent to PASI core. This is required because it is a full record replacement. If PASI Core doesn't receive the history it is unable to provide it to clients.

Return Value

Type: SubmitResponse
On a successful submission contains the updated PASICoreVersion number for the submitted school. If it was unsuccessful there will be one or more errors attached and the PASICoreVersion will be zero.
The Id in this case will contain the School Authority code.

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 operation will allow the Ministry client to update or add a school authority record in PASI core. If PASI does not currently have a school authority with the school authority code passed in it will treat this as a new school authority and add it to PASI core. If PASI core does have the passed in school code it will be treated as an updated and all PASI's information on the school in question will be completely replaced with the information passed in.

The PasiCoreVersion must be passed in with the version being updated. If the passed in version does not match the current version in the PASI core an exception will be throw indicating they are out of sync, which is a signal to the client to get the latest (using GetSchoolAuthorityInformation) and try the submission again if required.

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
SchoolAuthority	SchoolAuthorityInformation	Yes
SchoolAuthority.Addresses	List<Address>	No
SchoolAuthority.Addresses.AddressType	String	Yes	Value must be an appropriate AddressType code value
SchoolAuthority.Addresses.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]
SchoolAuthority.Addresses.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]
SchoolAuthority.Addresses.EffectiveDate	DateTime	Yes
SchoolAuthority.Addresses.ExpiryDate	DateTime	No
SchoolAuthority.Addresses.LastUpdateUtcTime	DateTime	No
SchoolAuthority.Addresses.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]
SchoolAuthority.Addresses.RefId	Int32	Yes
SchoolAuthority.Addresses.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]
SchoolAuthority.Addresses.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]
SchoolAuthority.AuthorityCode	String	Yes	Value must be in the form of a number between '0001' and '9999'
SchoolAuthority.Classification	List<AuthorityClassification>	No
SchoolAuthority.Classification.ClassificationType	Int32	Yes	Value must be an appropriate SchoolAuthorityType code value
SchoolAuthority.Classification.EffectiveDate	DateTime	Yes
SchoolAuthority.EmailAddress	String	No
SchoolAuthority.FaxNumber	String	No
SchoolAuthority.Name	List<OrganizationName>	Yes
SchoolAuthority.Name.EffectiveDate	DateTime	Yes
SchoolAuthority.Name.Name	String	Yes
SchoolAuthority.PasiCoreVersion	Int64	Yes
SchoolAuthority.PhoneNumber	String	No
SchoolAuthority.SourceVersion	Int64	Yes
SchoolAuthority.Status	List<OrganizationStatus>	Yes
SchoolAuthority.Status.EffectiveDate	DateTime	Yes
SchoolAuthority.Status.IsActive	Boolean	Yes

Response Fields

Full Property Name	Type	Required	Other Attributes
SubmitResponse.Id	String	No
SubmitResponse.PASICoreVersion	Int64	No
SubmitResponse.Rejections	List<Rejection>	No
SubmitResponse.Rejections.Code	String	Yes
SubmitResponse.Rejections.Description	String	Yes

Reference