Skip to Content

Search by ID

GET
/v1/BoardsCouncilsFinder/{userId}/{tid}/{lid}/{id}
Parameters
string


api token is required field
string


userId is required field
string

type id, use 0 for WDB, 1 for YC

tid is required field
string

level id, use 0 for state and local, 1 for state, 2 for local

lid is required field
string

598 for local or VA for state

id 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/BoardsCouncilsFinder/{userId}/{tid}/{lid}/{id}"
            };
            
            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/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 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
                        {
  "BOARDS": [
    {
      "ID": "string",
      "BOARD": "string",
      "LEVEL": "string",
      "TYPE": "string",
      "ADDR1": "string",
      "ADDR2": "string",
      "CITY": "string",
      "STATE": "string",
      "ZIP": "string",
      "GEOCODE": {
        "LAT": "string",
        "LON": "string"
      },
      "COUNTIES": "string",
      "CITIES": "string",
      "TOWNS": "string",
      "COMPANY": "string",
      "URL": "string",
      "VALID": "string",
      "DIST": 16.0,
      "CONTACTS": [
        {
          "GID": "string",
          "GNAME": "string",
          "CCOMPANY": "string",
          "CNAME": "string",
          "CTITLE": "string",
          "CEMAIL": "string",
          "CPHONE": "string",
          "CFAX": "string",
          "CADDR1": "string",
          "CADDR2": "string",
          "CCITY": "string",
          "CSTATE": "string",
          "CZIP": "string",
          "CURL": "string"
        }
      ]
    }
  ],
  "INFO": {
    "COUNT": "string",
    "STATE": "string",
    "STATENAME": "string",
    "MESSAGE": "string",
    "SEARCHINFO": {
      "LOCATION": "string",
      "RADIUS": "string",
      "ID": "string",
      "RESULTTYPE": "string",
      "TYPEID": "string",
      "TYPEDESC": "string",
      "LEVELID": "string",
      "LEVELDESC": "string",
      "TEXT": "string",
      "LWDBCOUNT": "string",
      "SYCREF": "string",
      "LYCREF": "string"
    },
    "FILTERS": [
      {
        "Item": "string",
        "Count": 2,
        "Value": "string"
      }
    ]
  }
}
                    
                        <WorkforceBoardsCouncils xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/XPAND.CareerOneStop.WebApi.ViewModels">
  <BOARDS>
    <WorkforceBoardCouncil>
      <ADDR1>string</ADDR1>
      <ADDR2>string</ADDR2>
      <BOARD>string</BOARD>
      <CITIES>string</CITIES>
      <CITY>string</CITY>
      <COMPANY>string</COMPANY>
      <CONTACTS>
        <BoardContact>
          <CADDR1>string</CADDR1>
          <CADDR2>string</CADDR2>
          <CCITY>string</CCITY>
          <CCOMPANY>string</CCOMPANY>
          <CEMAIL>string</CEMAIL>
          <CFAX>string</CFAX>
          <CNAME>string</CNAME>
          <CPHONE>string</CPHONE>
          <CSTATE>string</CSTATE>
          <CTITLE>string</CTITLE>
          <CURL>string</CURL>
          <CZIP>string</CZIP>
          <GID>string</GID>
          <GNAME>string</GNAME>
        </BoardContact>
      </CONTACTS>
      <COUNTIES>string</COUNTIES>
      <DIST>16</DIST>
      <GEOCODE>
        <LAT>string</LAT>
        <LON>string</LON>
      </GEOCODE>
      <ID>string</ID>
      <LEVEL>string</LEVEL>
      <STATE>string</STATE>
      <TOWNS>string</TOWNS>
      <TYPE>string</TYPE>
      <URL>string</URL>
      <VALID>string</VALID>
      <ZIP>string</ZIP>
    </WorkforceBoardCouncil>
  </BOARDS>
  <INFO>
    <COUNT>string</COUNT>
    <FILTERS>
      <ItemCount>
        <Count>2</Count>
        <Item>string</Item>
        <Value>string</Value>
      </ItemCount>
    </FILTERS>
    <MESSAGE>string</MESSAGE>
    <SEARCHINFO>
      <ID>string</ID>
      <LEVELDESC>string</LEVELDESC>
      <LEVELID>string</LEVELID>
      <LOCATION>string</LOCATION>
      <LWDBCOUNT>string</LWDBCOUNT>
      <LYCREF>string</LYCREF>
      <RADIUS>string</RADIUS>
      <RESULTTYPE>string</RESULTTYPE>
      <SYCREF>string</SYCREF>
      <TEXT>string</TEXT>
      <TYPEDESC>string</TYPEDESC>
      <TYPEID>string</TYPEID>
    </SEARCHINFO>
    <STATE>string</STATE>
    <STATENAME>string</STATENAME>
  </INFO>
</WorkforceBoardsCouncils>