Banner: Web API: Get certification details by ID

Web API: Get certification details by ID

Get certification details by ID

The 'Get Certification Details by ID' Web API allows users to search a database of occupation certification information by certification ID. It is used in conjunction with a complementary service which provides a list of certifications that match search criteria.

About this data

This web API gives information about occupational certifications and certifying organizations. The Certification Finder demonstrates how this data can be used. For more information on the data, please visit the Certification Finder help page.

Resource URL

https://api.careeronestop.org/v1/certificationfinder/{userId}/{certId}

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/certificationfinder/{userId}/{certId}"

            };

           

            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/certificationfinder/{userId}/{certId}")

        .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 services registration process
userId
String
Yes
This value is the unique UserID provided during the CareerOneStop web services registration process
certId
String
Yes
This value is the unique ID for the certification. It can be obtained from the certifications search  API (List Certifications)

Response Structure

{

  "Id": "5733-A",

  "Name": "Nurse Manager and Leader",

  "Url": "http://www.aone.org/resources/certification/about_certifications.shtml#cnml",

  "Organization": "American Association of Critical-Care Nurses ",

  "Type": "Core",

  "TypeOrder": "A",

  "Related": null,

  "CertAccredAgencyList": [

    {

      "Name": "NCCA",

      "Order": "2"

    }

  ],

  "OrganizationAddress": "101 Columbia, Aliso Viejo, CA 92656-1491",

  "OrganizationUrl": "http://www.aacn.org/",

  "Acronym": "CNML",

  "Description": "The Certified Nurse Manager and Leader (CNML) credential, a collaborative effort between the American Organization of Nurse Executives (AONE) Credentialing Center and the American Association of Critical-Care Nurses (AACN) Certification Corporation, is now available.\r\n\r\nCNML certification gives nurse managers a way to validate their knowledge as they strive to excel in their demanding roles, carrying out complex leadership responsibilities that directly affect the quality of care to patients and families.\r\n\r\n",

  "CertDetailList": [

    {

      "Name": "Education and Training Required?",

      "Value": "Yes"

    },

    {

      "Name": "Work Experience Required?",

      "Value": "Yes"

    },

    {

      "Name": "Either training or work experience required, but not both?",

      "Value": "No"

    },

    {

      "Name": "Oral or Written Exam Required?",

      "Value": "Yes"

    },

    {

      "Name": "Renewal Required?",

      "Value": "Every 3  Year(s)"

    },

    {

      "Name": "Renew through Continuing Educational Units(CEU)?",

      "Value": "Yes"

    },

    {

      "Name": "Renew through Re-Examination?",

      "Value": "Yes"

    },

    {

      "Name": "Renew through Continuing Professional Development(CPD)?",

      "Value": "No"

    },

    {

      "Name": "Does applicant have choice of at least two options from above for renewal (CEU, CPD, or exam)?",

      "Value": "Yes"

    }

  ],

  "CertTestOption": [],

  "ExamDetail": null

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

  <Acronym>CNML</Acronym>

  <CertAccredAgencyList>

    <Credential>

      <Name>NCCA</Name>

      <Order>2</Order>

    </Credential>

  </CertAccredAgencyList>

  <CertDetailList>

    <NameValue>

      <Name>Education and Training Required?</Name>

      <Value>Yes</Value>

    </NameValue>

    <NameValue>

      <Name>Work Experience Required?</Name>

      <Value>Yes</Value>

    </NameValue>

    <NameValue>

      <Name>Either training or work experience required, but not both?</Name>

      <Value>No</Value>

    </NameValue>

    <NameValue>

      <Name>Oral or Written Exam Required?</Name>

      <Value>Yes</Value>

    </NameValue>

    <NameValue>

      <Name>Renewal Required?</Name>

      <Value>Every 3 Year(s)</Value>

    </NameValue>

    <NameValue>

      <Name>Renew through Continuing Educational Units(CEU)?</Name>

      <Value>Yes</Value>

    </NameValue>

    <NameValue>

      <Name>Renew through Re-Examination?</Name>

      <Value>Yes</Value>

    </NameValue>

    <NameValue>

      <Name>Renew through Continuing Professional Development(CPD)?</Name>

      <Value>No</Value>

    </NameValue>

    <NameValue>

      <Name>Does applicant have choice of at least two options from above for renewal (CEU, CPD, or exam)?</Name>

      <Value>Yes</Value>

    </NameValue>

  </CertDetailList>

  <CertTestOption xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"/>

  <Description>The Certified Nurse Manager and Leader (CNML) credential, a collaborative effort between the American Organization of Nurse Executives (AONE) Credentialing Center and the American Association of Critical-Care Nurses (AACN) Certification Corporation, is now available. CNML certification gives nurse managers a way to validate their knowledge as they strive to excel in their demanding roles, carrying out complex leadership responsibilities that directly affect the quality of care to patients and families. </Description>

  <ExamDetail i:nil="true"/>

  <Id>5733-A</Id>

  <Name>Nurse Manager and Leader</Name>

  <Organization>American Association of Critical-Care Nurses </Organization>

  <OrganizationAddress>101 Columbia, Aliso Viejo, CA 92656-1491</OrganizationAddress>

  <OrganizationUrl>http://www.aacn.org/</OrganizationUrl>

  <Related i:nil="true"/>

  <Type>Core</Type>

  <TypeOrder>A</TypeOrder>

  <Url>http://www.aone.org/resources/certification/about_certifications.shtml#cnml</Url>

</CertificationFinderDetail>

Response Parameters

Name Description Type
Id
ID
String
Name
Name
String
Url
URL
String
Organization
Organization String
Type
Values for "type" include Core, Advanced, etc. These are described on the Certification Finder Help page.  String
TypeOrder
Order that can be used to list all certifications of type "Core" first, then "Advanced", etc. It provides the order for types as they appear in CareerOneStop's Certification Finder. String
Related
Not populated by this Web API String
CertAccredAgencyList
Certifications can be accredited by other agencies. This object captures that accreditation. For more information, see Certification Finder's Help page. Object
    Name
Name
String
    Order
Order
String
OrganizationAddress
Organization Address
String
OrganizationUrl
Organization URL
String
Acronym
Acronym
String
Description
Description
String
CertDetailList
These objects contain a wide variety of details, including whether education and training are required, whether work experience is required, whether an oral or written exam is required, and others.  Object
    Name
Name
String
    Value
Value
String
CertTestOption
Options through which a person might take the certifying exam. Values include Third Party Exam Center, Online Exam, On Site, National Conference, By Mail, and Other. Object
ExamDetail
Details concerning the exam, if any. String

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.