POST api/listings/getlistings
This method returns a list of all programs/institutions 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. They can be Leads or Clicks clients.
Request Information
URI Parameters
None.
Body Parameters
Name | Description | Type |
---|---|---|
TrackId |
Required | Campaign Token - provided by account manager. |
globally unique identifier |
UserIp |
Required* | User browser IPv4 address. * Either userIp or zipCode must be present in the request. |
string |
SiteUrl |
Required | Website where listings are being rendered including querystring, if available. |
string |
ZipCode |
Required* | 5-digit US zip code / 7-character Canadian postal code. * Either userIp or zipCode must be present in the request. |
string |
UserAgent |
Required | Client browser User-Agent. |
string |
PlacementToken |
Required | Placement Token - provided by account manager. |
globally unique identifier |
Age |
Age. |
integer |
SubId |
Any sub-identifying code you wish to mark your lead/click with. Must not contains ?, % or &. |
string |
TestMode |
Test or live request default "no" if not passed. |
boolean |
GradYear |
4 digit year of highest education completed, i.e. 2001. |
string |
Military |
Military code Id. Check provided document at the bottom of this page. |
string |
UrlReferer |
Client URL referer. |
string |
Categories |
Category ID comma separated values. Check provided document at the bottom of this page. |
string |
Specialties |
Specialty ID comma separated values. Check provided document at the bottom of this page. |
string |
Subcategories |
Sub category ID comma separated values. Check provided document at the bottom of this page. |
string |
EducationLevel |
Check provided document at the bottom of this page. |
string |
DesireDegreeLevel |
Desired degree level ID comma separated values. Check provided document at the bottom of this page. |
string |
CampusPreference |
Check provided document at the bottom of this page. |
string |
DesiredStartDate |
Check provided document at the bottom of this page. |
string |
SubSource |
Kindly pass web source name. If incoming traffic is initiated from google.com search engine, you can pass "google". Similarly other example values are "yahoo", "bing", "ask", etc. Required for CEC. |
string |
LeadInitiatingUrl |
Initial Landing Url: Full URL that shows the 'creative' the user saw at the start of the funnel. Required for CEC. |
string |
GeotargetState |
US two-digit state code, e.g. "NJ". |
string |
Request Format
Conten-Type: application/json
{ "trackId": "3d938d30-2724-4cb6-84b4-8ef60a0ab923", "userIp": "190.120.10.1", "siteUrl": "http://www.educationconnection.com/", "zipCode": "30805", "userAgent": "user-agent", "placementToken": "db88f4fb-6447-40f5-b27f-78fd1fe6a038", "age": "30", "subid": "sub-id", "testMode": "false", "gradYear": "2000", "military": "126", "urlReferer": "null", "categories": "21,25", "specialties": null, "subcategories": null, "educationLevel": "9", "desireDegreeLevel": null, "campusPreference": "null", "desiredStartDate": "Immediately" }
Response Information
Output
{ "Error": "0", "Status": "Success", "Institutions": [ { "Position": 1, "Description": "Institution Description", "InstitutionName": "Institution Name", "LogoLargeImage": "//abc123.cloudfront.net/e/i/123/V8l1qUVJ8gcp7Xgc4eFGAoKc24j.png", "LogoSmallImage": "//abc123.cloudfront.net/e/i/123/lMmKbo5UvgijQ7bZHLuXUAHU9Ge.png", "LogoMediumImage": "//abc123.cloudfront.net/e/i/123/lMmKbo5UvgijQ7bZHLuXUAHU9Ge.png", "IsLeadUrl": false, "CampusType": "Ground", "CampusName": "Campus Name", "Address": { "Street1": "1234 Example St", "Street2": "", "City": "City Name", "PostalCode": "12345", "State": "NC", "Country": "US" }, "ClickThroughUrl": "https://agrservice.educationdynamics.com/api/click/ProcessClick?clickId=eyJQb...GFjZW", "Programs": [ { "Id": 196528, "Name": "Criminal Justice - Associate of Applied Science" }, { "Id": 196522, "Name": "Medical Clinical Assistant - Diploma" }, { "Id": 301113, "Name": "Mechatronics - Diploma" }, { "Id": 296479, "Name": "Medical Billing and Coding - Certificate" } ], "Comission": 0, "CommissionType": "Click" } ], "Message": null, "TransactionId": "84efdfe4-e5c9-4b5a-8dc9-7f9b3a410d01" }