AddNewLeadRequest
| Name | Database Info (Table.Column) | Description |
|---|---|---|
| Leads | N/A | Array of requests to add new leads. See LeadInMsg[]. |
| IgnoreDuplicates | N/A | Boolean value. Specifies whether or not to check for duplicates. For more information, see Code Samples. |
| ValidationTemplateId | SyQuickLeadTemplate. SyQuickLeadTemplateId | Specifies quick lead template validation to use. If not specified, the default template is used. |
| UseValidationTemplate | N/A | Boolean value. Specifies whether or not to use quick lead template validation. |
| TokenId | N/A | The security token for the request. |
LeadInMsg[]
| Name | Database Info (Table.Column) | Required | Description |
|---|---|---|---|
| LastName | SyStudent.LastName | Yes | Person's last name |
| FirstName | SyStudent.FirstName | Yes | Person's first name |
| SchoolStatusId | SyStudent.SySchoolStatusId | Yes | School status identifier |
| LeadDate | SyStudent.LeadDate | Yes | Lead date |
| CampusId | SyStudent.SyCampusId | Yes | Identifier for campus location |
| AdmissionsOfficerId | SyStudent.AmRepId | Yes | Identifier for admissions representative |
| SSN | SyStudent.SSN | No | Social Security Number |
| GenderId | SyStudent.AmSexId | No | Person's gender (M or F) |
| LeadTypeId | SyStudent.AmLeadTypeId | No | Identifier for the lead type |
| LeadSourceId | SyStudent.AmLeadSrcId | No | Identifier for the lead source |
| Address | SyStudent.Addr1 | No | Address of the lead |
| City | SyStudent.City | No | City |
| StateId | SyStudent.State | No | State |
| PostalCode | SyStudent.Zip | No |
Postal Code
/ ZIP For details about the validation of postal codes, see Custom Validation for Postal Codes. |
| CountryId | SyStudent.SyCountryId | No | Country identifier |
| CountyId | SyStudent.SyCountyId | No | County identifier |
| Phone | SyStudent.Phone | No | Home telephone number |
| WorkPhone | SyStudent.WorkPhone | No | Work telephone number |
| WorkPhoneExtension | SyStudent.Workext | No | Work telephone extension |
| MobileNumber | SyStudent.MobileNumber | Conditional | Required when SubScribeToSMS = True. |
| AreaOfInterestId | SyStudent.AdProgramGroupId | No | Identifier for Area of Interest (ProgramGroup) |
| ProgramIds | AmProspectProgram.AdProgramId | No | Identifiers for Program(s) of Interest |
| AgencyId | SyStudent.AmAgencyId | No | Identifier for Agency / Sponsor |
| HighSchoolGradDate | AmProspectPrevEduc.HsGradDate | No |
High school graduation date
Note: The |
| LeadId | SyStudent.SyStudentId | No | Database identifier for the lead. For Qualified Leads this is the SyStudentId, for non-qualified it is the AmElectronicLeadsId. |
| AlienRegistrationNumber | SyStudent.AlienNo | No | Alien registration number |
| BestTimeToContact | SyStudent.BestTimeToContact | No | Best time of day to contact the lead. |
| BirthDate | SyStudent.DOB | No | Person’s date of birth |
| CitizenshipId | SyStudent.AmCitizenId | No | Citizenship identifier |
| CollegeId | SyStudent.AmCollegeId | No | Row identifier for the college (if any) that the person is currently attending. |
| Comments | SyStudent.Comment | No | Comments |
| CurrentEmployerId | SyStudent.PlEmployerId | No | Current employer identifier |
| HasDisability | SyStudent.Disabled | No | Does this person have a disability? |
| IsVeteran | SyStudent.Vet | No | Is this person a veteran of the Armed Forces? |
| DriversLicenseNumber | SyStudent.DrivLic | No | Driver’s license number |
| DriversLicenseStateId | SyStudent.DrivLicState | No | Driver’s license state identifier |
| SyStudent.Email | No | Email address | |
| EmploymentStatusId | SyStudent.plEmpStatusId | No | Current employment status identifier |
| ExpectedStartDate | SyStudent.StartDate | No | Expected start date |
| ExtraCurricularIds |
AmProspectExtraCurr. AmExtraCurrId |
No | Array of extra curricular identifiers |
| OtherEmail | SyStudent.OtherEmail | No | Secondary email |
| NickName | SyStudent.NickName | No | Person’s nick name |
| OtherPhone | SyStudent.OtherPhone | No | Secondary phone number |
| PreviousEducationId |
AmProspectPrevEduc. AmPrevEducId |
No | Previous education identifier |
| HighSchoolId | No | High school identifier Note: The |
|
| HighSchoolDateEnrolled |
AmProspectPrevEduc. HSDateEnrolled |
No | High school date enrolled |
| HighSchoolGraduate |
AmProspectPrevEduc. HSGraduated |
No | Is this lead a high school graduate? Boolean: True/False |
| HighSchoolGraduationSession |
AmProspectPrevEduc. HSGraduationSession |
No | High school graduation session for this lead |
| HighSchoolGraduationYear |
AmProspectPrevEduc. HSGradYear |
No | High school graduation year |
| HighSchoolLastDateAttended |
AmProspectPrevEduc. HSLastDateAttended |
No | Last date attended high school |
| HighSchoolSize |
AmProspectPrevEduc. HSSchoolSize |
No | High school size |
| HighSchoolStudentLevel |
AmProspectPrevEduc. HSStudLevel |
No |
High school student level
Note: The |
| HighSchoolStudentRank |
AmProspectPrevEduc. HSStudRank |
No | High school student rank |
| HighSchoolTranscriptType |
AmProspectPrevEduc. HSTranscriptType |
No | High school transcript type |
| MaidenName | SyStudent.MaidenName | No | Person’s maiden name |
| MaritalStatusId | SyStudent.AmMaritalId | No | Person’s marital status identifier |
| MiddleName | SyStudent.MI | No | Middle name |
| SourceSystem | SourceSystem | No | Indicates where the lead originated from (Database default: “C” for Anthology Student, M=MS CRM. |
| NationalityId | SyStudent.AmNationalityId | No | Nationality identifier |
| IsHispanic | SyStudent.IsHispanic | No | Is the person hispanic? |
| RaceIds |
SyStudentAmRace. OR
AmElectronicsLeadsAmRace. AmRaceId |
No | Database identifier for races |
| VerifiedLead | none | No | Is this a verified lead? Verified are posted directly to the active lead table, non-verified go to the holding table (amElectronicLeads). |
| TitleId | SyStudent.AmTitle | No | Person’s title |
| SuffixId | SyStudent.Suffix | No | Person’s suffix |
| ShiftId | SyStudent.AdShift | No | Person’s shift (morning/evening/etc.) |
| HSAcademicGPA | SyStudent.HSAcademicGPA | No | GPA for high school academic courses |
| LeadVendorIds | SyStudent.SyOrganizationId | No | Lead vendor identifier |
| SyStudentInquiryId | SyStudentInquiry. SyStudentInquiryId |
No | Database Identifier for the Student Inquiry |
| CRMSupressFlag | N/A | Yes |
It is a required flag. Values are false or true. The CrmSuppressFlag is used in the CRM triggers on the syStudent table to determine if a record should be added to the CRM queue. If Anthology is set up to integrate with CRM and a record is added/updated to syStudent with the CrmSuppressFlag set to false, the record will be added to the CRM queue. If the CrmSuppressFlag is set to true, the record will not be added to the CRM queue. The flag is only intended to be set to true on records coming from the Connector product to stop records that are coming from the CampusNexus CRM system from being sent back to CampusNexus CRM. |
| CMSMSServiceProviderID | Conditional | SMS Service Provider Identifier If the CMSMSServiceProviderID exists in the database but it is in "Inactive" state, a validation message states "Provided CMSMSServiceProviderID is inactive." If provided value is not available in database, validation message “The value provided for property CMSMSserviceProviderId is invalid.“ is displayed. |
|
| SubscribeToSMS | No | Boolean: True/False If SubscribeToSMS is set to true, the CMSMSServiceProviderID and MobileNumber are required. |
AddNewLeadResponse
| Name | Description |
|---|---|
| Leads | Array of responses to add new lead request messages. See LeadOutMsg[]. |
| Status | Transaction Status |
| TrxResult | Transaction Result |
| TokenId | The security token for the request. |
LeadOutMsg[]
| Name | Database Info (Table.Column) | Description |
|---|---|---|
| LastName | SyStudent.LastName | Person's last name |
| FirstName | SyStudent.FirstName | Person's first name |
| SchoolStatusId | SyStudent.SySchoolStatusId | School status identifier |
| LeadDate | SyStudent.LeadDate | Lead date |
| CampusId | SyStudent.SyCampusId | Identifier for campus location |
| AdmissionsOfficerId | SyStudent.AmRepId | Identifier for admissions representative |
| SSN | SyStudent.SSN | Social Security Number |
| GenderId | SyStudent.AmSexId | Person's gender (M or F) |
| LeadTypeId | SyStudent.AmLeadTypeId | Identifier for the lead type |
| LeadSourceId | SyStudent.AmLeadSrcId | Identifier for the lead source |
| Address | SyStudent.Addr1 | Address of the lead |
| City | SyStudent.City | City |
| StateId | SyStudent.State | State |
| PostalCode | SyStudent.Zip |
Postal Code
/ ZIP For details about the validation of postal codes, see Custom Validation for Postal Codes. |
| CountryId | SyStudent.SyCountryId | Country identifier |
| CountyId | SyStudent.SyCountyId | County Identifier |
| Phone | SyStudent.Phone | Home telephone number |
| WorkPhone | SyStudent.WorkPhone | Work telephone number |
| WorkPhoneExtension | SyStudent.Workext | Work telephone extension |
| MobileNumber | SyStudent.MobileNumber | Mobile phone |
| AreaOfInterestId | SyStudent.AdProgramGroupId | Identifier for Area of Interest (ProgramGroup) |
| ProgramIds | AmProspectProgram.AdProgramId | Identifiers for Program(s) of Interest |
| AgencyId | SyStudent.AmAgencyId | Identifier for Agency / Sponsor |
| HighSchoolGradDate | AmProspectPrevEduc.HsGradDate | High school graduation date |
| LeadId | SyStudent.SyStudentId | Database identifier for the lead. For Qualified Leads this is the SyStudentId, for non-qualified it is the AmElectronicLeadsId. |
| AlienRegistrationNumber | SyStudent.AlienNo | Alien registration number |
| BestTimeToContact | SyStudent.BestTimeToContact | Best time of day to contact the lead. |
| BirthDate | SyStudent.DOB | Person’s date of birth |
| CitizenshipId | SyStudent.AmCitizenId | Citizenship identifier |
| CollegeId | SyStudent.AmCollegeId | Row identifier for the college (if any) that the person is currently attending. |
| Comments | SyStudent.Comment | Comments |
| CurrentEmployerId | SyStudent.PlEmployerId | Current employer identifier |
| HasDisability | SyStudent.Disabled | Does this person have a disability? |
| IsVeteran | SyStudent.Vet | Is this person a veteran of the Armed Forces? |
| DriversLicenseNumber | SyStudent.DrivLic | Driver’s license number |
| DriversLicenseStateId | SyStudent.DrivLicState | Driver’s license state identifier |
| SyStudent.Email | Email address | |
| EmploymentStatusId | SyStudent.plEmpStatusId | Current employment status identifier |
| ExpectedStartDate | SyStudent.StartDate | Expected start date |
| ExtraCurricularIds | AmProspectExtraCurr.AmExtraCurrId | Array of extra curricular identifiers |
| OtherEmail | SyStudent.OtherEmail | Secondary email |
| NickName | SyStudent.NickName | Person’s nick name |
| OtherPhone | SyStudent.OtherPhone | Secondary phone number |
| PreviousEducationId | AmProspectPrevEduc.AmPrevEducId | Previous education identifier |
| HighSchoolId | High school identifier | |
| HighSchoolDateEnrolled | AmProspectPrevEduc.HSDateEnrolled | High school date enrolled |
| HighSchoolGraduate | AmProspectPrevEduc.HSGraduated | Is this lead a high school graduate? Boolean: True/False |
| HighSchoolGraduationSession | AmProspectPrevEduc.HSGraduationSession | High school graduation session for this lead |
| HighSchoolGraduationYear | AmProspectPrevEduc.HSGradYear | High school graduation year |
| HighSchoolLastDateAttended | AmProspectPrevEduc.HSLastDateAttended | Last date attended high school |
| HighSchoolSize | AmProspectPrevEduc.HSSchoolSize | High school size |
| HighSchoolStudentLevel | AmProspectPrevEduc.HSStudLevel | High school student level |
| HighSchoolStudentRank | AmProspectPrevEduc.HSStudRank | High school student rank |
| HighSchoolTranscriptType | AmProspectPrevEduc.HSTranscriptType | High school transcript type |
| MaidenName | SyStudent.MaidenName | Person’s maiden name |
| MaritalStatusId | SyStudent.AmMaritalId | Person’s marital status identifier |
| MiddleName | SyStudent.MI | Middle name |
| SourceSystem | SourceSystem | Indicates where the lead originated from (Database default: “C” for Anthology Student, M=MS CRM. |
| NationalityId | SyStudent.AmNationalityId | Nationality identifier |
| IsHispanic | SyStudent.IsHispanic | Is the person Hispanic? |
| RaceIds | SyStudentAmRace. OR AmElectronicsLeadsAmRace.AmRaceId | Database identifier for races |
| VerifiedLead | N/A | Is this a verified lead? Verified are posted directly to the active lead table, non-verified go to the holding table (amElectronicLeads). |
| TitleId | SyStudent.AmTitle | Person’s title |
| SuffixId | SyStudent.Suffix | Person’s suffix |
| ShiftId | SyStudent.AdShift | Person’s shift (morning/evening/etc.) |
| HSAcademicGPA | SyStudent.HSAcademicGPA | GPA for high school academic courses |
| LeadVendorIds | SyStudent.SyOrganizationId | Lead vendor identifier |
| SyStudentInquiryId | SyStudentInquiry.SyStudentInquiryId | Database Identifier for the Student Inquiry |
| CRMSupressFlag | N/A | Boolean: True/False The CrmSuppressFlag is used in the CRM triggers on the syStudent table to determine if a record should be added to the CRM queue. If Anthology is set up to integrate with CRM and a record is added/updated in syStudent with the CrmSuppressFlag set to false, the record will be added to the CRM queue. If the CrmSuppressFlag is set to true, the record will not be added to the CRM queue. The flag is only intended to be set to true on records coming from the Connector product to stop records that are coming from the CampusNexus CRM system from being sent back to CampusNexus CRM. |
| CMSMSServiceProviderID | SMS Service Provider Identifier If the CMSMSServiceProviderID exists in the database but it is in "Inactive" state, a validation message states "Provided CMSMSServiceProviderID is inactive." |
|
| SubscribeToSMS | Boolean: True/False If SubscribeToSMS is set to true, the CMSMSServiceProviderID is required. |
