Banner: Web API: Get license details by ID

Web API: Get license details by ID

Get license details by ID

The 'Get License Details by ID' API' enables developers to query and retrieve occupational license details based on a license ID. It works in conjunction with a complementary service which provides a list of Licenses and IDs.

About this data

License information is collected from each state by the Analyst Resource Center (ARC). States are expected to submit revisions every two years, and new information is updated on CareerOneStop every 4-6 months as new information is received. Information includes license titles, authorizing organizations, descriptions of licenses, and O*NET codes. Please note that not all states submit license information and there is no way to guarantee that each state collects all of the license information for their state. You can see License data on the CareerOneStop License Finder. For more information, visit License Finder Help.

Resource URL

https://api.careeronestop.org/v1/license/{userId}/{licenseId}

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/license/{userId}/{licenseId}"

            };

           

            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/license/{userId}/{licenseId}")

        .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
licenseId String
Yes
This value is the unique ID for the license. It can be obtained from the licenses search API (List Licenses).

Response Structure

{
  "LicenseList": null,
  "LicenseDetail": {
    "ID": "49-180533022",
    "Title": "DRIVER - SCHOOL BUS",
    "Description": "Bus drivers transport passengers over specified routes, to local or distant points, according to time schedule, assist's passengers with baggage and collects tickets or cash fares, regulates heating, lighting, and ventilating systems for passenger comfort. They comply with local traffic regulations, report delays or accidents. Record cash receipts, and ticket fare. Bus drivers make repairs and change tires. Inspect the bus, check the gas, oil, and water before departure, load or unload baggage or express checked by passengers. Transport pupils between pickup points and school.",
    "State": "Utah",
    "ActiveStatusDesc": "Active",
    "ContinuingEDUIndDesc": "No continuing education requirement",
    "CriminalIndDesc": "No criminal record requirements",
    "EducationIndDesc": "No education required",
    "LicExamIndDesc": "State exam required",
    "ExperienceIndDesc": "Experience",
    "LicTypeIndDesc": "Stand-alone license",
    "VeteransIndDesc": "Military and spouses are exempt from licensure requirements",
    "LastUpdated": "11/04/2019",
    "LicenseAgency": {
      "Name": "Utah Department of Public Saftey~Drivers License Division~DLD",
      "Address": "4501 South 2700 West, PO Box 144501",
      "City": "Salt Lake City",
      "State": "UT",
      "Zip": "84114-4501",
      "Phone": "8019654437",
      "Email": "http://dld.utah.gov/contact/",
      "Url": "http://dld.utah.gov/"
    }
  },
  "RecordCount": 1,
  "DidYouMean": null,
  "AutoCorrection": null,
  "QueriedOn": null
}
<LicenseFinder
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">
<AutoCorrection i:nil="true"/>
<DidYouMean i:nil="true"/>
<LicenseDetail>
<ActiveStatusDesc>Active</ActiveStatusDesc>
<CertificationIndDesc i:nil="true"/>
<ContinuingEDUIndDesc>No continuing education requirement</ContinuingEDUIndDesc>
<CriminalIndDesc>No criminal record requirements</CriminalIndDesc>
<Description>Bus drivers transport passengers over specified routes, to local or distant points, according to time schedule, assist's passengers with baggage and collects tickets or cash fares, regulates heating, lighting, and ventilating systems for passenger comfort. They comply with local traffic regulations, report delays or accidents. Record cash receipts, and ticket fare. Bus drivers make repairs and change tires. Inspect the bus, check the gas, oil, and water before departure, load or unload baggage or express checked by passengers. Transport pupils between pickup points and school.</Description>
<EducationIndDesc>No education required</EducationIndDesc>
<ExperienceIndDesc>Experience</ExperienceIndDesc>
<ID>49-180533022</ID>
<LastUpdated>11/04/2019</LastUpdated>
<LicExamIndDesc>State exam required</LicExamIndDesc>
<LicTypeIndDesc>Stand-alone license</LicTypeIndDesc>
<LicenseAgency>
<Address>4501 South 2700 West, PO Box 144501</Address>
<City>Salt Lake City</City>
<Email>http://dld.utah.gov/contact/</Email>
<Name>Utah Department of Public Saftey~Drivers License Division~DLD</Name>
<Phone>8019654437</Phone>
<State>UT</State>
<Url>http://dld.utah.gov/</Url>
<Zip>84114-4501</Zip>
</LicenseAgency>
<PhysicalReqIndDesc i:nil="true"/>
<State>Utah</State>
<Title>DRIVER - SCHOOL BUS</Title>
<VeteransIndDesc>Military and spouses are exempt from licensure requirements</VeteransIndDesc>
</LicenseDetail>
<LicenseList i:nil="true"/>
<QueriedOn i:nil="true"/>
<RecordCount>1</RecordCount>
</LicenseFinder>

Response Parameters

Name
Description
Type
Parent
LicenseList
This object is not populated by this Web API.
List of Objects
root
LicenseDetail
License Detail
List of Objects
root
ID
ID
String
LicenseDetail
Title
Title
String
LicenseDetail
Description
Description
String
LicenseDetail
State
State
String
LicenseDetail
ActiveStatusDesc
Active status indicator values:
 · Active
 · No new licenses
 · Replaced
 · No longer licensed
String
LicenseDetail
CertificationIndDesc Certification indicator values:
 · No mention of certification
 · Certification may substitute for license requirements
 · Certification required
 · Undetermined
String LicenseDetail
ContinuingEDUIndDesc Continuing education indicator values:
 · No continuing education requirement
 · Continuing education required
 · Undetermined
String LicenseDetail
CriminalIndDesc Criminal record indicator values:
 · No criminal record prohibitions
 · Specific type of conviction prohibited
 · Felony convictions prohibited
 · Any conviction is prohibited
 · Background check required
 · Undetermined
String LicenseDetail
EducationIndDesc Education indicator values:
 · No educational requirements
 · Specific course required
 · Degree required
 · Undetermined
String LicenseDetail
LicExamIndDesc License exam indicator values:
 · No exam
 · State exam required
 · Third-party exam required
 · Both state and third-party exam required
 · Choice of state or third-party exam
 · Undetermined
String LicenseDetail
ExperienceIndDesc Experience indicator values:
 · No experience
 · Affidavit or referral
 · Experience
 · Current employment
 · Undetermined
String LicenseDetail
PhysicalReqIndDesc Physical requirement indicator values:
 · No physical requirements
 · Vision test required
 · Physical exam required
 · More significant physical requirements
 · Undetermined
String LicenseDetail
LicTypeIndDesc License type indicator values:
 · Stand-alone license
 · Registry
 · Tied to business
 · Secondary license (another license is a prerequisite)
 · Preliminary/temporary license
String LicenseDetail
VeteransIndDesc License type indicator values
 · No known distinction for military or spouses
 · A temporary license available to military and spouses until formal license approval 
 · Advisors or additional guidance is available for military and spouses
 · Licensure by endorsement is available for military and spouses
 · Expedited processing is available for military and spouse
 · Expedited processing is available for military and spouses, and a separate licensure by endorsement process occur
 · Expedited processing is available for military and spouses, and no background check is required
 · Expedited processing is available for military and spouses, with a temporary license available in the interim
 · Fees are reduced for military and spouses
 · Fees are reduced and a temporary license available in the interim
 · Fees are reduced and expedited processing is available for military and spouses
 · Fees are reduced and expedited processing is available for military and spouses, with a temporary license available in the interim
 · Military and spouses are exempt from licensure requirements
 · Unknown
String LicenseDetail
LastUpdated Last Updated mm/dd/yyyy String LicenseDetail
LicenseAgency
License Agency
Object
LicenseDetail
Name
Name
String
LicenseAgency
Address
Address
String
LicenseAgency
City
City
String
LicenseAgency
State
State
String
LicenseAgency
Zip
Zip
String
LicenseAgency
Phone
Phone
String
LicenseAgency
Email
Email
String
LicenseAgency
Url
URL
String
LicenseAgency
RecordCount
Record Count
Number
root
DidYouMean
This object is not populated by this Web API.
String
root
AutoCorrection
This object is not populated by this Web API.
String
root
QueriedOn
This object is not populated by this Web API.
Object
root

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.