SchoolNormalization.md

SchoolNormalizationService

Table of Contents

---

• Request Information
• Sample Response
• Versioning
• Supported Countries

#Request Information

HTTP method: GET or POST Parameters (query/form):

•    query (required) : The educational institution information to be queried.
  

•    country (optional) : 2 digit ISO country code of educational institution.
  

Example: https://api.careerbuilder.com/core/normalizedschools?query=georgia%20tech&country=us

#Sample Response

{
    "data": {
        "normalized_schools": [
            {
                "normalized_school_name": "Georgia Institute of Technology",
                "id": "53bff579e4b04710d09fa98d",
                "country": "US",
                "confidence": 2.0
            }
        ]
    }
}

#Response Information

The response returns a single data node which contains a list of normalized schools. These normalized schools are ordered by the confidence score. Each normalized shool has a normalized school name (string), a unique ID (string), a country (string), and a confidence (double). Confidence scores range from 0.0 to 2.0.

#Versioning

The response from the School Normalization Service is versioned with the current version being 1.0. The data set used to perform the normalization is unversioned.

Our general versioning strategy is available here.