Skip to Content

List Licenses

GET
/v1/license/{userId}/{keyword}/{location}/{sortColumns}/{sortDirections}/{startRecord}/{limitRecord}
Parameters
string


api token is required field
string


userId is required field
string

ex: nurse or 29-1171.00 (O*NET code). 0 = no input

keyword is required field
string

state (IL) or US or 0 for all states

location is required field
string

ex : Title or Agency or State
Default value is 0 for relevance

sortColumns is required field
string

ex : ASC or DESC
Default value is 0 for relevance

sortDirections is required field
integer

ex : 0

startRecord is required field
integer

ex : 10

limitRecord is required field

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}/{keyword}/{location}/{sortColumns}/{sortDirections}/{startRecord}/{limitRecord}"
            };
            
            using (var http = new HttpClient())
            {
                http.DefaultRequestHeaders.Accept.Clear();
                http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "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}/{keyword}/{location}/{sortColumns}/{sortDirections}/{startRecord}/{limitRecord}")
		.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 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();
	}
   }
}


Response Structure
                        {
  "LicenseList": [
    {
      "ID": "string",
      "Title": "string",
      "Description": "string",
      "State": "string",
      "ActiveStatusDesc": "string",
      "CertificationIndDesc": "string",
      "ContinuingEDUIndDesc": "string",
      "CriminalIndDesc": "string",
      "EducationIndDesc": "string",
      "LicExamIndDesc": "string",
      "ExperienceIndDesc": "string",
      "PhysicalReqIndDesc": "string",
      "LicTypeIndDesc": "string",
      "VeteransIndDesc": "string",
      "LastUpdated": "string",
      "LicenseAgency": {
        "Name": "string",
        "Address": "string",
        "City": "string",
        "State": "string",
        "Zip": "string",
        "Phone": "string",
        "Email": "string",
        "Url": "string"
      }
    }
  ],
  "LicenseDetail": {
    "ID": "string",
    "Title": "string",
    "Description": "string",
    "State": "string",
    "ActiveStatusDesc": "string",
    "CertificationIndDesc": "string",
    "ContinuingEDUIndDesc": "string",
    "CriminalIndDesc": "string",
    "EducationIndDesc": "string",
    "LicExamIndDesc": "string",
    "ExperienceIndDesc": "string",
    "PhysicalReqIndDesc": "string",
    "LicTypeIndDesc": "string",
    "VeteransIndDesc": "string",
    "LastUpdated": "string",
    "LicenseAgency": {
      "Name": "string",
      "Address": "string",
      "City": "string",
      "State": "string",
      "Zip": "string",
      "Phone": "string",
      "Email": "string",
      "Url": "string"
    }
  },
  "RecordCount": 1,
  "DidYouMean": "string",
  "AutoCorrection": "string",
  "QueriedOn": {
    "Code": "string",
    "Title": "string",
    "Type": "string",
    "IsKeywordSearch": true
  }
}
                    
                        <LicenseFinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">
  <AutoCorrection>string</AutoCorrection>
  <DidYouMean>string</DidYouMean>
  <LicenseDetail>
    <ActiveStatusDesc>string</ActiveStatusDesc>
    <CertificationIndDesc>string</CertificationIndDesc>
    <ContinuingEDUIndDesc>string</ContinuingEDUIndDesc>
    <CriminalIndDesc>string</CriminalIndDesc>
    <Description>string</Description>
    <EducationIndDesc>string</EducationIndDesc>
    <ExperienceIndDesc>string</ExperienceIndDesc>
    <ID>string</ID>
    <LastUpdated>string</LastUpdated>
    <LicExamIndDesc>string</LicExamIndDesc>
    <LicTypeIndDesc>string</LicTypeIndDesc>
    <LicenseAgency>
      <Address>string</Address>
      <City>string</City>
      <Email>string</Email>
      <Name>string</Name>
      <Phone>string</Phone>
      <State>string</State>
      <Url>string</Url>
      <Zip>string</Zip>
    </LicenseAgency>
    <PhysicalReqIndDesc>string</PhysicalReqIndDesc>
    <State>string</State>
    <Title>string</Title>
    <VeteransIndDesc>string</VeteransIndDesc>
  </LicenseDetail>
  <LicenseList>
    <LicenseFinderDetail>
      <ActiveStatusDesc>string</ActiveStatusDesc>
      <CertificationIndDesc>string</CertificationIndDesc>
      <ContinuingEDUIndDesc>string</ContinuingEDUIndDesc>
      <CriminalIndDesc>string</CriminalIndDesc>
      <Description>string</Description>
      <EducationIndDesc>string</EducationIndDesc>
      <ExperienceIndDesc>string</ExperienceIndDesc>
      <ID>string</ID>
      <LastUpdated>string</LastUpdated>
      <LicExamIndDesc>string</LicExamIndDesc>
      <LicTypeIndDesc>string</LicTypeIndDesc>
      <LicenseAgency>
        <Address>string</Address>
        <City>string</City>
        <Email>string</Email>
        <Name>string</Name>
        <Phone>string</Phone>
        <State>string</State>
        <Url>string</Url>
        <Zip>string</Zip>
      </LicenseAgency>
      <PhysicalReqIndDesc>string</PhysicalReqIndDesc>
      <State>string</State>
      <Title>string</Title>
      <VeteransIndDesc>string</VeteransIndDesc>
    </LicenseFinderDetail>
  </LicenseList>
  <QueriedOn>
    <Code>string</Code>
    <IsKeywordSearch>true</IsKeywordSearch>
    <Title>string</Title>
    <Type>string</Type>
  </QueriedOn>
  <RecordCount>1</RecordCount>
</LicenseFinder>