Skip to Content

List Training Programs by Element ID

GET
/v1/training/{userId}/skill/{elementId}/{location}/{radius}/{occupation}/{programName}/{programLength}/{state}/{region}/{sortColumns}/{sortDirections}/{startRecord}/{limitRecord}
Parameters
string


api token is required field
string


userId is required field
string

ex: 2.C.3.b

elementId is required field
string

city, state(reston, va) or state (VA) or zipcode (20191) or 0

location is required field
string

ex: 25

radius is required field
string

filter: default value is 0

occupation is required field
string

filter: default value is 0

programName is required field
string

filter: default value is 0

programLength is required field
string

filter: default value is 0

state is required field
string

filter: default value is 0

region is required field
string

ex: School or ProgramName
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/training/{userId}/skill/{elementId}/{location}/{radius}/{occupation}/{programName}/{programLength}/{state}/{region}/{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/training/{userId}/skill/{elementId}/{location}/{radius}/{occupation}/{programName}/{programLength}/{state}/{region}/{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
                        {
  "SchoolPrograms": [
    {
      "ID": "string",
      "SchoolName": "string",
      "SchoolUrl": "string",
      "Address": "string",
      "City": "string",
      "StateAbbr": "string",
      "StateName": "string",
      "Zip": "string",
      "Phone": "string",
      "Distance": "string",
      "Region": "string",
      "RegionCode": "string",
      "TotalEnrollment": "string",
      "ProgramName": "string",
      "StudentGraduated": "string",
      "ElementID": "string",
      "ProgramLength": [
        {
          "Name": "string",
          "Value": "string"
        }
      ],
      "Occupationslist": [
        {
          "Name": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "RecordCount": 1,
  "DidYouMean": [
    "string"
  ],
  "AutoCorrection": "string",
  "LocationCountList": {
    "UndoList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ],
    "FilterList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  },
  "CityCountList": {
    "UndoList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ],
    "FilterList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  },
  "RegionCountList": {
    "UndoList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ],
    "FilterList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  },
  "OccupationCountList": {
    "UndoList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ],
    "FilterList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  },
  "ProgramCountList": {
    "UndoList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ],
    "FilterList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  },
  "ProgramLengthCountList": {
    "UndoList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ],
    "FilterList": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  },
  "SchoolOrProgram": "string"
}
                    
                        <SchoolProgram xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">
  <AutoCorrection>string</AutoCorrection>
  <CityCountList>
    <FilterList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FilterList>
    <UndoList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </UndoList>
  </CityCountList>
  <DidYouMean xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>string</d2p1:string>
  </DidYouMean>
  <LocationCountList>
    <FilterList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FilterList>
    <UndoList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </UndoList>
  </LocationCountList>
  <OccupationCountList>
    <FilterList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FilterList>
    <UndoList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </UndoList>
  </OccupationCountList>
  <ProgramCountList>
    <FilterList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FilterList>
    <UndoList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </UndoList>
  </ProgramCountList>
  <ProgramLengthCountList>
    <FilterList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FilterList>
    <UndoList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </UndoList>
  </ProgramLengthCountList>
  <RecordCount>1</RecordCount>
  <RegionCountList>
    <FilterList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FilterList>
    <UndoList>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </UndoList>
  </RegionCountList>
  <SchoolOrProgram>string</SchoolOrProgram>
  <SchoolPrograms>
    <SchoolProgramDetails>
      <Address>string</Address>
      <City>string</City>
      <Distance>string</Distance>
      <ElementID>string</ElementID>
      <ID>string</ID>
      <Occupationslist>
        <Dimension>
          <Name>string</Name>
          <Value>string</Value>
        </Dimension>
      </Occupationslist>
      <Phone>string</Phone>
      <ProgramLength>
        <Dimension>
          <Name>string</Name>
          <Value>string</Value>
        </Dimension>
      </ProgramLength>
      <ProgramName>string</ProgramName>
      <Region>string</Region>
      <RegionCode>string</RegionCode>
      <SchoolName>string</SchoolName>
      <SchoolUrl>string</SchoolUrl>
      <StateAbbr>string</StateAbbr>
      <StateName>string</StateName>
      <StudentGraduated>string</StudentGraduated>
      <TotalEnrollment>string</TotalEnrollment>
      <Zip>string</Zip>
    </SchoolProgramDetails>
  </SchoolPrograms>
</SchoolProgram>