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

Parameters

request

Type: PASI.DataContract.V2009SubmitStudentStatusAcknowledgementRequest
The request SubmitStudentStatusAcknowledgementRequest contains the student id and related acknowledgement information to submit

Return Value

Type: SubmitResponse
The response SubmitResponse contains any rejection that occurred. The Id returned is the alert code (the PASICoreVersion is not used.)

If any rejections are returned the acknowledgement is not saved in the PASI core.

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, 9010, 12000, 12001, 12002, 12003, 12004 A core alert is identified by the student id, an alert code, and a set of argument key/value pairs. An acknowledgement must be matched to a core alert with the same student id, alert code, and set of key/value pairs. If a corresponding core alert could not be found the acknowledgement submission is rejected.

The student ids and alert codes must be the same. For the most part, the key/value pairs must also be the same to be considered equivalent. For keys, the keys must match exactly but the order of the keys does not matter. For values, if a value is a comma delimited set of integers the order of the codes in the value does not matter. For all other cases the values must match verbatim.

The acknowledgement status for Advice core alerts may be set to "Unacknowledged", "InProgress", or "Acknowledged." The acknowledgement status for Warning core alerts may be set to "Unacknowledged" or "InProgress." The acknowledgements for a student persist even if the student is resubmitted and a different set of core alerts generated. The exception to this is a core alert that no longer exists that was previously acknowledged as InProgress. InProgress acknowledgements for core alerts that no longer exist are removed from the PASI core.

Request and Response Class Diagram

Request Fields

Full Property Name	Type	Required	Other Attributes
AlertCode	Int32	Yes
Arguments	List<KeyValuePair>	No
Arguments.Key	String	Yes
Arguments.Value	String	Yes	PASI.Validation.Schema.IsNotRequired
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
StateProvinceId	String	Yes	Value must be in the form of a number between '000000001' and '999999999'
Status	String	Yes	Value must be an appropriate AcknowledgementStatus code value

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