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

Parameters

request

Type: PASI.DataContract.V2018SubmitStudentRecordDocumentRequest
Contains the information needed to add, update, or delete a student's document

Return Value

Type: SubmitResponse
This service will return the standard SubmitResponse with the Id and Version of the Student Record Document.

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, 9009, 9023, 9062, 64990, 64991, 64992, 64993, 65003, 65004, 65005, 65007, 65008, 65009, 65011, 65012, 65013, 65014, 65015, 65016, 65017, 65021, 65022, 65023, 65024, 65025, 65026, 65027, 65028, 65029, 65030, 65037, 65038, 65041, 65042, 65043, 65044, 65045, 65047, 65048, 65049, 65051, 65072, 65098, 65099, 65100, 65102, 65103, 65104, 65106, 65107, 65108, 65109, 65110, 65111, 65124 This service will return the standard SubmitResponse with the Id being the reference Id of the document and PASICoreVersion the version of the document after the update. To submit a document, the image must first be encoded using base64. Likewise, the image that is returned is also base64 encoded.

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
DocumentDate	DateTime	No
DocumentImage	DocumentImage	No
DocumentImage.Image	Byte[]	Yes
DocumentImage.IsExemptFromQualityAssurance	Boolean	Yes
DocumentImage.IsQualityAssuranceAlreadyPerformed	Boolean	Yes
DocumentImage.IsTextSearchable	Boolean	Yes
DocumentImage.OriginalFileName	String	No	Value must be no more than 200 characters
DocumentLanguage	String	Yes	Value must be an appropriate StudentDocumentLanguage code value
DocumentType	String	Yes
ExpiryDate	DateTime	No
IrrelevantDocuments	List<IrrelevantDocument>	No
IrrelevantDocuments.PASICoreVersion	Int64	Yes
IrrelevantDocuments.RefId	Guid	Yes
IsDeleted	Boolean	Yes
IsDigitized	Boolean	Yes
IsRelevant	Boolean	Yes
LinkedToOrganization	String	No	Value must be a valid organization code (e.g. s.1312).
LinkedToSchoolYear	Int16	No
PASICoreVersion	Int64	Yes
RefId	Guid	Yes
StateProvinceId	String	Yes	Value must be in the form of a number between '000000001' and '999999999'
Title	String	Yes	Value must be no more than 200 characters

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