Skip to Content

List training programs

GET
/v2/training/programs/{userId}/{keyword}/{location}/{radius}/{programLength}/{school}/{programName}/{programFormat}/{occupation}/{filterBySource}/{area}/{sortColumns}/{sortDirection}/{startRecord}/{limitRecord}
Parameters
string


api token is required field
string


userId is required field
string

ex: nurse or 29-1171.00(onetcode)
Default value is 0 for relevance

keyword is required field
string

ex: city, state(reston, va) or state (VA) or zipcode (20191)

location is required field
string

ex: 25

radius is required field
integer

ex: 0

startRecord is required field
integer

ex: 10

limitRecord is required field
string

ex: 0

string

ex: 0

string

ex: 0

string

ex: 0

string

ex: 0

string

ex: Y or N
Default value is 0 for relevance

string

ex: 0

string

ex: Program, Provider, DegreeCredential, Location
Default value is 0 for relevance

string

ex: ASC or DESC
Default value is 0 for relevance

boolean

ex: true or false

Example Code

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using System.Collections.Specialized;
using System.Linq;

namespace CareerOneStopAPISample
{
    class Program
    {
        static void Main(string[] args)
        {
            CreateRequest().Wait();
        }
        private static async Task CreateRequest()
        {
            var qs = new NameValueCollection();
            qs["enableMetaData"] = "value";                        
            
            var uri = new UriBuilder(Uri.UriSchemeHttps, "api.careeronestop.org")
            {
                Path = "/v2/training/programs/{userId}/{keyword}/{location}/{radius}/{programLength}/{school}/{programName}/{programFormat}/{occupation}/{filterBySource}/{area}/{sortColumns}/{sortDirection}/{startRecord}/{limitRecord}",
                Query = string.Join("&", qs.AllKeys.Select(key => key + "=" + Uri.EscapeUriString(qs[key])))
            };
            
            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("/v2/training/programs/{userId}/{keyword}/{location}/{radius}/{programLength}/{school}/{programName}/{programFormat}/{occupation}/{filterBySource}/{area}/{sortColumns}/{sortDirection}/{startRecord}/{limitRecord}")
                .setParameter("enableMetaData", "value")
		.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
                        {
  "SchoolPrograms": [
    {
      "DetailId": 1,
      "CipCode": "string",
      "CipTitle": "string",
      "EtaProgramName": "string",
      "Format": [
        "string"
      ],
      "AwLevelCode": 5,
      "AwardLevel": "string",
      "Credential": "string",
      "DataSource": "string",
      "NumberCompleted": [
        "string"
      ],
      "OccupationsList": [
        "string"
      ],
      "SchoolIDUnique": 9,
      "SchoolName": "string",
      "SchoolURL": "string",
      "Address": "string",
      "City": "string",
      "StateAbbr": "string",
      "State": "string",
      "Zip": "string",
      "Phone": "string",
      "Distance": "string",
      "Latitude": "string",
      "Longitude": "string"
    }
  ],
  "RecordCount": 1,
  "DidYouMean": [
    "string"
  ],
  "IsAutoCorrectionUsed": true,
  "ProgramLengthCountList": [
    {
      "Item": "string",
      "Count": 2,
      "Value": "string",
      "IsSelected": true
    }
  ],
  "SchoolCountList": [
    {
      "Item": "string",
      "Count": 2,
      "Value": "string",
      "IsSelected": true
    }
  ],
  "ProgramCountList": [
    {
      "Item": "string",
      "Count": 2,
      "Value": "string",
      "IsSelected": true
    }
  ],
  "FormatCountList": [
    {
      "Item": "string",
      "Count": 2,
      "Value": "string",
      "IsSelected": true
    }
  ],
  "OccupationCountList": [
    {
      "Item": "string",
      "Count": 2,
      "Value": "string",
      "IsSelected": true
    }
  ],
  "AreaCountList": [
    {
      "Item": "string",
      "Count": 2,
      "Value": "string",
      "IsSelected": true
    }
  ],
  "EtpCount": 3,
  "SearchedOn": {
    "KeywordEntered": "string",
    "IsCode": true,
    "FormattedCode": "string",
    "Title": "string",
    "Type": "string",
    "DataSetType": "string",
    "SchoolOrProgram": "string"
  },
  "Metadata": {
    "Publisher": "string",
    "Sponsor": "string",
    "LastAccessDate": "string",
    "CitationSuggested": "string",
    "DataSource": [
      {
        "DataName": "string",
        "DataSourceName": "string",
        "DataSourceUrl": "string",
        "DataLastUpdate": "string",
        "DataVintageOrVersion": "string",
        "DataDescription": "string",
        "DataSourceCitation": "string"
      }
    ]
  }
}
                    
                        <ProgramList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels.Training.Programs">
  <AreaCountList xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:ItemCount>
      <d2p1:Count>2</d2p1:Count>
      <d2p1:IsSelected>true</d2p1:IsSelected>
      <d2p1:Item>string</d2p1:Item>
      <d2p1:Value>string</d2p1:Value>
    </d2p1:ItemCount>
  </AreaCountList>
  <DidYouMean xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>string</d2p1:string>
  </DidYouMean>
  <EtpCount>3</EtpCount>
  <FormatCountList xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:ItemCount>
      <d2p1:Count>2</d2p1:Count>
      <d2p1:IsSelected>true</d2p1:IsSelected>
      <d2p1:Item>string</d2p1:Item>
      <d2p1:Value>string</d2p1:Value>
    </d2p1:ItemCount>
  </FormatCountList>
  <IsAutoCorrectionUsed>true</IsAutoCorrectionUsed>
  <Metadata xmlns:d2p1="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.Core.MetaData">
    <d2p1:CitationSuggested>string</d2p1:CitationSuggested>
    <d2p1:DataSource>
      <d2p1:MetaDataSource>
        <d2p1:DataDescription>string</d2p1:DataDescription>
        <d2p1:DataLastUpdate>string</d2p1:DataLastUpdate>
        <d2p1:DataName>string</d2p1:DataName>
        <d2p1:DataSourceCitation>string</d2p1:DataSourceCitation>
        <d2p1:DataSourceName>string</d2p1:DataSourceName>
        <d2p1:DataSourceUrl>string</d2p1:DataSourceUrl>
        <d2p1:DataVintageOrVersion>string</d2p1:DataVintageOrVersion>
      </d2p1:MetaDataSource>
    </d2p1:DataSource>
    <d2p1:LastAccessDate>string</d2p1:LastAccessDate>
    <d2p1:Publisher>string</d2p1:Publisher>
    <d2p1:Sponsor>string</d2p1:Sponsor>
  </Metadata>
  <OccupationCountList xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:ItemCount>
      <d2p1:Count>2</d2p1:Count>
      <d2p1:IsSelected>true</d2p1:IsSelected>
      <d2p1:Item>string</d2p1:Item>
      <d2p1:Value>string</d2p1:Value>
    </d2p1:ItemCount>
  </OccupationCountList>
  <ProgramCountList xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:ItemCount>
      <d2p1:Count>2</d2p1:Count>
      <d2p1:IsSelected>true</d2p1:IsSelected>
      <d2p1:Item>string</d2p1:Item>
      <d2p1:Value>string</d2p1:Value>
    </d2p1:ItemCount>
  </ProgramCountList>
  <ProgramLengthCountList xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:ItemCount>
      <d2p1:Count>2</d2p1:Count>
      <d2p1:IsSelected>true</d2p1:IsSelected>
      <d2p1:Item>string</d2p1:Item>
      <d2p1:Value>string</d2p1:Value>
    </d2p1:ItemCount>
  </ProgramLengthCountList>
  <RecordCount>1</RecordCount>
  <SchoolCountList xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:ItemCount>
      <d2p1:Count>2</d2p1:Count>
      <d2p1:IsSelected>true</d2p1:IsSelected>
      <d2p1:Item>string</d2p1:Item>
      <d2p1:Value>string</d2p1:Value>
    </d2p1:ItemCount>
  </SchoolCountList>
  <SchoolPrograms>
    <ProgramItem>
      <Address>string</Address>
      <AwLevelCode>5</AwLevelCode>
      <AwardLevel>string</AwardLevel>
      <CipCode>string</CipCode>
      <CipTitle>string</CipTitle>
      <City>string</City>
      <Credential>string</Credential>
      <DataSource>string</DataSource>
      <DetailId>1</DetailId>
      <Distance>string</Distance>
      <EtaProgramName>string</EtaProgramName>
      <Format xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>string</d4p1:string>
      </Format>
      <Latitude>string</Latitude>
      <Longitude>string</Longitude>
      <NumberCompleted xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>string</d4p1:string>
      </NumberCompleted>
      <OccupationsList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>string</d4p1:string>
      </OccupationsList>
      <Phone>string</Phone>
      <SchoolIDUnique>9</SchoolIDUnique>
      <SchoolName>string</SchoolName>
      <SchoolURL>string</SchoolURL>
      <State>string</State>
      <StateAbbr>string</StateAbbr>
      <Zip>string</Zip>
    </ProgramItem>
  </SchoolPrograms>
  <SearchedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/API.CareerOneStop.DTO.Training">
    <d2p1:DataSetType>string</d2p1:DataSetType>
    <d2p1:FormattedCode>string</d2p1:FormattedCode>
    <d2p1:IsCode>true</d2p1:IsCode>
    <d2p1:KeywordEntered>string</d2p1:KeywordEntered>
    <d2p1:SchoolOrProgram>string</d2p1:SchoolOrProgram>
    <d2p1:Title>string</d2p1:Title>
    <d2p1:Type>string</d2p1:Type>
  </SearchedOn>
</ProgramList>