Occupation Keyword Search



CareerOneStop

Consumption Instructions: Get Occupational License Details

Last Revised: October 19, 2010

Get Occupational License Details

The Get Occupational License Details Service is a RESTful API that enables developers to query and retrieve occupational license details. Refer to the following sections more specific information:

• Request Parameters

• Response Fields

• Errors

• Examples

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 |Required |Description |

|userid |Yes |This value is the unique user ID provided during the CareerOneStop web services registration|

| | |process. |

|onetcode |Yes |This is the O*NET code of the occupation to find matches for. e.g., Computer Programmers, |

| | |O*NET Code 15-1021.00 would be sent as “15102100.” |

|licenseid |Yes |ID of the license to retrieve details. |

|location |Yes |The location to use to find licenses. Acceptable values are 5-digit zip codes, state names |

| | |or 2-letter state abbreviations. |

Response Fields

The web service returns a XML serialized “Licenses” with general information about the request and a matching LicenseDetails object.

Licenses Object

|Name |Description |

|ErrorMessage |If there was a problem processing the request a message describing the error is returned. If the |

| |request was completed without error “Success” is returned. |

|ErrorNumber |Refer Error Number & Description section for more information |

|LiceOnetTable |Always null for this method |

|LicenseDetails |Object containing details about the selected license. See LicenseDetails object below. |

|LicenseList |Always null for this method |

Error Number & Description

|Error Number |Description |

|106 |No Location Information Found |

|105 |No Apprenticeship Found |

|104 |No Licenses Found |

|103 |No Certfications Found |

|102 |No Training Found |

|101 |No Occupation Matches Found |

|100 |No Jobs Found |

|0 |Success |

|-1 |Database Unavailable |

|-2 |Endeca Unavailable |

|-3 |Unknow Error |

|-4 |Invalid OnetCode |

|-5 |Invalid Zipcode |

|-6 |Invalid State |

|-7 |Job Central Not Available |

|-8 |Job Central TimedOut |

|-9 |Database Error |

|-10 |No Record Found |

|-11 |Invalid Number Format |

|-12 |Invalid Distance |

|-13 |Job Count is not available for {0} job(s) |

|-14 |Invalid State Or ZipCode |

|-15 |ASL Geocoding Webservice Down |

|-16 |Acinet Webservice Down |

LicenseDetails Object

|Name |Description |

|ABBREV |Abbreviation of the State where the license is available |

|ADDRESS1 |Address line 1 of the agency offering the license |

|ADDRESS2 |Address line 2 of the agency offering the license |

|CITY |City of the licensing agency |

|DESCRIPTION |Description of the license |

|EMAIL |Email address of the licensing agency |

|LICENSEAGENGY |Name of the licensing agency |

|LICTITLE |Title of the license |

|ONETTITLE |O*NET title of the O*NET code associated with the license |

|RNUM |Index of the licence within the result set |

|SOCONETCOD |O*NET code associated with the license |

|STATE |Abbreviation of the State where the license is available |

|STFIPS |STFIPS code of the State where the license is available |

|STNAME |Name of State where the license is available |

|TELEEXT |Telephone number extension of the licensing agency |

|TELEPHONE |Telephone number of the licensing agency |

|URL |Link the the licensing agency’s website |

|ZIP |Zip code of the licensing agency |

|ZIPEXT |Zip code extension of the licensing agency |

General Web Service Errors (Returned in a standalone error node)

|[pic]Error |Description |

|“Invalid user ID” |The userid is not in the proper format. A user ID should be 15 alpha-numeric characters. |

|“Access to the Service Denied - This|This service has been suspended by CareerOneStop. |

|service has been suspended.” | |

|“Access to the Service Denied - This|This service has not yet become active or has expired. |

|service is not valid at this time.” | |

|“Access to the Service Denied - This|This service could not be found in CareerOneStop system. |

|service cannot be found.” | |

|“Access to the Service Denied - |This user’s usage limit for this service has been exceeded. |

|Usage limit exceeded.” | |

|“Access to the Service Denied - |This user’s subscription for this service has expired. |

|Subscription has expired.” | |

|“Access to the Service Denied - |This user’s subscription for this service has not yet become valid. |

|Subscription is not yet valid.” | |

|“Access to Service Denied - No valid|No subscription was found for this user ID and service. |

|subscription found.” | |

[pic]

Usage Example: Get Occupational License Details

Use Case #1

A user would like to see occupational license details for Registered Nurses (O*NET Code: 29-1111.00) inthe state of Pensylvania with the license id of 0000000033.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

|Parameter |Value |

|userid |012345678901234 |

|onetcode |29111100 |

|licenseid |0000000033 |

|location |pa |

Request URL:



Refer to the following for an example (code example) of results for the request parameters specified above.

| |

|Success |

|0 |

| |

| |

|PA |

|116 Pine Street |

| |

|Harrisburg |

|A registered nurse licensed in this Commonwealth who is certified by the boards in a particular clinical specialty |

|area and who, while functioning in the expanded role as a professional nurse, performs acts of medical diagnosis or prescription of|

|medical therapeutic or corrective measures in collaboration with and under the direction of a physician licensed to practice in |

|this Commonwealth. |

| |

|Department of State Bureau of Professional and Occupational |

|Affairs Nursing Board |

| |

|0000000033 |

|Certified Registered Nurse Practitioner |

|Department of State Bureau of Professional and |

|Occupational Affairs Nursing Board |

| |

|Certified Registered Nurse Practitioner |

|Registered Nurses |

|1 |

|29-1111.00 |

|PA |

|42 |

|Pennsylvania |

| |

|7177837142 |

| |

| |

|17101 |

| |

| |

| |

| |

................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download