Education Dynamics Partner API

Directory

MethodAPIDescription
POST api/directory/categories

This method returns a list of all categories currently available for this API Key that matches the given input parameters (ANDed together). The Category IDs returned can be used as inputs to the other API methods when filtering results.

POST api/directory/institutions

This method returns a list of institutions currently available for this API Key that match the given input parameters (ORed together within a parameter, but ANDed together across parameters). Output order is based upon Eddy’s own internal optimization algorithm.

POST api/directory/programlevels

This method returns a list of all currently available program levels for this API Key that match the given input parameters (ANDed together). The Level IDs returned can be used as inputs to the other API methods when filtering results.

POST api/directory/programmatches

This method returns a list of matching programs for the user data submitted.

POST api/directory/programs

This method returns a list of all programs currently available for this API Key that matches the given input parameters (ANDed together). Output order is based upon EDDY’s own internal optimization algorithm.

POST api/directory/specialties

This method returns a list of all subcategories currently available for this API Key that matches the given input parameters (ANDed together). The SubCategory IDs returned can be used as inputs to the other API methods when filtering results.

POST api/directory/subjects

This method returns a list of all subcategories currently available for this API Key that matches the given input parameters (ANDed together). The SubCategory IDs returned can be used as inputs to the other API methods when filtering results.

POST api/directory/zipcodes

This method returns a list of all zip codes for this API Key that match the given input parameters for the given campus.

Program

MethodAPIDescription
POST api/program/details

This method returns program detail information

POST api/program/form

Host and Post partners can use this method to get back the field names and Types for a program. The list of possible input type property values are "Text Box","Text Area","Radio Buttons","Multi Check Box List","Drop-Down","Label","Check Box","Date", and "Hidden"

Lead

MethodAPIDescription
POST api/lead/save

The Host and Post service is located at https://partners.educationdynamics.com/api/lead/save . The posting service can be called using simple HTTP POST, and will return an JSON-formatted response indicating the success or failure of the partner’s submission, along with details if applicable. The Request must include all the required key-value pairs defined by the API’s https://partners.educationdynamics.com/api/program/form method.

Prospect

MethodAPIDescription
POST api/prospect/save

Once a campaign has been created, the APIKey and Posting instructions can be provided to the Call Center partner. The partner will post prospect data into ISHP using the APIKey provided.

POST api/prospect/validate

Once a campaign has been created, the APIKey and Posting instructions can be provided to the Call Center partner. The partner will post a potential prospect data to ensure the it is valid before posting to save it using the APIKey provided.

Marketing

MethodAPIDescription
POST api/marketing/lead-save

The Host and Post service is located at https://partners.educationdynamics.com/api/Marketing/lead-save . The posting service can be called using simple HTTP POST, and will return an JSON-formatted response indicating the success or failure of the partner’s submission, along with details if applicable. The Request must include all the required key-value pairs defined by the API’s https://partners.educationdynamics.com/api/program/form method.

Institutions

MethodAPIDescription
POST api/institutions/lead-save

The Host and Post service is located at https://partners.educationdynamics.com/api/Institutions/lead-save . The posting service can be called using simple HTTP POST, and will return an JSON-formatted response indicating the success or failure of the partner’s submission, along with details if applicable. The Request must include all the required key-value pairs defined by the API’s https://partners.educationdynamics.com/api/program/form method.


Please check additional information.