This service will allow a phone numbers to be marked as a preferred phone number.
Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.25.26.0 (9.25.26.0)
Syntax
Parameters
- request
- Type: PASI.DataContract.V2018SubmitPreferredPhoneNumberRequest
Contains which phone number RefId that will be marked as preferred.
Return Value
Type: SubmitResponseThe Id returned in this service will be the Student's StateProvinceId. The PASICoreVersion is the new version for the student.
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, 9006, 9010, 9011, 11267Remarks
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 |
| PASICoreVersion | Int64 | Yes | |
| PhoneNumberRefId | Int32 | Yes | |
| 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 |
|---|---|---|---|
| SubmitResponse.Id | String | No | |
| SubmitResponse.PASICoreVersion | Int64 | No | |
| SubmitResponse.Rejections | List<Rejection> | No | |
| SubmitResponse.Rejections.Code | String | Yes | |
| SubmitResponse.Rejections.Description | String | Yes |
See Also