Message Fields - PostTranscript Request
The PostTranscript method of the TranscriptRequestService WCF service enables the calling application to post Transcript Requests to the Anthology Student database.
PostTranscriptRequestInMsg
| Name | Required | Database Info (Table.Column) | Type | Description | Default | Example |
|---|---|---|---|---|---|---|
| SyStudentId | Conditional | SyStudent .SystudentId | Integer | The SyStudentId is the unique identifier used by Anthology Student. Optional if SyStudentId OR SSN provided. |
0 | 100077 |
| StudentNumber | Conditional | SyStudent.StuNum | String | Institution's Student Identifier. The legacy MCC Student Ids are converted into the Anthology Student Student Number with the leading zeros removed. Optional if SyStudentId OR SSN provided. |
ESMITH0964 | |
| SSN | Conditional | SyStudent.SSN | String | Optional if SyStudentId OR StudentNumber provided. | 100-07-0077 | |
| TranscriptType | Yes | CmTranscriptRequest. SystudentIdTranscriptType |
Enum | Student, College, Other,Undefined | Student | Student |
| CollegeCode | Conditional | AmCollege.Code | String | Code of college. Required if TranscriptType=College. | ADC | |
| Last Name | No | SyStudent.LastName | String | Populate the information from the Student Master if empty. | Smith-Gay | |
| First Name | No | SyStudent.FirstName | String | Populate the information from the Student Master if empty. | Emmie | |
| ContactName | Conditional | String | Contact person of student. Required if TranscriptType = Other. | MendesBrian | ||
| CompanyName | Conditional | String | Name of the Company. Required if TranscriptType = Other. | ABC Tech. | ||
| Address | No | SyStudent.Address | String | Populate the information from the Student Master if empty. | 10 NW Henderson | |
| City | No | SyStudent.City | String | Populate the information from the Student Master if empty. | SAN DIEGO | |
| State | No | SyStudent.State | String | Populate the information from the Student Master if empty. | CA | |
| Postal Code | No | SyStudent.Zip | String | Populate the information from the Student Master if empty. | 92112 | |
| Country | No | SyStudent.Country | String | Not updated in Student Master; cmTranscriptRequest.Country | India | |
| Comments | No | String | cmTranscriptRequest.comments | Comment1 | ||
| DateRequested | No | DateTime | Date and time | DateTime.Now | 5/5/2012 12:00:00:00 AM | |
| TranscriptRequestCount | No | Integer | MaxSize = 10 | 1 | 10 | |
| Update StudentInformationFlag |
Conditional | Boolean | Required if TranscriptType = Student | False | True |
PostTranscriptRequestOutMsg
| Name | Type | Description | Default | Example |
|---|---|---|---|---|
| SyStudentId | Integer | The SyStudentId is the unique identifier used by Anthology Student. | 0 | 100081 |
| TranscriptRequestIds | Int[] | CmTranscriptRequestId from CmTranscriptRequest table. | None | 25469 |
| TranscriptRequestPostedCount | Integer | 0 | 36 | |
| MessageId (GenericMsg type) | Integer | The message version for this type of record response. May be changed to reflect a specific format for the request message as changes are implemented. | 0 | |
| CorrelationId (GenericMsg type) | Integer | Tracking Id sent with the request for this record. | 0 | 245 |
| MessageResult (GenericOutMsg type) | String | String value with additional details on a failure. | ||
| MessageStatus (GenericOutMsg type) | String |
One of the values (MessageStatusType) that describes the processing status of this message:
|
OK | OK |
| MessageErrorCode (GenericOutMsg type) | String | Error description when the MessageStatus is not OK. | None | |
| MessageId (GenericMsg type) | Integer | The message version for this type of record response. May be changed to reflect a specific format for the request message as changes are implemented. | 0 |