Banner: Web API: List apprenticeship offices

Web API: List apprenticeship offices

List apprenticeship offices

The 'List Apprenticeship Offices' API enables developers to retrieve a list of apprenticeship offices by location. These are administrative offices for the states' apprenticeship programs.

About this data

The CareerOneStop website offers apprenticeship program state office information through the Apprenticeship Office Finder. Apprenticeship programs are regulated by states and sponsored by an employer, labor group, or employer association. This API returns details about the federal and state offices that regulate apprenticeships. If you would like more information about the data provided, you can find it on the Apprenticeship Office Finder help page.

Resource URL

https://api.careeronestop.org/v1/apprenticeshipfinder/{userId}/{location}/{radius}

Try this Web API

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/apprenticeshipfinder/{userId}/{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/apprenticeshipfinder/{userId}/{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
location       
String    
Yes
This value accepts a city, state (Chicago, IL) or state (IL) or ZIP code (61299)
radius
String
Yes
This value accepts a radius size in miles around a specified location.

Response Structure

{

  "RecordCount": 1,

  "ApprenticeshipOfficeList": [

    {

      "ListFedAppOfficeContact": [

        {

          "ID": "32675576",

          "Name": "Richmond Field Office",

          "Address1": "Federal Building, Suite 404",

          "Address2": "400 North 8th Street",

          "City": "Richmond",

          "State": "VA",

          "Zip": "23219-4805",

          "Phone": "804-771-2488",

          "Fax": "804-771-8679",

          "ProgramLevel": "Federal",

          "StateType": "SAA",

          "Region": "3",

          "ContactName": "James F. Walker",

          "ContactTitle": "State Director",

          "ContactEmail": "walker.james@dol.gov",

          "ContactPhone": "804-771-2488",

          "ContactFax": "804-771-8679",

          "ContactId": "6781"

        },

        {

          "ID": "32675576",

          "Name": "Richmond Field Office",

          "Address1": "Federal Building, Suite 404",

          "Address2": "400 North 8th Street",

          "City": "Richmond",

          "State": "VA",

          "Zip": "23219-4805",

          "Phone": "804-771-2488",

          "Fax": "804-771-8679",

          "ProgramLevel": "Federal",

          "StateType": "SAA",

          "Region": "3",

          "ContactName": "John B. McDowell",

          "ContactTitle": "ATR",

          "ContactEmail": "mcdowell.john@dol.gov",

          "ContactPhone": "804-771-2488",

          "ContactFax": "804-771-8679",

          "ContactId": "6782"

        }

      ],

      "ListStateAppOfficeContact": [

        {

          "ID": "32675577",

          "Name": "Division of Registered Apprenticeship, Virginia Department of Labor and Industry",

          "Address1": "Division of Registered Apprenticeship, Virginia Department of Labor and Industry",

          "Address2": "600 East Main Street, Suite 207",

          "City": "Richmond",

          "State": "VA",

          "Zip": "23219",

          "Phone": "804-225-4362",

          "Fax": "804-786-8418",

          "ProgramLevel": "State",

          "StateType": "SAA",

          "Region": "3",

          "ContactName": "Beverley Donati",

          "ContactTitle": "Director",

          "ContactEmail": "Beverly.donati@doli.virginia.gov",

          "ContactPhone": "804-225-4362",

          "ContactFax": "804-786-8418",

          "ContactId": "6783"

        }

      ],

      "ListRegionalAppOfficeContact": [

        {

          "ID": "32675602",

          "Name": "Atlanta Regional Office",

          "Address1": "Atlanta Regional Office",

          "Address2": "61 Forsyth Street, SW., Room 6T100",

          "City": "Atlanta",

          "State": "GA",

          "Zip": "30303-8938",

          "Phone": "404-302-5478",

          "Fax": "404-302-5896",

          "ProgramLevel": "Regional",

          "StateType": "",

          "Region": "3",

          "ContactName": "Garfield G. Garner, Jr.",

          "ContactTitle": "Regional Director",

          "ContactEmail": "garner. garfield@dol.gov",

          "ContactPhone": "404-302-5480",

          "ContactFax": "404-302-5896",

          "ContactId": "6792"

        },

        {

          "ID": "32675602",

          "Name": "Atlanta Regional Office",

          "Address1": "Atlanta Regional Office",

          "Address2": "61 Forsyth Street, SW., Room 6T100",

          "City": "Atlanta",

          "State": "GA",

          "Zip": "30303-8938",

          "Phone": "404-302-5478",

          "Fax": "404-302-5896",

          "ProgramLevel": "Regional",

          "StateType": "",

          "Region": "3",

          "ContactName": "Nora L. Carlton",

          "ContactTitle": "Regional Executive Assistant",

          "ContactEmail": "carlton.nora@dol.gov",

          "ContactPhone": "404-302-5483",

          "ContactFax": "404-302-5896",

          "ContactId": "6793"

        },

        {

          "ID": "32675602",

          "Name": "Atlanta Regional Office",

          "Address1": "Atlanta Regional Office",

          "Address2": "61 Forsyth Street, SW., Room 6T100",

          "City": "Atlanta",

          "State": "GA",

          "Zip": "30303-8938",

          "Phone": "404-302-5478",

          "Fax": "404-302-5896",

          "ProgramLevel": "Regional",

          "StateType": "",

          "Region": "3",

          "ContactName": "Linda V. Seals",

          "ContactTitle": "Administrative Officer",

          "ContactEmail": "seals.linda@dol.gov",

          "ContactPhone": "404-302-5488",

          "ContactFax": "404-302-5896",

          "ContactId": "6794"

        },

        {

          "ID": "32675602",

          "Name": "Atlanta Regional Office",

          "Address1": "Atlanta Regional Office",

          "Address2": "61 Forsyth Street, SW., Room 6T100",

          "City": "Atlanta",

          "State": "GA",

          "Zip": "30303-8938",

          "Phone": "404-302-5478",

          "Fax": "404-302-5896",

          "ProgramLevel": "Regional",

          "StateType": "",

          "Region": "3",

          "ContactName": "Jasper M. Williams",

          "ContactTitle": "Computer Specialist - NO",

          "ContactEmail": "williams.jasper@dol.gov",

          "ContactPhone": "404-302-5484",

          "ContactFax": "404-302-5896",

          "ContactId": "6795"

        }

      ],

      "State": "VA",

      "StateName": "Virginia",

      "StateType": "SAA",

      "WebsiteURL": "http://www.doli.virginia.gov/apprenticeship/search_title_city.cfm",

      "Title": "Virginia Registered Apprenticeship",

      "Region": null

    }

  ]

}

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

  <ApprenticeshipOfficeList>

    <StateApprenticeship>

      <ListFedAppOfficeContact>

        <AppOfficeContact>

          <Address1>Federal Building, Suite 404</Address1>

          <Address2>400 North 8th Street</Address2>

          <City>Richmond</City>

          <ContactEmail>walker.james@dol.gov</ContactEmail>

          <ContactFax>804-771-8679</ContactFax>

          <ContactId>6781</ContactId>

          <ContactName>James F. Walker</ContactName>

          <ContactPhone>804-771-2488</ContactPhone>

          <ContactTitle>State Director</ContactTitle>

          <Fax>804-771-8679</Fax>

          <ID>32675576</ID>

          <Name>Richmond Field Office</Name>

          <Phone>804-771-2488</Phone>

          <ProgramLevel>Federal</ProgramLevel>

          <Region>3</Region>

          <State>VA</State>

          <StateType>SAA</StateType>

          <Zip>23219-4805</Zip>

        </AppOfficeContact>

        <AppOfficeContact>

          <Address1>Federal Building, Suite 404</Address1>

          <Address2>400 North 8th Street</Address2>

          <City>Richmond</City>

          <ContactEmail>mcdowell.john@dol.gov</ContactEmail>

          <ContactFax>804-771-8679</ContactFax>

          <ContactId>6782</ContactId>

          <ContactName>John B. McDowell</ContactName>

          <ContactPhone>804-771-2488</ContactPhone>

          <ContactTitle>ATR</ContactTitle>

          <Fax>804-771-8679</Fax>

          <ID>32675576</ID>

          <Name>Richmond Field Office</Name>

          <Phone>804-771-2488</Phone>

          <ProgramLevel>Federal</ProgramLevel>

          <Region>3</Region>

          <State>VA</State>

          <StateType>SAA</StateType>

          <Zip>23219-4805</Zip>

        </AppOfficeContact>

      </ListFedAppOfficeContact>

      <ListRegionalAppOfficeContact>

        <AppOfficeContact>

          <Address1>Atlanta Regional Office</Address1>

          <Address2>61 Forsyth Street, SW., Room 6T100</Address2>

          <City>Atlanta</City>

          <ContactEmail>garner. garfield@dol.gov</ContactEmail>

          <ContactFax>404-302-5896</ContactFax>

          <ContactId>6792</ContactId>

          <ContactName>Garfield G. Garner, Jr.</ContactName>

          <ContactPhone>404-302-5480</ContactPhone>

          <ContactTitle>Regional Director</ContactTitle>

          <Fax>404-302-5896</Fax>

          <ID>32675602</ID>

          <Name>Atlanta Regional Office</Name>

          <Phone>404-302-5478</Phone>

          <ProgramLevel>Regional</ProgramLevel>

          <Region>3</Region>

          <State>GA</State>

          <StateType/>

          <Zip>30303-8938</Zip>

        </AppOfficeContact>

        <AppOfficeContact>

          <Address1>Atlanta Regional Office</Address1>

          <Address2>61 Forsyth Street, SW., Room 6T100</Address2>

          <City>Atlanta</City>

          <ContactEmail>carlton.nora@dol.gov</ContactEmail>

          <ContactFax>404-302-5896</ContactFax>

          <ContactId>6793</ContactId>

          <ContactName>Nora L. Carlton</ContactName>

          <ContactPhone>404-302-5483</ContactPhone>

          <ContactTitle>Regional Executive Assistant</ContactTitle>

          <Fax>404-302-5896</Fax>

          <ID>32675602</ID>

          <Name>Atlanta Regional Office</Name>

          <Phone>404-302-5478</Phone>

          <ProgramLevel>Regional</ProgramLevel>

          <Region>3</Region>

          <State>GA</State>

          <StateType/>

          <Zip>30303-8938</Zip>

        </AppOfficeContact>

        <AppOfficeContact>

          <Address1>Atlanta Regional Office</Address1>

          <Address2>61 Forsyth Street, SW., Room 6T100</Address2>

          <City>Atlanta</City>

          <ContactEmail>seals.linda@dol.gov</ContactEmail>

          <ContactFax>404-302-5896</ContactFax>

          <ContactId>6794</ContactId>

          <ContactName>Linda V. Seals</ContactName>

          <ContactPhone>404-302-5488</ContactPhone>

          <ContactTitle>Administrative Officer</ContactTitle>

          <Fax>404-302-5896</Fax>

          <ID>32675602</ID>

          <Name>Atlanta Regional Office</Name>

          <Phone>404-302-5478</Phone>

          <ProgramLevel>Regional</ProgramLevel>

          <Region>3</Region>

          <State>GA</State>

          <StateType/>

          <Zip>30303-8938</Zip>

        </AppOfficeContact>

        <AppOfficeContact>

          <Address1>Atlanta Regional Office</Address1>

          <Address2>61 Forsyth Street, SW., Room 6T100</Address2>

          <City>Atlanta</City>

          <ContactEmail>williams.jasper@dol.gov</ContactEmail>

          <ContactFax>404-302-5896</ContactFax>

          <ContactId>6795</ContactId>

          <ContactName>Jasper M. Williams</ContactName>

          <ContactPhone>404-302-5484</ContactPhone>

          <ContactTitle>Computer Specialist - NO</ContactTitle>

          <Fax>404-302-5896</Fax>

          <ID>32675602</ID>

          <Name>Atlanta Regional Office</Name>

          <Phone>404-302-5478</Phone>

          <ProgramLevel>Regional</ProgramLevel>

          <Region>3</Region>

          <State>GA</State>

          <StateType/>

          <Zip>30303-8938</Zip>

        </AppOfficeContact>

      </ListRegionalAppOfficeContact>

      <ListStateAppOfficeContact>

        <AppOfficeContact>

          <Address1>Division of Registered Apprenticeship, Virginia Department of Labor and Industry</Address1>

          <Address2>600 East Main Street, Suite 207</Address2>

          <City>Richmond</City>

          <ContactEmail>Beverly.donati@doli.virginia.gov</ContactEmail>

          <ContactFax>804-786-8418</ContactFax>

          <ContactId>6783</ContactId>

          <ContactName>Beverley Donati</ContactName>

          <ContactPhone>804-225-4362</ContactPhone>

          <ContactTitle>Director</ContactTitle>

          <Fax>804-786-8418</Fax>

          <ID>32675577</ID>

          <Name>Division of Registered Apprenticeship, Virginia Department of Labor and Industry</Name>

          <Phone>804-225-4362</Phone>

          <ProgramLevel>State</ProgramLevel>

          <Region>3</Region>

          <State>VA</State>

          <StateType>SAA</StateType>

          <Zip>23219</Zip>

        </AppOfficeContact>

      </ListStateAppOfficeContact>

      <Region i:nil="true"/>

      <State>VA</State>

      <StateName>Virginia</StateName>

      <StateType>SAA</StateType>

      <Title>Virginia Registered Apprenticeship</Title>

      <WebsiteURL>http://www.doli.virginia.gov/apprenticeship/search_title_city.cfm</WebsiteURL>

    </StateApprenticeship>

  </ApprenticeshipOfficeList>

  <RecordCount>1</RecordCount>

</ApprenticeshipOfficeContacts>

Response Parameters

Name
Description
Type
Parent
RecordCount
Usually, the value here will be 1. However, if the location search uses a zipcode and radius combination which falls under multiple states, there will be multiple “ApprenticeshipOfficeList”, and RecordCount will be matching that. One example: 20191, distance 50
Number
Empty Cell
ApprenticeshipOfficeList
There is one list object for every state in the result set
Object
Empty Cell
ListFedAppOfficeContact
List of contacts (people) for associated federal apprenticeship offices
Object
Apprenticeship
OfficeList
ID
Unique ID number for this apprenticeship office. These offices often have multiple individual contacts.
String
ListFedApp
OfficeContact
Name
Name
String
ListFedApp
OfficeContact
Address1
Address 1
String
ListFedApp
OfficeContact
Address2
Address 2
String
ListFedApp
OfficeContact
City
City
String
ListFedApp
OfficeContact
State
State
String
ListFedApp
OfficeContact
Zip
Zip
String
ListFedApp
OfficeContact
Phone
Phone
String
ListFedApp
OfficeContact
Fax
Fax
String
ListFedApp
OfficeContact
ProgramLevel
National, Regional, or State
String
ListFedApp
OfficeContact
StateType
Valid values are "SAA" and "OA". States that administer their apprenticeship program at a state government agency are labeled State Apprenticeship Agency (SAA) states. States that have chosen to have the Office of Apprenticeship at the Department of Labor administer their apprenticeship program are labeled Office of Apprenticeship (OA) states.
String
ListFedApp
OfficeContact
Region
The DOL region, as defined at https://www.dol.gov/agencies/eta/apprenticeship/contact/regional-offices. If ZIP+radius crosses state lines, then this parameter is populated. The value is not an ID, just the region's number, ranging from 1 to 6.
String
ListFedApp
OfficeContact
ContactName
Contact Name
String
ListFedApp
OfficeContact
ContactTitle
Contact Title
String
ListFedApp
OfficeContact
ContactEmail
Contact Email
String
ListFedApp
OfficeContact
ContactPhone
Contact APhone
String
ListFedApp
OfficeContact
ContactFax
Contact Fax
String
ListFedApp
OfficeContact
ContactId
Contact ID
String
ListFedApp
OfficeContact
ListStateAppOfficeContact
List of contacts for apprenticeship offices for the associated location, at the state level.
Object
Apprenticeship
OfficeList
ID
ID
String
ListStateApp
OfficeContact
Name
Name
String
ListStateApp
OfficeContact
Address1
Address 1
String
ListStateApp
OfficeContact
Address2
Address 2
String
ListStateApp
OfficeContact
City
City
String
ListStateApp
OfficeContact
State
State
String
ListStateApp
OfficeContact
Zip
Zip
String
ListStateApp
OfficeContact
Phone
Phone
String
ListStateApp
OfficeContact
Fax
Fax
String
ListStateApp
OfficeContact
ProgramLevel
Program Level
String
ListStateApp
OfficeContact
StateType
State Type
String
ListStateApp
OfficeContact
Region
Region
String
ListStateApp
OfficeContact
ContactName
Contact Name
String
ListStateApp
OfficeContact
ContactTitle
Contact Title
String
ListStateApp
OfficeContact
ContactEmail
Contact Email
String
ListStateApp
OfficeContact
ContactPhone
Contact Phone
String
ListStateApp
OfficeContact
ContactFax
Contact Fax
String
ListStateApp
OfficeContact
ContactId
Contact ID
String
ListStateApp
OfficeContact
ListRegionalAppOfficeContact
List of contacts at the associated regional office, using regions defined by DOL Office of Apprenticeship.
Object
Apprenticeship
OfficeList
ID
Id
String
ListRegionalApp
OfficeContact
Name
Name
String
ListRegionalApp
OfficeContact
Address1
Address 1
String
ListRegionalApp
OfficeContact
Address2
Address 2
String
ListRegionalApp
OfficeContact
City
City
String
ListRegionalApp
OfficeContact
State
State
String
ListRegionalApp
OfficeContact
Zip
Zip
String
ListRegionalApp
OfficeContact
Phone
Phone
String
ListRegionalApp
OfficeContact
Fax
Fax
String
ListRegionalApp
OfficeContact
ProgramLevel
Program Level
String
ListRegionalApp
OfficeContact
StateType
State Type
String
ListRegionalApp
OfficeContact
Region
Region
String
ListRegionalApp
OfficeContact
ContactName
Contact Name
String
ListRegionalApp
OfficeContact
ContactTitle
Contact Title
String
ListRegionalApp
OfficeContact
ContactEmail
Contact Email
String
ListRegionalApp
OfficeContact
ContactPhone
Contact Phone
String
ListRegionalApp
OfficeContact
ContactFax
Contact Fax
String
ListRegionalApp
OfficeContact
ContactId
Contact ID
String
ListRegionalApp
OfficeContact
State
Two-character abbreviation
String
Apprenticeship
OfficeList
StateName
Full name of the state
String
Apprenticeship
OfficeList
StateType
Valid values are "SAA" and "OA". States that administer their apprenticeship program at a state government agency are labeled State Apprenticeship Agency (SAA) states. States that have chosen to have the Office of Apprenticeship at the Department of Labor administer their apprenticeship program are labeled Office of Apprenticeship (OA) states.
String
Apprenticeship
OfficeList
WebsiteURL
State web page that lists apprenticeship sponsors, if the state has one and if we know about it.
String
Apprenticeship
OfficeList
Title
Title of that web page (WebsiteURL).
String
Apprenticeship
OfficeList
Region
DOL region
String
Apprenticeship
OfficeList

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.