Banner: Web API: Search by ID

Web API: Search by ID

Search by ID

The 'Search by ID' Web API enables developers to query and retrieve information on a specific Workforce Development Board or Youth Committee by providing the type id, level id, and an ID. You will get ID by using the complement service 'Search by Location'.

About this data

This Web API is used on www.CareerOneStop.org to Find a Workforce Development Board's details. You can see the Workforce Development Board Finder here. Find out how a Workforce Development Board can help you by clicking here for more information on this tool and the associated data.

CareerOneStop Geocoding is provided through a license agreement with Microsoft. Your use of the data is subject to the Microsoft Bing Maps Terms of Service.

https://www.microsoft.com/en-us/maps/product

You may use the Geocodes locally in your applications. But, Geocodes cannot be stored, copied or shared. Please refer to the Microsoft Bing Terms of Use. 

Resource URL

https://api.careeronestop.org/v1/BoardsCouncilsFinder/{userId}/{tid}/{lid}/{id}

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/BoardsCouncilsFinder/{userId}/{tid}/{lid}/{id}"

            };

           

            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/BoardsCouncilsFinder/{userId}/{tid}/{lid}/{id}")

        .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
The unique API Token provided during the CareerOneStop Web API registration process
userId
String
Yes The unique UserID provided during the CareerOneStop Web API registration process
tid
String
Yes A type id, use 0 for WDB (Workforce Development Board), 1 for YC (Youth Council)
lid
String    
Yes A level id, use 0 for state and local, 1 for state, 2 for local
id
String
Yes Use an id, such as 598 for local or VA for state

Response Structure

{

  "BOARDS": [

    {

      "ID": "598",

      "BOARD": "Alexandria/Arlington Regional Workforce Council",

      "LEVEL": "LOCAL",

      "TYPE": "WDB",

      "ADDR1": "2100 Washington Blvd",

      "ADDR2": "1st Floor",

      "CITY": "Arlington",

      "STATE": "VA",

      "ZIP": "22204",

      "GEOCODE": {

        "LAT": "38.873808",

        "LON": "-77.083832"

      },

      "COUNTIES": "Alexandria, Arlington",

      "CITIES": "",

      "TOWNS": "",

      "COMPANY": "Alexandria/Arlington Regional Workforce Council",

      "URL": "https://workforcecouncil.arlingtonva.us/",

      "VALID": "1",

      "DIST": -1,

      "CONTACTS": [

        {

          "GID": "10",

          "GNAME": "WDB - Local Executive Directors",

          "CCOMPANY": "Alexandria/Arlington Regional Workforce Council",

          "CNAME": "David Remick",

          "CTITLE": "Executive Director",

          "CEMAIL": "dremick@arlingtonva.us",

          "CPHONE": "703-228-1412",

          "CFAX": "703-228-1044",

          "CADDR1": "2100 Washington Blvd",

          "CADDR2": "1st Floor",

          "CCITY": "Arlington",

          "CSTATE": "VA",

          "CZIP": "22204",

          "CURL": "https://workforcecouncil.arlingtonva.us/"

        },

        {

          "GID": "1",

          "GNAME": "WDB - Local Chairs",

          "CCOMPANY": "MAXIMUS",

          "CNAME": "Daniel Gomez",

          "CTITLE": "Sr. Consultant, Business Development & Government Relations",

          "CEMAIL": "DanielGomez@maximus.com",

          "CPHONE": "703-251-8500",

          "CFAX": "",

          "CADDR1": "2100 Washington Blvd.",

          "CADDR2": "First Floor",

          "CCITY": "Arlington",

          "CSTATE": "VA",

          "CZIP": "22204",

          "CURL": ""

        },

        {

          "GID": "112",

          "GNAME": "Youth Councils - Local",

          "CCOMPANY": "Alexandria/Arlington Workforce Investment Board Youth Council",

          "CNAME": "Christopher Rieley",

          "CTITLE": "Chair",

          "CEMAIL": "dremick@arlingtonva.us",

          "CPHONE": "703-228-1412",

          "CFAX": "703 228-1170",

          "CADDR1": "2100 Washington Blvd 1st Floor - AEC",

          "CADDR2": "",

          "CCITY": "Arlington",

          "CSTATE": "VA",

          "CZIP": "22204",

          "CURL": ""

        }

      ]

    }

  ],

  "INFO": {

    "COUNT": "1",

    "STATE": "VA",

    "STATENAME": "Virginia",

    "MESSAGE": "",

    "SEARCHINFO": {

      "LOCATION": "",

      "RADIUS": "",

      "ID": "598",

      "RESULTTYPE": "ID",

      "TYPEID": "0",

      "TYPEDESC": "WDB",

      "LEVELID": "0",

      "LEVELDESC": "State and Local",

      "TEXT": "Workforce Development Boards",

      "LWDBCOUNT": "15",

      "SYCREF": "0",

      "LYCREF": "0"

    },

    "FILTERS": []

  }

}
<WorkforceBoardsCouncils

xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">

<BOARDS>

<WorkforceBoardCouncil>

<ADDR1>2100 Washington Blvd</ADDR1>

<ADDR2>1st Floor</ADDR2>

<BOARD>Alexandria/Arlington Regional Workforce Council</BOARD>

<CITIES/>

<CITY>Arlington</CITY>

<COMPANY>Alexandria/Arlington Regional Workforce Council</COMPANY>

<CONTACTS>

<BoardContact>

<CADDR1>2100 Washington Blvd</CADDR1>

<CADDR2>1st Floor</CADDR2>

<CCITY>Arlington</CCITY>

<CCOMPANY>Alexandria/Arlington Regional Workforce Council</CCOMPANY>

<CEMAIL>dremick@arlingtonva.us</CEMAIL>

<CFAX>703-228-1044</CFAX>

<CNAME>David Remick</CNAME>

<CPHONE>703-228-1412</CPHONE>

<CSTATE>VA</CSTATE>

<CTITLE>Executive Director</CTITLE>

<CURL>https://workforcecouncil.arlingtonva.us/</CURL>

<CZIP>22204</CZIP>

<GID>10</GID>

<GNAME>WDB - Local Executive Directors</GNAME>

</BoardContact>

<BoardContact>

<CADDR1>2100 Washington Blvd.</CADDR1>

<CADDR2>First Floor</CADDR2>

<CCITY>Arlington</CCITY>

<CCOMPANY>MAXIMUS</CCOMPANY>

<CEMAIL>DanielGomez@maximus.com</CEMAIL>

<CFAX/>

<CNAME>Daniel Gomez</CNAME>

<CPHONE>703-251-8500</CPHONE>

<CSTATE>VA</CSTATE>

<CTITLE>Sr. Consultant, Business Development & Government Relations</CTITLE>

<CURL/>

<CZIP>22204</CZIP>

<GID>1</GID>

<GNAME>WDB - Local Chairs</GNAME>

</BoardContact>

<BoardContact>

<CADDR1>2100 Washington Blvd 1st Floor - AEC</CADDR1>

<CADDR2/>

<CCITY>Arlington</CCITY>

<CCOMPANY>Alexandria/Arlington Workforce Investment Board Youth Council</CCOMPANY>

<CEMAIL>dremick@arlingtonva.us</CEMAIL>

<CFAX>703 228-1170</CFAX>

<CNAME>Christopher Rieley</CNAME>

<CPHONE>703-228-1412</CPHONE>

<CSTATE>VA</CSTATE>

<CTITLE>Chair</CTITLE>

<CURL/>

<CZIP>22204</CZIP>

<GID>112</GID>

<GNAME>Youth Councils - Local</GNAME>

</BoardContact>

</CONTACTS>

<COUNTIES>Alexandria, Arlington</COUNTIES>

<DIST>-1</DIST>

<GEOCODE>

<LAT>38.873808</LAT>

<LON>-77.083832</LON>

</GEOCODE>

<ID>598</ID>

<LEVEL>LOCAL</LEVEL>

<STATE>VA</STATE>

<TOWNS/>

<TYPE>WDB</TYPE>

<URL>https://workforcecouncil.arlingtonva.us/</URL>

<VALID>1</VALID>

<ZIP>22204</ZIP>

</WorkforceBoardCouncil>

</BOARDS>

<INFO>

<COUNT>1</COUNT>

<FILTERS/>

<MESSAGE/>

<SEARCHINFO>

<ID>598</ID>

<LEVELDESC>State and Local</LEVELDESC>

<LEVELID>0</LEVELID>

<LOCATION/>

<LWDBCOUNT>15</LWDBCOUNT>

<LYCREF>0</LYCREF>

<RADIUS/>

<RESULTTYPE>ID</RESULTTYPE>

<SYCREF>0</SYCREF>

<TEXT>Workforce Development Boards</TEXT>

<TYPEDESC>WDB</TYPEDESC>

<TYPEID>0</TYPEID>

</SEARCHINFO>

<STATE>VA</STATE>

<STATENAME>Virginia</STATENAME>

</INFO>

</WorkforceBoardsCouncils>

Response Parameters

Name
Description
Type
Parent
Boards
Boards
Object
Empty Cell
ID
Unique ID for this board
String
Empty Cell
BOARD
Workforce Development Board Name/Department
String
Empty Cell
LEVEL
Level, STATE or LOCAL
String
Empty Cell
TYPE
Type, WDB (Workforce Development Board) or YC (Youth Council)
String
Empty Cell
ADDR1
Address 1
String
Empty Cell
ADDR2
Address 2
String
Empty Cell
CITY
City
String
Empty Cell
STATE
State Abbreviation
String
Empty Cell
ZIP
Zip
String
Empty Cell
GEOCODE
Location of the main office
Object
Empty Cell
LAT
Latitude
Number
GEOCODE
LON
Longitude
Number
GEOCODE
COUNTIES
Counties served by the board
String
Empty Cell
CITIES
Cities served by the board
String
Empty Cell
TOWNS
Towns served by the board
String
Empty Cell
COMPANY
related company name, if applicable
String
Empty Cell
URL
Website Url
String
Empty Cell
VALID
Valid, a flag for location accuracy and display of map and directions
1 for both map and directions
2 for map only
3 for no display of map and directions
String
Empty Cell
DIST
Distance from a searched location, with -1 as uncalculated
Number
Empty Cell
CONTACTS
Contacts
Object
Empty Cell
GID
Group ID
State WDB, 9 and 16
Local WDB, 10 and 1
State YC, 113
Local YC, 112
String
CONTACTS
GNAME
Group Name
String
CONTACTS
CCOMPANY
Contact Company
String
CONTACTS
CNAME
Contact Name
String
CONTACTS
CTITLE
Contact Title
String
CONTACTS
CEMAIL
Contact Email
String
CONTACTS
CPHONE
Contact Phone
String
CONTACTS
CFAX
Contact Fax
String
CONTACTS
CADDR1
Contact Address 1
String
CONTACTS
CADDR2
Contact Address 2
String
CONTACTS
CCITY
Contact City
String
CONTACTS
CSTATE
Contact State
String
CONTACTS
CZIP
Contact Zip Code
String
CONTACTS
CURL
Contact Website Url
String
CONTACTS
INFO
Information about this search and the results
Object
Empty Cell
COUNT
Count
String
INFO
STATE
State
String
INFO
STATENAME
State Name
String
INFO
MESSAGE
Message, if applicable
String
INFO
SEARCHINFO
Information about this search
Object
INFO
LOCATION
Location
String
SEARCHINFO
RADIUS
Radius
String
SEARCHINFO
ID
ID when searched by id
String
SEARCHINFO
RESULTTYPE
State, City, or ZIP results based on input
String
SEARCHINFO
TYPEID
Type ID, 0 for WDB, 1 for YC
String
SEARCHINFO
TYPEDESC
Type Description
String
SEARCHINFO
LEVELID
Level ID, 0 for state and local, 1 for state, 2 for local
String
SEARCHINFO
LEVELDESC
Level Description
String
SEARCHINFO
TEXT
Type Text
String
SEARCHINFO
LWDBCOUNT
Number of Local WDBs in a State
String
SEARCHINFO
SYCREF
State YC reference, if applicable
String
SEARCHINFO
LYCREF
Local YC reference, if applicable
String
SEARCHINFO
FILTERS
Count of each type of board in these results
Object
Empty Cell
Item
Item
String
FILTERS
Count
Count
String
FILTERS
Value
Value
String
FILTERS

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.