Get skills gaps between two occupations

Get skills gaps between two occupations

Get skills gaps between two occupations

The 'Get Skill Gaps between two Occupations' API enables developers to query and retrieve a list of O*NET skill and knowledge gaps and general occupation comparison between two occupations.

About this data

This Web API provides the gap information between two O*NET Occupations. Gap information includes wage, skills, knowledge, abilities, training, certifications and license gaps between the two given occupations. The Occupation wage information is provided by the Occupational Employment Statistics program in the Department of Labor's Bureau of Labor Statistics. Skills, Knowledge, and Abilities information is provided by O*NET. License information is provided by the National Crosswalk Service Center, and Certification information is collected and maintained by a DOL grantee. This information can be found in the mySkillsmyFuture tool. Data for this resource can be found here.

Resource URL

https://api.careeronestop.org/v1/skillgap/{userId}/{onetCodeSource}/{onetCodeTarget}/{location}/{radius}

Example Code

using System;

using System.Net.Http;

using System.Net.Http.Headers;

using System.Threading.Tasks;

namespace CareerOneStopAPISample

{

    class Program

    {

        static void Main(string[] args)

        {

            CreateRequest().Wait();

        }

        private static async Task CreateRequest()

        {

   

            var uri = new UriBuilder(Uri.UriSchemeHttps, "api.careeronestop.org")

            {

                Path = "/v1/skillgap/{userId}/{onetCodeSource}/{onetCodeTarget}/{location}/{radius}"

            };

           

            using (var http = new HttpClient())

            {

                http.DefaultRequestHeaders.Accept.Clear();

                http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "Your API Token");

                http.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                var response = await http.GetAsync(uri.Uri).ConfigureAwait(false);

                if (response.IsSuccessStatusCode)

                {

                    var result = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

                }

            }

        }

    }

}
import java.io.IOException;

import java.net.URI;

import java.net.URISyntaxException;

import org.apache.http.HttpEntity;

import org.apache.http.client.methods.CloseableHttpResponse;

import org.apache.http.client.methods.HttpGet;

import org.apache.http.client.utils.URIBuilder;

import org.apache.http.impl.client.CloseableHttpClient;

import org.apache.http.impl.client.HttpClients;

import org.apache.http.util.EntityUtils;

public class CareerOneStopAPISample {

    public static void main(String[] args) throws IOException, URISyntaxException {

    URI uri = new URIBuilder()

        .setScheme("https")

        .setHost("api.careeronestop.org")

        .setPath("/v1/skillgap/{userId}/{onetCodeSource}/{onetCodeTarget}/{location}/{radius}")

        .build();

    CloseableHttpResponse response = null;

    HttpGet httpGet = null;

    try {

        CloseableHttpClient httpClient = HttpClients.createDefault();

        httpGet = new HttpGet(uri);

        httpGet.setHeader("Content-Type","application/json");

        httpGet.setHeader("Authorization", "Bearer Your API Token");

        response = httpClient.execute(httpGet);

        HttpEntity entity = response.getEntity();

        System.out.println(EntityUtils.toString(entity));

    } finally {

        if(httpGet != null) httpGet.releaseConnection();

        if(response != null) response.close();

    }

   }

}

Request Parameters

Refer to the following table for a list of the required and optional request parameters. All parameter names and values are case sensitive. Important: You must provide all required parameters. Submitting an empty request does not return all possible results; an empty request returns an error.

Parameter Name Value Required? Description
API Token
String
Yes
This value is the unique API Token provided during the CareerOneStop Web API registration process.
userId
String
Yes This value is the unique UserID provided during the CareerOneStop Web API registration process.
onetCodeSource String
Yes This value is the source ONET code.
onetCodeTarget String Yes This value is the Target ONET Code.
location String Yes This value accepts a city, state (Chicago, IL) or state (IL) or ZIP code (61299). For invalid location it gets national data.
radius
String Yes This value accepts a radius size in miles around a specified location.

Response Structure

{

  "OccupationSkillsGapList": [],

  "OccupationSkillsMatchList": [

    {

      "Title": "Monitoring",

      "Description": "Keeping track of how well people and/or groups are doing in order to make improvements.",

      "SkillId": "2.A.2.d"

    },

    {

      "Title": "Sales and Marketing",

      "Description": "Knowledge of principles and methods for showing, promoting, and selling products or services. This includes marketing strategy and tactics, product demonstration, sales techniques, and sales control systems.",

      "SkillId": "2.C.1.d"

    },

    {

      "Title": "Reading Comprehension",

      "Description": "Reading work-related information.",

      "SkillId": "2.A.1.a"

    },

    {

      "Title": "Economics and Accounting",

      "Description": "Knowledge of economic and accounting principles and practices, the financial markets, banking and the analysis and reporting of financial data.",

      "SkillId": "2.C.1.c"

    },

    {

      "Title": "Negotiation",

      "Description": "Bringing people together to solve differences.",

      "SkillId": "2.B.1.d"

    },

    {

      "Title": "Judgment and Decision Making",

      "Description": "Thinking about the pros and cons of different options and picking the best one.",

      "SkillId": "2.B.4.e"

    },

    {

      "Title": "Critical Thinking",

      "Description": "Thinking about the pros and cons of different ways to solve a problem.",

      "SkillId": "2.A.2.a"

    },

    {

      "Title": "Mathematics",

      "Description": "Using math to solve problems.",

      "SkillId": "2.A.1.e"

    },

    {

      "Title": "Active Listening",

      "Description": "Listening to others, not interrupting, and asking good questions.",

      "SkillId": "2.A.1.b"

    },

    {

      "Title": "Persuasion",

      "Description": "Talking people into changing their minds or their behavior.",

      "SkillId": "2.B.1.c"

    },

    {

      "Title": "English Language",

      "Description": "Knowledge of the structure and content of the English language including the meaning and spelling of words, rules of composition, and grammar.",

      "SkillId": "2.C.7.a"

    },

    {

      "Title": "Systems Analysis",

      "Description": "Figuring out how a system should work and how changes in the future will affect it.",

      "SkillId": "2.B.4.g"

    },

    {

      "Title": "Active Learning",

      "Description": "Figuring out how to use new ideas or things.",

      "SkillId": "2.A.2.b"

    },

    {

      "Title": "Speaking",

      "Description": "Talking to others.",

      "SkillId": "2.A.1.d"

    },

    {

      "Title": "Writing",

      "Description": "Writing things for co-workers or customers.",

      "SkillId": "2.A.1.c"

    },

    {

      "Title": "Computers and Electronics",

      "Description": "Knowledge of circuit boards, processors, chips, electronic equipment, and computer hardware and software, including applications and programming.",

      "SkillId": "2.C.3.a"

    },

    {

      "Title": "Coordination",

      "Description": "Changing what is done based on other people's actions.",

      "SkillId": "2.B.1.b"

    },

    {

      "Title": "Systems Evaluation",

      "Description": "Measuring how well a system is working and how to improve it.",

      "SkillId": "2.B.4.h"

    },

    {

      "Title": "Customer and Personal Service",

      "Description": "Knowledge of principles and processes for providing customer and personal services. This includes customer needs assessment, meeting quality standards for services, and evaluation of customer satisfaction.",

      "SkillId": "2.C.1.e"

    },

    {

      "Title": "Mathematics",

      "Description": "Knowledge of arithmetic, algebra, geometry, calculus, statistics, and their applications.",

      "SkillId": "2.C.4.a"

    },

    {

      "Title": "Administration and Management",

      "Description": "Knowledge of business and management principles involved in strategic planning, resource allocation, human resources modeling, leadership technique, production methods, and coordination of people and resources.",

      "SkillId": "2.C.1.a"

    },

    {

      "Title": "Clerical",

      "Description": "Knowledge of administrative and clerical procedures and systems such as word processing, managing files and records, stenography and transcription, designing forms, and other office procedures and terminology.",

      "SkillId": "2.C.1.b"

    }

  ],

  "CurrentOccupationTitle": "Securities and Commodities Traders",

  "TargetOccupationTitle": "Energy Brokers",

  "CurrentOccupationCode": "41303103",

  "TargetOccupationCode": "41309901",

  "CurrentOccupationWage": "$75,300",

  "TargetOccupationWage": "$59,800",

  "CurrentEducationTitle": "Bachelor's degree",

  "TargetEducationTitle": "High school diploma or equivalent",

  "CurrentExperienceTitle": "None",

  "TargetExperienceTitle": "None",

  "CurrentTrainingTitle": "Moderate-term on-the-job training",

  "TargetTrainingTitle": "Moderate-term on-the-job training",

  "CurrentLicenses": 0,

  "TargetLicenses": 0,

  "CurrentCertificates": 1,

  "TargetCertificates": 3,

  "LocationState": "VA"

}
<OccupationSkillGapDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">

  <CurrentCertificates>1</CurrentCertificates>

  <CurrentEducationTitle>Bachelor's degree</CurrentEducationTitle>

  <CurrentExperienceTitle>None</CurrentExperienceTitle>

  <CurrentLicenses>0</CurrentLicenses>

  <CurrentOccupationCode>41303103</CurrentOccupationCode>

  <CurrentOccupationTitle>Securities and Commodities Traders</CurrentOccupationTitle>

  <CurrentOccupationWage>$75,300</CurrentOccupationWage>

  <CurrentTrainingTitle>Moderate-term on-the-job training</CurrentTrainingTitle>

  <LocationState>VA</LocationState>

  <OccupationSkillsGapList/>

  <OccupationSkillsMatchList>

    <OccupationSkill>

      <Description>Keeping track of how well people and/or groups are doing in order to make improvements.</Description>

      <SkillId>2.A.2.d</SkillId>

      <Title>Monitoring</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of principles and methods for showing, promoting, and selling products or services. This includes marketing strategy and tactics, product demonstration, sales techniques, and sales control systems.</Description>

      <SkillId>2.C.1.d</SkillId>

      <Title>Sales and Marketing</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Reading work-related information.</Description>

      <SkillId>2.A.1.a</SkillId>

      <Title>Reading Comprehension</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of economic and accounting principles and practices, the financial markets, banking and the analysis and reporting of financial data.</Description>

      <SkillId>2.C.1.c</SkillId>

      <Title>Economics and Accounting</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Bringing people together to solve differences.</Description>

      <SkillId>2.B.1.d</SkillId>

      <Title>Negotiation</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Thinking about the pros and cons of different options and picking the best one.</Description>

      <SkillId>2.B.4.e</SkillId>

      <Title>Judgment and Decision Making</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Thinking about the pros and cons of different ways to solve a problem.</Description>

      <SkillId>2.A.2.a</SkillId>

      <Title>Critical Thinking</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Using math to solve problems.</Description>

      <SkillId>2.A.1.e</SkillId>

      <Title>Mathematics</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Listening to others, not interrupting, and asking good questions.</Description>

      <SkillId>2.A.1.b</SkillId>

      <Title>Active Listening</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Talking people into changing their minds or their behavior.</Description>

      <SkillId>2.B.1.c</SkillId>

      <Title>Persuasion</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of the structure and content of the English language including the meaning and spelling of words, rules of composition, and grammar.</Description>

      <SkillId>2.C.7.a</SkillId>

      <Title>English Language</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Figuring out how a system should work and how changes in the future will affect it.</Description>

      <SkillId>2.B.4.g</SkillId>

      <Title>Systems Analysis</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Figuring out how to use new ideas or things.</Description>

      <SkillId>2.A.2.b</SkillId>

      <Title>Active Learning</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Talking to others.</Description>

      <SkillId>2.A.1.d</SkillId>

      <Title>Speaking</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Writing things for co-workers or customers.</Description>

      <SkillId>2.A.1.c</SkillId>

      <Title>Writing</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of circuit boards, processors, chips, electronic equipment, and computer hardware and software, including applications and programming.</Description>

      <SkillId>2.C.3.a</SkillId>

      <Title>Computers and Electronics</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Changing what is done based on other people's actions.</Description>

      <SkillId>2.B.1.b</SkillId>

      <Title>Coordination</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Measuring how well a system is working and how to improve it.</Description>

      <SkillId>2.B.4.h</SkillId>

      <Title>Systems Evaluation</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of principles and processes for providing customer and personal services. This includes customer needs assessment, meeting quality standards for services, and evaluation of customer satisfaction.</Description>

      <SkillId>2.C.1.e</SkillId>

      <Title>Customer and Personal Service</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of arithmetic, algebra, geometry, calculus, statistics, and their applications.</Description>

      <SkillId>2.C.4.a</SkillId>

      <Title>Mathematics</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of business and management principles involved in strategic planning, resource allocation, human resources modeling, leadership technique, production methods, and coordination of people and resources.</Description>

      <SkillId>2.C.1.a</SkillId>

      <Title>Administration and Management</Title>

    </OccupationSkill>

    <OccupationSkill>

      <Description>Knowledge of administrative and clerical procedures and systems such as word processing, managing files and records, stenography and transcription, designing forms, and other office procedures and terminology.</Description>

      <SkillId>2.C.1.b</SkillId>

      <Title>Clerical</Title>

    </OccupationSkill>

  </OccupationSkillsMatchList>

  <TargetCertificates>3</TargetCertificates>

  <TargetEducationTitle>High school diploma or equivalent</TargetEducationTitle>

  <TargetExperienceTitle>None</TargetExperienceTitle>

  <TargetLicenses>0</TargetLicenses>

  <TargetOccupationCode>41309901</TargetOccupationCode>

  <TargetOccupationTitle>Energy Brokers</TargetOccupationTitle>

  <TargetOccupationWage>$59,800</TargetOccupationWage>

  <TargetTrainingTitle>Moderate-term on-the-job training</TargetTrainingTitle>

</OccupationSkillGapDetails>

Response Parameters

Name Description Type
OccupationSkillsGapList 
Occupation Skills Gap List
Object
    Title
Title
String
    Description
Description
String
    SkillId
Skill ID
String
    SkScoreCurrent
  Skill score for the current occupation
String
    SkScoreTarget
  Skill score for the target occupation
String
    SkillType
Skill Type
String
    AvailableTraining
  Y/N, is training available to address this gap?
String
OccupationSkillsMatchList
Occupation Skills Match List
Object
    Title
Title
String
    Description
Description
String
    SkillId
Skill ID
String
CurrentOccupationTitle
Current Occupation Title
String
TargetOccupationTitle
Target Occupation Title
String
CurrentOccupationCode
Current Occupation Code
String
TargetOccupationCode
Target Occupation Code
String
CurrentOccupationWage
Current Occupation Wage
String
TargetOccupationWage
Target Occupation Wage
String
CurrentEducationTitle
Current Education Title
String
TargetEducationTitle
Target Education Title
String
CurrentExperienceTitle
Current Experience Title
String
TargetExperienceTitle
Target Experience Title
String
CurrentTrainingTitle
Current Training Title
String
TargetTrainingTitle
Target Training Title
String
CurrentLicenses
Are there any licenses associated with the current O*NET code? Note this uses a different algorithm than CareerOneStop's License Finder or the List Licenses Web API. This one matches only on code. Number
TargetLicenses
Target Licenses
Number
CurrentCertificates
Are there any certifications associated with the current O*NET code? Note this uses a different algorithm than CareerOneStop's Certifications Finder or the List Certifications Web API.  
Number
TargetCertificates
Target Certificates
Number
LocationState
Location provided in the request
String

Errors

Error/Status Code Description
 200
OK / Success. The request went through successfully and there is a response body.
 400
Bad Request (Request was invalid or missing parameters)
 401    
Unauthorized. This error occurs specifically when authentication is required and has failed or has not yet been provided correctly. (ex: Invalid API Token)
 404
This error will be shown in two scenarios 1) Not found - (An error occurred) and 2) Not found - (No data available)
 500
Internal Server Error. This error will occur when there is something critically wrong in the API call.