Ministry only service. This service add or update a student's Authorized User on myPass.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
SubmitStudentAuthorizedUserResponse SubmitAuthorizedUser( SubmitStudentAuthorizedUserRequest request )
Parameters
- request
- Type: PASI.DataContract.SystemSubmitStudentAuthorizedUserRequest
The request includes the name, relationship type, email of the Authorized User and the StateProviceId of the student that it should be associated to.
Return Value
Type: SubmitStudentAuthorizedUserResponseSubmit response includes the ID of the Authorized User record, and the new PASI Core Version of the record.
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.
60087, 60089, 60091, 60093, 69005Remarks
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 |
| EmailAddress | String | Yes | |
| ExpiryDate | DateTime | Yes | |
| IsDeleted | Boolean | Yes | |
| Name | String | Yes | |
| PASICoreVersion | Int64 | Yes | |
| RefId | Int32 | Yes | |
| RelationshipType | String | Yes | Value must be an appropriate AuthorizedUserRelationship code value |
| StateProvinceId | String | Yes | Value must be in the form of a number between '000000001' and '999999999' |
Response Fields
| Full Property Name | Type | Required | Other Attributes |
|---|---|---|---|
| SubmitStudentAuthorizedUserResponse.AccessCode | String | No | |
| SubmitStudentAuthorizedUserResponse.Id | String | No | |
| SubmitStudentAuthorizedUserResponse.PASICoreVersion | Int64 | No | |
| SubmitStudentAuthorizedUserResponse.Rejections | List<Rejection> | No | |
| SubmitStudentAuthorizedUserResponse.Rejections.Code | String | Yes | |
| SubmitStudentAuthorizedUserResponse.Rejections.Description | String | Yes |
See Also