POST api/Education

Request Information

URI Parameters

None.

Body Parameters

EducationRequest

Name	Type	Additional information
PartnerCode	string	Required Max length: 20
Action	string	None.
Inquiries	Collection of EducationInquiry	None.

Name

Description

Type

Additional information

PartnerCode

string

Required

Max length: 20

Action

string

None.

Inquiries

Collection of EducationInquiry

None.

Request Formats

application/json, text/json

Sample:

{
  "PartnerCode": "sample string 1",
  "Action": "sample string 2",
  "Inquiries": [
    {
      "PartnerCode": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email1": "sample string 4",
      "Email2": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "ZipCode": "sample string 10",
      "Country": "sample string 11",
      "Phone1": "sample string 12",
      "Phone2": "sample string 13",
      "Type": "sample string 14",
      "Channel": "sample string 15",
      "Source": "sample string 16",
      "Vendor": "sample string 17",
      "SourceCampaign": "sample string 18",
      "SourceDetails": "sample string 19",
      "SourceInquiryId": "sample string 20",
      "Notes": "sample string 21",
      "Notes2": "sample string 22",
      "Notes3": "sample string 23",
      "Employer": "sample string 24",
      "CurrentProfession": "sample string 25",
      "WorkExperience": "sample string 26",
      "ConsentFlag": true,
      "Age": "sample string 28",
      "Income": "sample string 29",
      "DesiredAppointmentTime": "sample string 30",
      "MilitaryAffiliation": true,
      "PreferredContactMethod": "sample string 32",
      "Location": "sample string 33",
      "ProgramOfInterest": "sample string 34",
      "UpdatedProgramOfInterest": "sample string 35",
      "FullProgramName": "sample string 36",
      "MostRecentSchool": "sample string 37",
      "HighestEDULevel": "sample string 38",
      "HighSchoolGraduationYear": "sample string 39",
      "Term": "sample string 40",
      "EducationalGoals": "sample string 41",
      "CareerGoals": "sample string 42",
      "StartTimeline": "sample string 43",
      "FinancialAssistance": true,
      "ExternalSystemId": "sample string 45",
      "IntegrityContactRep": "sample string 46",
      "VelocifyDateAdded": "sample string 47",
      "VelocifyDateModified": "sample string 48",
      "FirstAssignment": "sample string 49",
      "FirstContactAttempt": "sample string 50",
      "LastContactAttempt": "sample string 51",
      "LeadActionCount": 52,
      "CreateToFirstContactAttempt": 53,
      "TotalContactAttempts": 54,
      "OriginalRequest": "sample string 55"
    },
    {
      "PartnerCode": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Email1": "sample string 4",
      "Email2": "sample string 5",
      "Address1": "sample string 6",
      "Address2": "sample string 7",
      "City": "sample string 8",
      "State": "sample string 9",
      "ZipCode": "sample string 10",
      "Country": "sample string 11",
      "Phone1": "sample string 12",
      "Phone2": "sample string 13",
      "Type": "sample string 14",
      "Channel": "sample string 15",
      "Source": "sample string 16",
      "Vendor": "sample string 17",
      "SourceCampaign": "sample string 18",
      "SourceDetails": "sample string 19",
      "SourceInquiryId": "sample string 20",
      "Notes": "sample string 21",
      "Notes2": "sample string 22",
      "Notes3": "sample string 23",
      "Employer": "sample string 24",
      "CurrentProfession": "sample string 25",
      "WorkExperience": "sample string 26",
      "ConsentFlag": true,
      "Age": "sample string 28",
      "Income": "sample string 29",
      "DesiredAppointmentTime": "sample string 30",
      "MilitaryAffiliation": true,
      "PreferredContactMethod": "sample string 32",
      "Location": "sample string 33",
      "ProgramOfInterest": "sample string 34",
      "UpdatedProgramOfInterest": "sample string 35",
      "FullProgramName": "sample string 36",
      "MostRecentSchool": "sample string 37",
      "HighestEDULevel": "sample string 38",
      "HighSchoolGraduationYear": "sample string 39",
      "Term": "sample string 40",
      "EducationalGoals": "sample string 41",
      "CareerGoals": "sample string 42",
      "StartTimeline": "sample string 43",
      "FinancialAssistance": true,
      "ExternalSystemId": "sample string 45",
      "IntegrityContactRep": "sample string 46",
      "VelocifyDateAdded": "sample string 47",
      "VelocifyDateModified": "sample string 48",
      "FirstAssignment": "sample string 49",
      "FirstContactAttempt": "sample string 50",
      "LastContactAttempt": "sample string 51",
      "LeadActionCount": 52,
      "CreateToFirstContactAttempt": 53,
      "TotalContactAttempts": 54,
      "OriginalRequest": "sample string 55"
    }
  ]
}

application/xml, text/xml

Sample:

<EducationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InquiriesService.Models.DTO">
  <Action>sample string 2</Action>
  <Inquiries>
    <EducationInquiry>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <Age>sample string 28</Age>
      <CareerGoals>sample string 42</CareerGoals>
      <Channel>sample string 15</Channel>
      <City>sample string 8</City>
      <ConsentFlag>true</ConsentFlag>
      <Country>sample string 11</Country>
      <CreateToFirstContactAttempt>53</CreateToFirstContactAttempt>
      <CurrentProfession>sample string 25</CurrentProfession>
      <DesiredAppointmentTime>sample string 30</DesiredAppointmentTime>
      <EducationalGoals>sample string 41</EducationalGoals>
      <Email1>sample string 4</Email1>
      <Email2>sample string 5</Email2>
      <Employer>sample string 24</Employer>
      <ExternalSystemId>sample string 45</ExternalSystemId>
      <FinancialAssistance>true</FinancialAssistance>
      <FirstAssignment>sample string 49</FirstAssignment>
      <FirstContactAttempt>sample string 50</FirstContactAttempt>
      <FirstName>sample string 2</FirstName>
      <FullProgramName>sample string 36</FullProgramName>
      <HighSchoolGraduationYear>sample string 39</HighSchoolGraduationYear>
      <HighestEDULevel>sample string 38</HighestEDULevel>
      <Income>sample string 29</Income>
      <IntegrityContactRep>sample string 46</IntegrityContactRep>
      <LastContactAttempt>sample string 51</LastContactAttempt>
      <LastName>sample string 3</LastName>
      <LeadActionCount>52</LeadActionCount>
      <Location>sample string 33</Location>
      <MilitaryAffiliation>true</MilitaryAffiliation>
      <MostRecentSchool>sample string 37</MostRecentSchool>
      <Notes>sample string 21</Notes>
      <Notes2>sample string 22</Notes2>
      <Notes3>sample string 23</Notes3>
      <OriginalRequest>sample string 55</OriginalRequest>
      <PartnerCode>sample string 1</PartnerCode>
      <Phone1>sample string 12</Phone1>
      <Phone2>sample string 13</Phone2>
      <PreferredContactMethod>sample string 32</PreferredContactMethod>
      <ProgramOfInterest>sample string 34</ProgramOfInterest>
      <Source>sample string 16</Source>
      <SourceCampaign>sample string 18</SourceCampaign>
      <SourceDetails>sample string 19</SourceDetails>
      <SourceInquiryId>sample string 20</SourceInquiryId>
      <StartTimeline>sample string 43</StartTimeline>
      <State>sample string 9</State>
      <Term>sample string 40</Term>
      <TotalContactAttempts>54</TotalContactAttempts>
      <Type>sample string 14</Type>
      <UpdatedProgramOfInterest>sample string 35</UpdatedProgramOfInterest>
      <VelocifyDateAdded>sample string 47</VelocifyDateAdded>
      <VelocifyDateModified>sample string 48</VelocifyDateModified>
      <Vendor>sample string 17</Vendor>
      <WorkExperience>sample string 26</WorkExperience>
      <ZipCode>sample string 10</ZipCode>
    </EducationInquiry>
    <EducationInquiry>
      <Address1>sample string 6</Address1>
      <Address2>sample string 7</Address2>
      <Age>sample string 28</Age>
      <CareerGoals>sample string 42</CareerGoals>
      <Channel>sample string 15</Channel>
      <City>sample string 8</City>
      <ConsentFlag>true</ConsentFlag>
      <Country>sample string 11</Country>
      <CreateToFirstContactAttempt>53</CreateToFirstContactAttempt>
      <CurrentProfession>sample string 25</CurrentProfession>
      <DesiredAppointmentTime>sample string 30</DesiredAppointmentTime>
      <EducationalGoals>sample string 41</EducationalGoals>
      <Email1>sample string 4</Email1>
      <Email2>sample string 5</Email2>
      <Employer>sample string 24</Employer>
      <ExternalSystemId>sample string 45</ExternalSystemId>
      <FinancialAssistance>true</FinancialAssistance>
      <FirstAssignment>sample string 49</FirstAssignment>
      <FirstContactAttempt>sample string 50</FirstContactAttempt>
      <FirstName>sample string 2</FirstName>
      <FullProgramName>sample string 36</FullProgramName>
      <HighSchoolGraduationYear>sample string 39</HighSchoolGraduationYear>
      <HighestEDULevel>sample string 38</HighestEDULevel>
      <Income>sample string 29</Income>
      <IntegrityContactRep>sample string 46</IntegrityContactRep>
      <LastContactAttempt>sample string 51</LastContactAttempt>
      <LastName>sample string 3</LastName>
      <LeadActionCount>52</LeadActionCount>
      <Location>sample string 33</Location>
      <MilitaryAffiliation>true</MilitaryAffiliation>
      <MostRecentSchool>sample string 37</MostRecentSchool>
      <Notes>sample string 21</Notes>
      <Notes2>sample string 22</Notes2>
      <Notes3>sample string 23</Notes3>
      <OriginalRequest>sample string 55</OriginalRequest>
      <PartnerCode>sample string 1</PartnerCode>
      <Phone1>sample string 12</Phone1>
      <Phone2>sample string 13</Phone2>
      <PreferredContactMethod>sample string 32</PreferredContactMethod>
      <ProgramOfInterest>sample string 34</ProgramOfInterest>
      <Source>sample string 16</Source>
      <SourceCampaign>sample string 18</SourceCampaign>
      <SourceDetails>sample string 19</SourceDetails>
      <SourceInquiryId>sample string 20</SourceInquiryId>
      <StartTimeline>sample string 43</StartTimeline>
      <State>sample string 9</State>
      <Term>sample string 40</Term>
      <TotalContactAttempts>54</TotalContactAttempts>
      <Type>sample string 14</Type>
      <UpdatedProgramOfInterest>sample string 35</UpdatedProgramOfInterest>
      <VelocifyDateAdded>sample string 47</VelocifyDateAdded>
      <VelocifyDateModified>sample string 48</VelocifyDateModified>
      <Vendor>sample string 17</Vendor>
      <WorkExperience>sample string 26</WorkExperience>
      <ZipCode>sample string 10</ZipCode>
    </EducationInquiry>
  </Inquiries>
  <PartnerCode>sample string 1</PartnerCode>
</EducationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'EducationRequest'.

Response Information

Resource Description

EducationResponse

Name	Description	Type	Additional information
Receipt	GUID - unique ID serving as a receipt for the request	string	None.
TimeStamp	Date/time on which request was received	date	None.
Status	Status of request	string	None.
Message	Any additional details relating to the request, including error information	string	None.
ReceivedInquiries		Collection of EducationInquiryResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Receipt": "sample string 1",
  "TimeStamp": "2024-11-29T20:41:21.529435+00:00",
  "Status": "sample string 2",
  "Message": "sample string 3",
  "ReceivedInquiries": [
    {
      "Receipt": "sample string 1",
      "TimeStamp": "2024-11-29T20:41:21.529435+00:00",
      "Status": "sample string 2",
      "Message": "sample string 3",
      "ReceivedInquiry": {
        "PartnerCode": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email1": "sample string 4",
        "Email2": "sample string 5",
        "Address1": "sample string 6",
        "Address2": "sample string 7",
        "City": "sample string 8",
        "State": "sample string 9",
        "ZipCode": "sample string 10",
        "Country": "sample string 11",
        "Phone1": "sample string 12",
        "Phone2": "sample string 13",
        "Type": "sample string 14",
        "Channel": "sample string 15",
        "Source": "sample string 16",
        "Vendor": "sample string 17",
        "SourceCampaign": "sample string 18",
        "SourceDetails": "sample string 19",
        "SourceInquiryId": "sample string 20",
        "Notes": "sample string 21",
        "Notes2": "sample string 22",
        "Notes3": "sample string 23",
        "Employer": "sample string 24",
        "CurrentProfession": "sample string 25",
        "WorkExperience": "sample string 26",
        "ConsentFlag": true,
        "Age": "sample string 28",
        "Income": "sample string 29",
        "DesiredAppointmentTime": "sample string 30",
        "MilitaryAffiliation": true,
        "PreferredContactMethod": "sample string 32",
        "Location": "sample string 33",
        "ProgramOfInterest": "sample string 34",
        "UpdatedProgramOfInterest": "sample string 35",
        "FullProgramName": "sample string 36",
        "MostRecentSchool": "sample string 37",
        "HighestEDULevel": "sample string 38",
        "HighSchoolGraduationYear": "sample string 39",
        "Term": "sample string 40",
        "EducationalGoals": "sample string 41",
        "CareerGoals": "sample string 42",
        "StartTimeline": "sample string 43",
        "FinancialAssistance": true,
        "ExternalSystemId": "sample string 45",
        "IntegrityContactRep": "sample string 46",
        "VelocifyDateAdded": "sample string 47",
        "VelocifyDateModified": "sample string 48",
        "FirstAssignment": "sample string 49",
        "FirstContactAttempt": "sample string 50",
        "LastContactAttempt": "sample string 51",
        "LeadActionCount": 52,
        "CreateToFirstContactAttempt": 53,
        "TotalContactAttempts": 54,
        "OriginalRequest": "sample string 55"
      }
    },
    {
      "Receipt": "sample string 1",
      "TimeStamp": "2024-11-29T20:41:21.529435+00:00",
      "Status": "sample string 2",
      "Message": "sample string 3",
      "ReceivedInquiry": {
        "PartnerCode": "sample string 1",
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "Email1": "sample string 4",
        "Email2": "sample string 5",
        "Address1": "sample string 6",
        "Address2": "sample string 7",
        "City": "sample string 8",
        "State": "sample string 9",
        "ZipCode": "sample string 10",
        "Country": "sample string 11",
        "Phone1": "sample string 12",
        "Phone2": "sample string 13",
        "Type": "sample string 14",
        "Channel": "sample string 15",
        "Source": "sample string 16",
        "Vendor": "sample string 17",
        "SourceCampaign": "sample string 18",
        "SourceDetails": "sample string 19",
        "SourceInquiryId": "sample string 20",
        "Notes": "sample string 21",
        "Notes2": "sample string 22",
        "Notes3": "sample string 23",
        "Employer": "sample string 24",
        "CurrentProfession": "sample string 25",
        "WorkExperience": "sample string 26",
        "ConsentFlag": true,
        "Age": "sample string 28",
        "Income": "sample string 29",
        "DesiredAppointmentTime": "sample string 30",
        "MilitaryAffiliation": true,
        "PreferredContactMethod": "sample string 32",
        "Location": "sample string 33",
        "ProgramOfInterest": "sample string 34",
        "UpdatedProgramOfInterest": "sample string 35",
        "FullProgramName": "sample string 36",
        "MostRecentSchool": "sample string 37",
        "HighestEDULevel": "sample string 38",
        "HighSchoolGraduationYear": "sample string 39",
        "Term": "sample string 40",
        "EducationalGoals": "sample string 41",
        "CareerGoals": "sample string 42",
        "StartTimeline": "sample string 43",
        "FinancialAssistance": true,
        "ExternalSystemId": "sample string 45",
        "IntegrityContactRep": "sample string 46",
        "VelocifyDateAdded": "sample string 47",
        "VelocifyDateModified": "sample string 48",
        "FirstAssignment": "sample string 49",
        "FirstContactAttempt": "sample string 50",
        "LastContactAttempt": "sample string 51",
        "LeadActionCount": 52,
        "CreateToFirstContactAttempt": 53,
        "TotalContactAttempts": 54,
        "OriginalRequest": "sample string 55"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<EducationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/InquiriesService.Models.DTO">
  <Message>sample string 3</Message>
  <Receipt>sample string 1</Receipt>
  <ReceivedInquiries>
    <EducationInquiryResponse>
      <Message>sample string 3</Message>
      <Receipt>sample string 1</Receipt>
      <ReceivedInquiry>
        <Address1>sample string 6</Address1>
        <Address2>sample string 7</Address2>
        <Age>sample string 28</Age>
        <CareerGoals>sample string 42</CareerGoals>
        <Channel>sample string 15</Channel>
        <City>sample string 8</City>
        <ConsentFlag>true</ConsentFlag>
        <Country>sample string 11</Country>
        <CreateToFirstContactAttempt>53</CreateToFirstContactAttempt>
        <CurrentProfession>sample string 25</CurrentProfession>
        <DesiredAppointmentTime>sample string 30</DesiredAppointmentTime>
        <EducationalGoals>sample string 41</EducationalGoals>
        <Email1>sample string 4</Email1>
        <Email2>sample string 5</Email2>
        <Employer>sample string 24</Employer>
        <ExternalSystemId>sample string 45</ExternalSystemId>
        <FinancialAssistance>true</FinancialAssistance>
        <FirstAssignment>sample string 49</FirstAssignment>
        <FirstContactAttempt>sample string 50</FirstContactAttempt>
        <FirstName>sample string 2</FirstName>
        <FullProgramName>sample string 36</FullProgramName>
        <HighSchoolGraduationYear>sample string 39</HighSchoolGraduationYear>
        <HighestEDULevel>sample string 38</HighestEDULevel>
        <Income>sample string 29</Income>
        <IntegrityContactRep>sample string 46</IntegrityContactRep>
        <LastContactAttempt>sample string 51</LastContactAttempt>
        <LastName>sample string 3</LastName>
        <LeadActionCount>52</LeadActionCount>
        <Location>sample string 33</Location>
        <MilitaryAffiliation>true</MilitaryAffiliation>
        <MostRecentSchool>sample string 37</MostRecentSchool>
        <Notes>sample string 21</Notes>
        <Notes2>sample string 22</Notes2>
        <Notes3>sample string 23</Notes3>
        <OriginalRequest>sample string 55</OriginalRequest>
        <PartnerCode>sample string 1</PartnerCode>
        <Phone1>sample string 12</Phone1>
        <Phone2>sample string 13</Phone2>
        <PreferredContactMethod>sample string 32</PreferredContactMethod>
        <ProgramOfInterest>sample string 34</ProgramOfInterest>
        <Source>sample string 16</Source>
        <SourceCampaign>sample string 18</SourceCampaign>
        <SourceDetails>sample string 19</SourceDetails>
        <SourceInquiryId>sample string 20</SourceInquiryId>
        <StartTimeline>sample string 43</StartTimeline>
        <State>sample string 9</State>
        <Term>sample string 40</Term>
        <TotalContactAttempts>54</TotalContactAttempts>
        <Type>sample string 14</Type>
        <UpdatedProgramOfInterest>sample string 35</UpdatedProgramOfInterest>
        <VelocifyDateAdded>sample string 47</VelocifyDateAdded>
        <VelocifyDateModified>sample string 48</VelocifyDateModified>
        <Vendor>sample string 17</Vendor>
        <WorkExperience>sample string 26</WorkExperience>
        <ZipCode>sample string 10</ZipCode>
      </ReceivedInquiry>
      <Status>sample string 2</Status>
      <TimeStamp>2024-11-29T20:41:21.529435+00:00</TimeStamp>
    </EducationInquiryResponse>
    <EducationInquiryResponse>
      <Message>sample string 3</Message>
      <Receipt>sample string 1</Receipt>
      <ReceivedInquiry>
        <Address1>sample string 6</Address1>
        <Address2>sample string 7</Address2>
        <Age>sample string 28</Age>
        <CareerGoals>sample string 42</CareerGoals>
        <Channel>sample string 15</Channel>
        <City>sample string 8</City>
        <ConsentFlag>true</ConsentFlag>
        <Country>sample string 11</Country>
        <CreateToFirstContactAttempt>53</CreateToFirstContactAttempt>
        <CurrentProfession>sample string 25</CurrentProfession>
        <DesiredAppointmentTime>sample string 30</DesiredAppointmentTime>
        <EducationalGoals>sample string 41</EducationalGoals>
        <Email1>sample string 4</Email1>
        <Email2>sample string 5</Email2>
        <Employer>sample string 24</Employer>
        <ExternalSystemId>sample string 45</ExternalSystemId>
        <FinancialAssistance>true</FinancialAssistance>
        <FirstAssignment>sample string 49</FirstAssignment>
        <FirstContactAttempt>sample string 50</FirstContactAttempt>
        <FirstName>sample string 2</FirstName>
        <FullProgramName>sample string 36</FullProgramName>
        <HighSchoolGraduationYear>sample string 39</HighSchoolGraduationYear>
        <HighestEDULevel>sample string 38</HighestEDULevel>
        <Income>sample string 29</Income>
        <IntegrityContactRep>sample string 46</IntegrityContactRep>
        <LastContactAttempt>sample string 51</LastContactAttempt>
        <LastName>sample string 3</LastName>
        <LeadActionCount>52</LeadActionCount>
        <Location>sample string 33</Location>
        <MilitaryAffiliation>true</MilitaryAffiliation>
        <MostRecentSchool>sample string 37</MostRecentSchool>
        <Notes>sample string 21</Notes>
        <Notes2>sample string 22</Notes2>
        <Notes3>sample string 23</Notes3>
        <OriginalRequest>sample string 55</OriginalRequest>
        <PartnerCode>sample string 1</PartnerCode>
        <Phone1>sample string 12</Phone1>
        <Phone2>sample string 13</Phone2>
        <PreferredContactMethod>sample string 32</PreferredContactMethod>
        <ProgramOfInterest>sample string 34</ProgramOfInterest>
        <Source>sample string 16</Source>
        <SourceCampaign>sample string 18</SourceCampaign>
        <SourceDetails>sample string 19</SourceDetails>
        <SourceInquiryId>sample string 20</SourceInquiryId>
        <StartTimeline>sample string 43</StartTimeline>
        <State>sample string 9</State>
        <Term>sample string 40</Term>
        <TotalContactAttempts>54</TotalContactAttempts>
        <Type>sample string 14</Type>
        <UpdatedProgramOfInterest>sample string 35</UpdatedProgramOfInterest>
        <VelocifyDateAdded>sample string 47</VelocifyDateAdded>
        <VelocifyDateModified>sample string 48</VelocifyDateModified>
        <Vendor>sample string 17</Vendor>
        <WorkExperience>sample string 26</WorkExperience>
        <ZipCode>sample string 10</ZipCode>
      </ReceivedInquiry>
      <Status>sample string 2</Status>
      <TimeStamp>2024-11-29T20:41:21.529435+00:00</TimeStamp>
    </EducationInquiryResponse>
  </ReceivedInquiries>
  <Status>sample string 2</Status>
  <TimeStamp>2024-11-29T20:41:21.529435+00:00</TimeStamp>
</EducationResponse>