Occupational Licensing Web Service



CareerOneStop

Consumption Instructions: Occupational Licensing Web Service

Last Revised: May 2, 2008

Occupation Licensing Service

The Occupational Licensing Web Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to query and retrieve licensing data based on occupation code and state code. The web service has 3 methods of retrieving data: getCompleteLicenseInfo, getOccupationLicenses and getStateNFederalCt, detailed below. Refer to the following sections of this topic for more specific information for each method.

• Request Parameters

• Response Fields

• Errors

• Examples

getCompleteLicenseInfo method

This method returns detailed, complete licensing data based on occupation code and state code.

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.

|[pic]Parameter Name |Value |Required? |Description |

|soccode |String |Required |This value is the occupation code that the system will search the licensing |

| | | |database with, in addition to the parameter below. |

|stfips |String |Required |This value is the 2 digit state code that the system will search the licensing |

| | | |database with, in addition to the parameter above. |

|userID |String |Required |This value is the unique user ID provided during the CareerOneStop web services |

| | | |registration process. |

Response Fields

The response includes information about the general response, as well as specific information for each field in the response XML. The results are sorted by relevance from high to low.

General

The response includes the following information about the overall set of results in the response.

A missing node in the return data indicates no data is available

|[pic]Node |Attributes |Description |

|LicenseList |  |Root Node, contains Licenses |

| | |node |

|Licenses |  |Contains License nodes |

|License |  |Contains specific license |

| | |information below |

|LicenseID | |The numeric ID used to |

| | |differentiate the licenses |

|Name |  |Name of the license |

|Description |  |Description of the license |

|History | |History of the license |

|AgencyFullAddress |  |The name and address of the |

| | |agency issuing the license |

|AgencyName |  |The name of the agency issuing |

| | |the license |

|AgencyAddress1 |  |[pic]The first line address of |

| | |the agency that issues the |

| | |license |

|AgencyAddress2 |  |The second line address of the |

| | |agency that issues the license |

|AgencyCity |  |The city of the agency that |

| | |issues the license |

|AgencyState |  |The state where the agency that|

| | |issues the license resides |

|AgencyZip |  |The zip code of the agency that|

| | |issues the license |

|AgencyZipExtension |  |The zip code extension (if |

| | |applicable) of the agency that |

| | |issues the license |

|AgencyTelephone |  |The telephone number of the |

| | |agency that issues the license |

|AgencyTeleExtension |  |The telephone number extension |

| | |(if applicable) of the agency |

| | |that issues the license |

|AgencyEmail |  |The contact email address for |

| | |the agency that issues the |

| | |license |

|Url |  |The web URL of the agency that |

| | |issues the license |

|SocOnetCode |  |The soccode associated with the|

| | |license, this value is also an |

| | |input parameter |

|Title |  |The title of the License |

|OnetTitle |  |The title of the occu |

| | |occupation code sent in |

|AgencyStfips |  |The state FIPS code, this was |

| | |also an input parameter |

|LicenseId |  | |

|AgencyStateAbbreviation |  |The state abbreviation for the |

| | |state where the agency that |

| | |issues the license resides |

|AgencyStateName |  |The full name of the state |

| | |where the agency that issues |

| | |the license resides |

|RowNumber |  |The row number for the license |

Errors

|[pic]Error |Description |

|"Please pass the Stfips and the Soccode" |Either the Stfips or the soccode were not sent in to the web service. |

|"Please pass Stfips as a number separated |The stfips parameter must be sent in the form of a comma separated list of 2 digit numbers. |

|by comma like 01,02 or just 01" | |

|"Please pass Soccode as a number with |The soccode must be a combination of numeric digits, -, period or comma |

|either -,period or comma like 01,02 or | |

|just 01" | |

|“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 - Usage |This user’s usage limit for this service has been exceeded. |

|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]

Example Queries: getCompleteLicenseInfo Search Service

The Licensing Web Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to query and retrieve licensing data based on soccode and stfips. Refer to the following use case for an example of this service.

Use Case #1

A user would like to see complete occupational licensing data for architects in California.

Request Parameter Specifications

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

|Request Parameter |Value |

|soccode |17-1011.00 |

|stfips |06 |

|userID |123456789012345 |

Results

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

Request

POST /webservices/OccupationalLicenses/OccupationalLicensesService.asmx HTTP/1.1

Host: qa.acinet.local

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: ""

06

17-1011.00

123456789012345

Response

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

  939

  Architects (Architectural Practice)

  Fees: Application: $100 Architect Registration Examination (ARE) (national written exam) divisions: $92-multiple choice and $143-graphic. California Supplemental Exam (oral): $100 License: $200 for two years. Examination Frequency: ARE: on computer, Monday-Saturday at most locations (@ 24 locations throughout California). California Supplemental Exam: six times each year. Exam Locations: ARE: approximately 24 locations throughout California and locations across United States and in Canada. California Supplemental Exam: usually Irvine and South San Francisco/Burlingame. Experience Requirement: ARE: five years education and/or experience under direct supervision of architect. California Supplemental Exam: seven and one-half years education and/or work experience. Licensure: eight years education and/or work experience. Average Time to Process Application: One month for Application for Eligibility Evaluation. Renewal Period: Biennially (every second year). Authority: Business and Professions Code, Sections 5500-5610.7. California Code of Regulations, Title 16, Chapter 2, Sections 100-160. Special License Requirements: Compliance with local license requirements and United States and state tax requirements. Exceptions for license are listed in Business & Professions Code, Section 5537 which paraphrased are: 1) single family woodframe construction not more than two stories and basement in height; 2) multiple dwelling containing no more than four dwelling units of woodframe construction not more than two stories and basement in height (this does not authorize an unlicensed person to design multiple clusters up to four dwelling units each to form an apartment or condominium complex when the total exceeds four units on any lawfully divided lot); 3) garages or other structures appurtenant to buildings described under 1) which are of woodframe construction; and 4) agricultural and ranch building of woodframe construction (unless a public official with jurisdiction holds that the structure presents undue risk to public health and safety or welfare). NOTE: If any portion of exempted structure deviates from conventional framing or codes, local building officials are to require plans, specifications, or calculations or have construction under the direct supervision of a licensee. Documents must have stamp and signature of a licensee. Comments: N/A

 

  17-1011.00

  Architects (Architectural Practice)

  Architects, Except Landscape and Naval

  1

  Department of Consumer Affairs California Architects Board

  Department of Consumer Affairs California Architects Board ,400 R Street, Suite 4000,Sacramento,CA 95814,9164453393,

  400 R Street, Suite 4000

 

  Sacramento

  CA

  95814

 

  9164453393

 

 

  06

  CA

  California

 

 

 

getOccupationLicenses method

This method returns occupational licensing data based on occupation code and state FIPS code.

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.

|[pic]Parameter Name |Value |Required? |Description |

|soccode |String |Required |This value is the occupation code that the system will search the licensing |

| | | |database with, in addition to the parameters below. |

|stfips |String |Required |This value is the 2 digit state code that the system will search the licensing |

| | | |database with, in addition to the parameter above. |

|userID |String |Required |This value is the unique user ID provided during the CareerOneStop web services |

| | | |registration process. |

Response Fields

The response includes information about the general response, as well as specific information for each field in the response XML. The results are sorted by relevance from high to low.

General

The response includes the following information about the overall set of results in the response.

|[pic]Node |Attributes |Description |

|LicenseList |  |Root Node, contains Licenses |

| | |node |

|Licenses |  |Contains License nodes |

|License |  |Contains specific license |

| | |information below |

|LicenseID | |The numeric ID used to |

| | |differentiate the licenses |

|Name |  |Name of the license |

|Description |  |Description of the license |

|History | |History of the license |

|AgencyFullAddress |  |The name and address of the |

| | |agency issuing the license |

|AgencyName |  |The name of the agency issuing |

| | |the license |

|AgencyAddress1 |  |[pic]The first line address of |

| | |the agency that issues the |

| | |license |

|AgencyAddress2 |  |The second line address of the |

| | |agency that issues the license |

|AgencyCity |  |The city of the agency that |

| | |issues the license |

|AgencyState |  |The state where the agency that|

| | |issues the license resides |

|AgencyZip |  |The zip code of the agency that|

| | |issues the license |

|AgencyZipExtension |  |The zip code extension (if |

| | |applicable) of the agency that |

| | |issues the license |

|AgencyTelephone |  |The telephone number of the |

| | |agency that issues the license |

|AgencyTeleExtension |  |The telephone number extension |

| | |(if applicable) of the agency |

| | |that issues the license |

|AgencyEmail |  |The contact email address for |

| | |the agency that issues the |

| | |license |

|Url |  |The web URL of the agency that |

| | |issues the license |

|SocOnetCode |  |The soccode associated with the|

| | |license, this value is also an |

| | |input parameter |

|Title |  |The title of the License |

|OnetTitle |  |The title of the occu |

| | |occupation code sent in |

|AgencyStfips |  |The state FIPS code, this was |

| | |also an input parameter |

|LicenseId |  | |

|AgencyStateAbbreviation |  |The state abbreviation for the |

| | |state where the agency that |

| | |issues the license resides |

|AgencyStateName |  |The full name of the state |

| | |where the agency that issues |

| | |the license resides |

|RowNumber |  |The row number for the license |

Errors

|[pic]Error |Description |

|"Please pass the Stfips and the Soccode" |Either the Stfips or the soccode were not sent in to the web service. |

|"Please pass Stfips as a number separated |The stfips parameter must be sent in the form of a comma separated list of 2 digit numbers. |

|by comma like 01,02 or just 01" | |

|"Please pass Soccode as a number with |The soccode must be a combination of numeric digits, -, period or comma |

|either -,period or comma like 01,02 or | |

|just 01" | |

|“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 - Usage |This user’s usage limit for this service has been exceeded. |

|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]

Example Queries: getOccupationLicenses Search Service

The Licensing Web Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to query and retrieve occupational licensing data based on soccode and state FIPS code. Refer to the following use case for an example of this service.

Use Case #1

A user would like to see occupational licensing data for architects in California (which is stfips 06).

Request Parameter Specifications

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

|Request |Value |

|Parameter | |

|soccode |17-2051.00 |

|stfips |06 |

|userID |123456789012345 |

Results

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

Request

POST /webservices/OccupationalLicenses/OccupationalLicensesService.asmx HTTP/1.1

Host: qa.acinet.local

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: ""

06

17-2051.00

123456789012345

Response

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

  7693

  17-2051.00

  Civil Engineer

  Civil Engineers

  1

  Department of Consumer Affairs Board of Professional Engineers & Land Surveyors

  2535 Capital Oaks Drive, Suite 300

 

  Sacramento

  CA

  95833

  2944

  9162632222

 

  06

CA

California

 

  766

  17-2051.00

  Geotechnical Engineer

  Civil Engineers

  2

  Department of Consumer Affairs Board of Professional Engineers & Land Surveyors

  2535 Capital Oaks Drive, Suite 300

 

  Sacramento

  CA

  95833

  2944

  9162632222

 

  06

  CA

  California

 

  770

  17-2051.00

  Structural Engineer

  Civil Engineers

  3

  Department of Consumer Affairs Board of Professional Engineers & Land Surveyors

  2535 Capital Oaks Drive, Suite 300

 

  Sacramento

  CA

  95833

  2944

  9162632222

 

  06

  CA

  California

 

  7695

  17-2051.00

  Traffic Engineer

Civil Engineers

  4

  Department of Consumer Affairs Board of Professional Engineers & Land Surveyors

2535 Capital Oaks Drive, Suite 300

 

  Sacramento

CA

  95833

  2944

9162632222

 

  06

  CA

  California

 

 

 

getStateNFederalCt method

This method returns the number of state and federal licenses based on occupation code and state FIPS code.

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.

|[pic]Parameter Name |Value |Required? |Description |

|soccode |String |Required |This value is the occupation code that the system will search the licensing |

| | | |database with, in addition to the parameters below. |

|stfips |String |Required |This value is the 2 digit state code that the system will search the licensing |

| | | |database with, in addition to the parameter above. |

|userID |String |Required |This value is the unique user ID provided during the CareerOneStop web services |

| | | |registration process. |

Response Fields

The response includes information about the general response, as well as specific information for each field in the response XML. The results are sorted by relevance from high to low.

General

The response includes the following information about the overall set of results in the response.

|[pic]Node |Attributes |Description |

|LicensesCount |  |Root Node, Contains Occupation Node(s) |

|Occupations | |Contains all Occupation nodes |

|Occupation |  |Contains the nodes below |

|OnetCode |  |The onetCode that was passed in |

|StateLicenseCount |  |The number of state licenses for this |

| | |occupation code and state |

|FederalLicenseCount |  |The number of federal licenses for this |

| | |occupation code |

Errors

|[pic]Error |Description |

|"Please pass the Stfips and the Soccode" |Either the stfips or the soccode passed in were empty. |

|“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 - Usage |This user’s usage limit for this service has been exceeded. |

|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]

Example Queries: getStateNFederalCt Search Service

The Licensing Web Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to query and retrieve the number of state and federal licenses based on soccode and state FIPS code. Refer to the following use case for an example of this service.

Use Case #1

A user would like to see the number of state and federal licenses for architects for the state of California (which is stfips 06).

Request Parameter Specifications

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

|Request |Value |

|Parameter | |

|soccode |17-2051.00 |

|stfips |06 |

|userID |123456789012345 |

Results

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

Request

POST /webservices/OccupationalLicenses/OccupationalLicensesService.asmx HTTP/1.1

Host: qa.acinet.local

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: ""

06

17-2051.00

123456789012345

Response

HTTP/1.1 200 OK

Content-Type: text/xml; charset=utf-8

Content-Length: length

  17-2051.00

  4

  0

 

 

 

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

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

Google Online Preview   Download