The PostStudentLead method of the StudentWebService enables the calling application to post student lead information to the Anthology Student database.
PostStudentLeadRequest
| Name | Required | Description |
|---|---|---|
| UpdateStudentLeads | No | Array of requests to update student leads. See UpdateStudentLeadInMsg. |
| TokenId | Yes | The security token for the request. |
UpdateStudentLeadInMsg
| Name | Database Info (Table.Column) | Description |
|---|---|---|
| UpdateFields | Updates specific student fields based on a key-value pair of FieldName name and FieldValue. For more information, see Get List Web service. | |
| ProgramIds | AmProspectProgram.AdProgramId | Programs Identifiers |
| ExtraCurricularIds | AmProspectExtraCurr.AmExtraCurrId | Identifiers for the student's extracurricular activities |
| LeadSources | AmProspectLeadSrc.AmLeadSrcId | Array of LeadSourceMsg type. See LeadSourceMsg[]. |
| RaceIds | SyStudentAmRace.AmRaceId | Race Identifiers Note: If the RaceIds array field is null, existing RaceIds associated with the student will be preserved. If RaceIds array is not null, and has 0 or more elements, then depending on the business logic, the existing RaceIds associated with the student will be deleted and updated with the new Ids specified in the RaceIds array. |
| StudentId | SyStudent SyStudentId | Student Identifier |
LeadSourceMsg[]
| Name | Database Info (Table.Column) | Description |
|---|---|---|
| LeadSourceId | AmProspectLeadSrc.AmLeadSrcId | Lead Source Identifier |
| LeadVendorIds | AmProspectLeadSrcLeadVendor.SyOrganiztionId | Lead Vendor Identifiers |
| IsPrimarySource | AmProspectLeadSrc.PrimarySource | Custom values to save with the Student. Values are saved to the school defined fields in Anthology Student. The fields must be predefined. |
Note: Refer to the WSDL in the “Service Description” of the Web service, e.g., http://localhost/cmc.soa.Webservices.admissions/StudentWebService.asmx. The WSDL contains information on the fields and whether they are required (minOccurs = 1).
PostStudentLeadResponse
| Name | Description |
|---|---|
| UpdateStudentLeads | Array of requests to update student leads. |
| Status | Transaction Status |
| TrxResult | Transaction Result |
| TokenId | The security token for the request. |
UpdateStudentLeadOutMsg[]
The UpdateStudentLeadOutMsg is an extension of the GenericOutMsg.
