JobTitle.md

Job Title Service

Table of Contents

---

• Request Information
• Sample Response
• Available Taxonomies
• Versioning

Request Information

HTTP method: GET or POST (form or JSON)

Parameters:

• taxonomy (required) : classification taxonomy to use; accepted values are listed here. A single title/description may be classified against multiple taxonomies in a single request by providing multiple taxonomies in this parameter, separated by the pipe ("|") character (see example query below).
• title (required if description is empty) : job title
• description (required if title is empty) : job description

Example: https://api.careerbuilder.com/core/classifier/jobtitle?title=Janitor&taxonomy=carotenev3_3_US|onet17

Sample Response

{
  "data": {
    "onet17": [
      {
        "title": "Janitors and Cleaners, Except Maids and Housekeeping Cleaners",
        "id": "37-2011.00",
        "confidence": 95.0
      },
      {
        "title": "First-Line Supervisors of Housekeeping and Janitorial Workers",
        "id": "37-1011.00",
        "confidence": 54.0
      }
    ],
    "carotenev3.3_us": [
      {
        "title": "Janitor",
        "id": "37.1",
        "confidence": 1.0,
        "minor_title": "Building Cleaning and Pest Control Workers",
        "minor_id": "2000"
      },
      {
        "title": "Assistant Landscaper",
        "id": "37.1083",
        "confidence": 0.0,
        "minor_title": "Supervisors of Building and Grounds Cleaning and Maintenance Workers",
        "minor_id": "1000"
      },
      {
        "title": "Head Cleaner",
        "id": "37.1122",
        "confidence": 0.0,
        "minor_title": "Building Cleaning and Pest Control Workers",
        "minor_id": "2000"
      }
    ]
  }
}

Taxonomies

Possible taxonomies (with links to full taxonomy results)

Taxonomy	description
onet17	Updated ONets
carotenev3	Changes from Carotene v2.2 include 7 removals, 139 updates, and 1,386 new titles. CaroteneV2_2ToV3CrossWalk.md Carotenev2.2 to v3 Crosswalk.xlsx
carotenev3.1	Changes from Carotene v3 include 4 additions, 78 updates, and 28 removals. Adds disambiguation to v3 and includes minor_title and minor_id fields for hierarchical classification. Carotenev3 to v3.1 Crosswalk.xlsx
carotenev3.3_us	Carotene taxonomy based on a deep-learning approach (v3.1 is hierarchal) for improved prediction of SOC major. This taxonomy was trained with U.S.-specific data.
carotenev3.3_uk	Same as carotenev3.3_us, but trained with data specific to U.K.

Complete taxonomy lists can be found here (restricted to CBReadOnly).

Versioning

---

JobTitle versions the API contract and taxonomies separately. The API version controls the format of the API call and response. The taxonomy version controls what data is returned for the call. The current API version is 1.0.

Both the Carotene and ONet taxonomies are strongly and immutably versioned. For both systems, the underlying classifiers may occasionally be updated without a version change. This may slightly change the classification results for some inputs, but will not affect the underlying taxonomy data.

Our general versioning strategy is available here.

Job Title Batch Service

Table of Contents

---

• Request Information
• Sample Response
• Available Taxonomies

Batch Request Information

HTTP method: POST (JSON)

{
    "requests": [
        {"title": "Management Analysts", "description": ""},
        {"title":"Computer Systems Engineers","description":""}
    ],
    "taxonomy":"ONET17|CAROTENEV3_3_US"
}

Parameters:

• taxonomy (required) : classification taxonomy to use; accepted values are here. A single/multiple title/description may be classified against multiple taxonomies in a single request by providing multiple taxonomies in this parameter, separated by the pipe ("|") character (see example query below).
• requests (required) a list of job titles or descriptions. Maximum of 100 titles/descriptions.
  • title (required if description is empty) : job title
  • description (required if title is empty) : job description

Example: https://api.careerbuilder.com/core/classifier/jobtitle-batch

Batch Sample Response

{
    "data": {
        "classifications": [
            {
                "onet17": [
                    {
                        "title": "Management Analysts",
                        "id": "13-1111.00",
                        "confidence": 90.0
                    },
                    {
                        "title": "Computer Systems Analysts",
                        "id": "15-1121.00",
                        "confidence": 54.0
                    }
                ],
                "carotenev3.3_us": [
                    {
                        "title": "Requirements Management Analyst",
                        "id": "15.272",
                        "confidence": 0.44,
                        "minor_title": "Computer Occupations",
                        "minor_id": "1100"
                    }
                ]
            },
            {
                "onet17": [
                    {
                        "title": "Software Developers, Systems Software",
                        "id": "15-1133.00",
                        "confidence": 93.0
                    }
                ],
                "carotenev3.3_us": [
                    {
                        "title": "Computer Systems Specialist",
                        "id": "15.144",
                        "confidence": 0.95,
                        "minor_title": "Computer Occupations",
                        "minor_id": "1100"
                    }
                ]
            }
        ]
    }
}

Batch Taxonomies

Possible taxonomies (with links to full taxonomy results)

Taxonomy	description
onet17	Updated ONets
carotenev3.3_us	Carotene taxonomy based on a deep-learning approach (v3.1 is hierarchal) for improved prediction of SOC major. This taxonomy was trained with U.S.-specific data.
carotenev3.3_uk	Same as carotenev3.3_us, but trained with data specific to U.K.