School select

Overview

This is a RESTful Web Service that will allow you to receive ads from the Katch System in XML or JSON format. In order to interact with the endpoint an HTTP REST API client should be created using any preferred framework or language.

The request should be a POST request to an URL with the format:

XML

http://marketplaces.katch.com/search?md=1&zipcode=90210&areaofstudy=7&campaign=XXXX&maxresults=15&format=xml

 

JSON

http://marketplaces.katch.com/search?md=1&zipcode=90210&areaofstudy=7&campaign=XXXX&maxresults=15&format=json

 

Service URL

To use this service you need to do a HTTP REQUEST (POST type) to this URL:

http://marketplaces.katch.com/search

The request Body should contain a structure of data as follows:


{"areaofstudy":"String","campaign":"String","zipcode":"String","subareaofstudy":"String","degreelevel":"String","military":"String","modality":"String"}
//Sample with Values:
{"areaofstudy":"1","campaign":"1234","subareaofstudy":"2","zipcode":"33133", "degreelevel":"3", "military":"0", "modality":"3"}

Query String Parameters

Parameters indicated with a “++” are mandatory. This information belongs to the client who is searching in the service consumed and MUST be passed in the query string parameters of the Request:

  • md = this parameters stands for marketplace definition for Education is 1.
  • ++client_user_agent = The software agent for an HTTP request, for instance in a browser, will indicate version of the browser, platform (i.e., mobile), etc.
  • ++client_referrer = The HTTP header that identifies the address of the webpage.
  • ++client_ip = The IP address that accessed the website.
  • ++zipcode = Use this parameter to pass the location of the user making the query. This can only be the zip code in its 5 digit format.(g., “zipcode”: “90210”)
  • publisherid = This is your Publisher ID, and it will be assigned when you register on Katch’s Platform. Your Publisher ID is (PID)
  • ++campaign = campaigns are used to track separate implementations, placements or traffic sources. The campaign ID for this implementation is (CID)
  • modality = Determines physical availability of the field of study, it can be online, campus or both. When making the request it can be sent like this: modality”: 2 (this will call on Campus available options)
  • edulevel = Defines the highest education level the user currently has.
  • gradyear = Graduation year indicates the year on which the user graduated from high school. All years between current year (including current year +1) and 1980 (e.g., “gradyear”: “1980”, “gradyear”: “2013”, “gradyear”: “2015”)
  • ++ areaofstudy = Defines the area of study to be returned (e.g., “areaofstudy”: 3 will return Criminal Justice & Security).
  • subareaofstudy = Zooms in the response to a sub area of study (e.g., “areaofstudy”: 3, “subareaofstudy”: 20 will return Criminal Justice & Security à Homeland Security).
  • degreelevel = Defines the Degree level the user is interested in.
  • military = Indicates if the user is/has been enrolled in the military.
  • maxresults = Indicates the max number of results intended for the visitor to see.

Publisher Tracking Parameters

There are 5 available parameters for publisher tracking purposes (p1, p2, p3, p4, p5), these can be used to keep track of your traffic sources, unique visitor tracking, or any other value used to track publisher’s traffic. All data sent to these parameters, will be available in our platform reports.

Guidelines for the p1, p2, p3, p4, p5 parameters:

  • Length: 36 characters
  • Allowed characters: Letters, numbers, underscore and dash

Example of usage: (this is just an example)

  • “p1”: “paidtraffic”
  • “p2”: “21EC2020-3AEA-4069-A2DD-08002B30309D”
  • “p3”: “searchengine-123”
  • “p4”: “ty-page”
  • “p5”: “sidebar”

Example of query String with parameters and values

http://marketplaces.katch.com/search?zipcode=90210&campaign=6604&maxresults=15&md=1&client_user_agent=Mozilla/5.0+(Windows+NT+6.1;+WOW64;+Trident/7.0;+rv:11.0)+like+Gecko&client_referrer=yourdomain.com&client_ip=192.168.5.2&modality=2&edulevel=1&gradyear=1990&areaofstudy=3&subareaofstudy=20&degreelevel=1&military=2&p1=paidtraffic&p2=21EC2020-3AEA-4069-A2DD-08002B30309D&p3=searchengine-123&p4=ty-page&p5=sidebar&format=xml

Super Bids Parameters

areaofstudy

Defines the area of study to be returned (e.g., “areaofstudy”: 3 will return Criminal Justice & Security). See Table for Reference

subareaofstudy

Zooms in the response to a sub area of study (e.g., “areaofstudy”: 3, “subareaofstudy”: 20 will return Criminal Justice & Security → Homeland Security). See Table for Reference

AOS Id Area of Study SubAOS Id Sub Area of Study
Business 1 General Business
Business 2 Accounting
Business 3 Finance
1 Business 4 Business Administration
Business 5 Human Resources
Business 6 Management
Business 7 Marketing/Communications
Creative Arts & Design 8 General Creative Arts & Design
Creative Arts & Design 9 Animation
Creative Arts & Design 10 Computer Aided Design
Creative Arts & Design 11 Fashion & Interior Design
2 Creative Arts & Design 12 Film, Music & Audio
Creative Arts & Design 13 Graphic Design/Multimedia
Creative Arts & Design 14 Photography
Creative Arts & Design 15 Web Design & Development
Creative Arts & Design 16 Video Game Design
Criminal Justice & Security 17 General Criminal Justice
Criminal Justice & Security 18 Criminal Justice
3 Criminal Justice & Security 19 Forensics/Crime Scene
Criminal Justice & Security 20 Homeland Security
Criminal Justice & Security 21 Police & Law Enforcement
Criminal Justice & Security 67 General Legal
Criminal Justice & Security 68 Legal Studies
Criminal Justice & Security 69 Paralegal
Culinary 22 General Culinary
Culinary 23 Baking & Pastry
4 Culinary 24 Culinary Arts
Culinary 25 Hospitality Management
Education 26 General Education
Education 27 Education Leadership
5 Education 28 Child Care/Child Education
Education 29 K-12 Education
7 General 31 General
Health Care & Human Services 32 General Health Services
Health Care & Human Services 33 Health Care Administration
Health Care & Human Services 34 Health Information Systems & Technology
8 Health Care & Human Services 35 Medical Billing & Coding
Health Care & Human Services 36 Medical Transcription
Health Care & Human Services 37 Office/Administrative
Health Care & Human Services 38 Pharmacy
Health Care & Human Services 70 General Medical
Health Care & Human Services 71 Dental Assisting
Health Care & Human Services 72 Medical Assisting
Health Care & Human Services 73 Medical Technician
Health Care & Human Services 74 Patient Care & Therapy
IT & Computer Science 39 General IT & Computer Science
IT & Computer Science 40 Basic Computer Skills
9 IT & Computer Science 41 Computer Science
IT & Computer Science 42 Database Technology
IT & Computer Science 43 IT & Information Systems
IT & Computer Science 44 Network Administration
IT & Computer Science 45 Programming & Software
IT & Computer Science 46 Web Design & Development
IT & Computer Science 75 Engineering
IT & Computer Science 76 General Engineering
Nursing 55 General Nursing
12 Nursing 56 Licensed Nurse (LPN/LVN)
Nursing 57 Nursing (ASN, BSN, MSN)
Nursing 58 Registered Nurse (RN)
13 Psychology & Social Services 59 Psychology & Social Services
Psychology & Social Services 66 General Psychology & Counseling
Trade & Vocational 60 General Trade & Vocational
Trade & Vocational 61 Automotive
14 Trade & Vocational 62 Construction Management
Trade & Vocational 63 Electronics
Trade & Vocational 64 HVAC

modality

Determines physical availability of the field of study, it can be online, campus or both. When making the request it can be sent like this: “modality”: 2 (this will call on Campus available options). See Table for Reference

Value Meaning Example of parameter with value
1 Online “modality” : “1”
2 Campus “modality” : “2”
3 Both “modality” : “3”

edulevel

Defines the highest education level the user currently has. See Table for Reference

Value Meaning Example of parameter with value
1 Some High School “edulevel” : “1”
2 GED/High School “edulevel” : “2”
3 Associates “edulevel” : “3”
4 Bachelors “edulevel” : “4”
5 Masters “edulevel” : “5”
6 Doctorate “edulevel” : “6”

degreelevel

Defines the Degree level the user is interested in. See Table for Reference

Value Meaning Example of parameter with value
1 Certificate/Diploma “degreelevel” : “1”
2 Associates “degreelevel” : “2”
3 Bachelors “degreelevel” : “3”
4 Masters “degreelevel” : “4”
5 Doctorate “degreelevel” : “5”

military

Defines the Degree level the user is interested in. See Table for Reference

Value Meaning Example of parameter with value
1 Yes “military” : “1”
2 No “military” : “2”

No Index/ No follow Listings

We strongly recommend to not index the listings by any bot because it may be reflected in your overall traffic quality and penalizations on behalf of our advertisers may be applied, to avoid that add “no follow” to the rel attribute in every listing.

<a rel="nofollow" href="http://marketplaces.katch.com/click/135ef6b9-70d6-4bb8-8ac4-782154fa865b/31947/aHR0cDovL2FkLmRvdWJsZWNsaWNrLm5ldC9kZG0vY2xrLzI3NTU2MDEzNjsxMDI1NjczMDg7Yz9odHRwOi8vbGVhcm5pbmcuY2FwZWxsYS5lZHUvdW5pbG9uZzIvP3JldmtleT0yMDY2Mzkmc3ViYWZmaWxpZD17ZW5nYWdlbWVudGlkfQ..">Visit School Site</a>

For Support:

If you have any trouble setting this up, please contact us at implementations-support@katch.com.