Instructions for Consuming One Stop Centers Web Services



CareerOneStop

Consumption Instructions: Find a One Stop Center Web Service

Last Revised: July 28, 2009

One Stop Service Centers Search Web Service

The One Stop Service Centers Search Web Service provides a SOAP-based (Simple Object Access Protocol) API that enables users to query and retrieve One Stop Service Centers data from ASL database. The web service exposes two methods, getOfficesByZip and getOfficesByCity, to clients to retrieve One Stop Service Centers information either by zip code, or city and state, as specified in detail below.

For each method, please refer to the corresponding sections for more specific information, regarding:

• Request Parameters

• Response Fields

• Exception Handling

• Example

getOfficesByZip method

This method returns detailed, complete One Stop Service Centers information based on request parameters passed into web method, in zip code, state, type of service, and distance from that zip code.

Request Parameters

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

|ZIP |Numeric |Required |5 digit zip code. |

|STATE |String |Optional |2 characters state abbreviation |

|OTYPE |Numeric |Required |For One Stop Centers, the value is 1 |

|DISTANCE |Numeric |Required |Distance from user specified zip code |

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

| | | |registration process. |

Response Fields

The response contains 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 contains the following information about results in the response.

|[pic]Node |Attributes |Description |

|getOfficesByZipResult |  |Root Node, contains resulting One|

| | |Stop Service Center Data |

|NewDataSet |  |Contains Two child nodes, Detail |

| | |and Info |

|Detail |  |Detailed information of One Stop |

| | |Service Center, contains child |

| | |nodes below |

|ID |  |Numeric Identifier of Current |

| | |Center |

|LAST_UPDATED |  |Last Update Date |

|NAME |  |The name of One Stop Service |

| | |Center data |

|WEB_SITE_URL |  |Web Site URL of this One Stop |

| | |Service Center |

|ADDRESS_1 |  |Street number, street name and |

| | |type of street |

|ADDRESS_2 |  |Building, Floor, Suite Number, PO|

| | |BOX etc |

|CITY |  |The city where this One Stop |

| | |Service Center Located |

|STATE |  |The state where this One Stop |

| | |Service Center Located |

|ZIP |  |The zip code where this One Stop |

| | |Service Center Located |

|PHONE |  |The phone number of this One Stop|

| | |Service Center |

|FAX |  |The FAX number of this One Stop |

| | |Service Center |

|OFFICE_HOURS |  |The operational hours of this One|

| | |Stop Service Center |

|EMAIL_ADDRESS |  |Contact email address for this |

| | |One Stop Service Center |

|BRIEF_DESCRIPTION |  |Brief description about this One |

| | |Stop Service Center |

|PROGRAM_TYPE |  |1 – Affiliate One Stop Service |

| | |Center |

| | |2 – Comprehensive One Stop |

| | |Service Center |

|LATITUDE |  |The latitude of location of this |

| | |One Stop Service Center |

|LONGITUDE |  |The longitude of location of this|

| | |One Stop Service Center |

|TEMP_CLOSURE_YN |  |Y – Service Center temporarily |

| | |closed |

| | |N – Service Center open |

|DIST |  |The distance in miles from zip |

| | |code passed into the method |

|Info |  |The summary of result, contains |

| | |child nodes as below |

|OTYPE |  |Parameter OTYPE passed into the |

| | |method |

|STATE | |Matched STATE with the value of |

| | |parameter ZIP passed into the |

| | |method |

|ZIP | |Parameter ZIP passed into this |

| | |method |

|INDUSTRY | |NA for One Stop Service Center |

| | |data |

|TOTLE | |TOTAL number of One Stop Service |

| | |Centers data |

|SPECIFIC |  |SPECIFIC number for a particular |

| | |industry, for One Stop Service |

| | |Center, this number is same as |

| | |TOTLE number |

| | | |

Specification of Errors

|[pic]Error |Description |

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

|“NoData Found!” |The web service was unable to retrieve any data. |

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

The One Stop Service Centers Search Web Service provides a SOAP-based (Simple Object Access Protocol) API that enables users to query and retrieve One Stop Service Centers data from ASL database.

Use Case #1

Locate One Stop Service Centers close by a zip code.

Request Parameter Specifications

Please refer to the following table for required parameters:

|Required Parameter |Value |

|ZIP |20191 |

|STATE |VA |

|OTYPE |1 |

|DISTANCE |10 |

|userID |123456789012345 |

Sample SOAP Request and Response

Please refer to the following examples:

SOAP Request

POST /wservices/CVServices.asmx HTTP/1.1

Host:

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

Content-Length: length

SOAPAction: " "

20191

VA

1

10

123456789012345

SOAP Response

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

< getOfficesByZipResponse xmlns="">

19313

2000-11-15T09:23:18-05:00

68

2007-02-22T12:29:01-05:00

516

Fairfax Workforce Service Center

13135 Lee Jackson Highway

Suite 340

Fairfax

VA

22033

703-803-0000

703-803-0042

8:30-4:30 Mon, Tue, Thu & Fri 9:00-4:30 Wed EDT

703-803-0075

fairfax@vec.virginia.us

Joe Smith - Manager Employment Service &

Unemployment Insurance

Special dispensations apply to individuals out of

work as a result of the attack on 9/11.

Unemployment benefits may range from $50 to $368

for a 12 to 26 weeks. Amount determined by wages

earned during base period. See office for details.

A veterans representative is available at this office.

1

Local

1

13135 LEE JACKSON MEMORIAL HWY<br>FAIRFAX, VA 22033

38.88190041955310

-77.40011445615830

S5HPNTSCZA

ACTIVE

N

5.10

32452368

2005-11-16T07:48:32-05:00

68

2007-05-11T10:15:47-04:00

508

Lake Anne SkillSource Affiliate Center



11484 Washington Plaza West

Suite 110

Reston

VA

20190

703-787-4974

703-787-9232

8 a.m.-4:30 p.m. Mon-Thu; 10 a.m.-4:30 p.m. Fri

703-742-0350

jane.brill@

The Center provides job search assistance, skills assessment, resume preparation, practice interviewing, career training, labor market information, job fairs and business service information.

A veterans representative is available with an appointment.

1

Local

1

11484 WASHINGTON PLZ W<br>RESTON, VA 20190

38.96829242553360

-77.34282637269470

S5HPNTSCZA

ACTIVE

N

2.20

1

VA

20191

2

2

getOfficesByCity method

This method returns detailed, complete One Stop Service Centers information based on request parameters passed into web method, in city, state, type of service, and distance from center of the city.

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 |

|CITY |String |Required |City Name. |

|STATE |String |Required |2 characters state abbreviation |

|OTYPE |Numeric |Required |For One Stop Centers, the value is 1 |

|DISTANCE |Numeric |Required |Distance from user specified city |

|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 results in the response.

|[pic]Node |Attributes |Description |

|getOfficesByCityResult |  |Root Node, contains resulting |

| | |One Stop Service Center Data |

|NewDataSet |  |Contains Two child nodes, Detail|

| | |and Info |

|Detail |  |Detailed information of One Stop|

| | |Service Center, contains child |

| | |nodes below |

|ID |  |Numeric Identifier of Current |

| | |Center |

|LAST_UPDATED |  |Last Update Date |

|NAME |  |The name of One Stop Service |

| | |Center data |

|WEB_SITE_URL |  |Web Site URL of this One Stop |

| | |Service Center |

|ADDRESS_1 |  |Street number, street name and |

| | |type of street |

|ADDRESS_2 |  |Building, Floor, Suite Number, |

| | |PO BOX etc |

|CITY |  |The city where this One Stop |

| | |Service Center Located |

|STATE |  |The state where this One Stop |

| | |Service Center Located |

|ZIP |  |The zip code where this One Stop|

| | |Service Center Located |

|PHONE |  |The phone number of this One |

| | |Stop Service Center |

|FAX |  |The FAX number of this One Stop |

| | |Service Center |

|OFFICE_HOURS |  |The operational hours of this |

| | |One Stop Service Center |

|EMAIL_ADDRESS |  |Contact email address for this |

| | |One Stop Service Center |

|BRIEF_DESCRIPTION |  |Brief description about this One|

| | |Stop Service Center |

|PROGRAM_TYPE |  |1 – Affiliate One Stop Service |

| | |Center |

| | |2 – Comprehensive One Stop |

| | |Service Center |

|LATITUDE |  |The latitude of location of this|

| | |One Stop Service Center |

|LONGITUDE |  |The longitude of location of |

| | |this One Stop Service Center |

|TEMP_CLOSURE_YN |  |Y – Service Center temporarily |

| | |closed |

| | |N – Service Center open |

|DIST |  |The distance in miles from the |

| | |center of CITY passed into the |

| | |method |

|Info |  |The summary of result, contains |

| | |child nodes as below |

|OTYPE |  |Parameter OTYPE passed into the |

| | |method |

|STATE | |Matched STATE with the value of |

| | |parameter ZIP passed into the |

| | |method |

|ZIP | |Parameter ZIP passed into this |

| | |method |

|INDUSTRY | |NA for One Stop Service Center |

| | |data |

|TOTLE | |TOTAL number of One Stop Service|

| | |Centers data |

|SPECIFIC |  |SPECIFIC number for a particular|

| | |industry, for One Stop Service |

| | |Center, this number is same as |

| | |TOTLE number |

| | | |

Specification of Errors

|[pic]Error |Description |

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

|“NoData Found!” |The web service was unable to retrieve any data. |

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

The One Stop Service Centers Search Web Service provides a SOAP-based (Simple Object Access Protocol) API that enables users to query and retrieve One Stop Service Centers data from ASL database.

Use Case #1

Locate One Stop Service Centers close by the center of a city.

Request Parameter Specifications

Please refer to the following table for required parameters:

|Required Parameter |Value |

|CITY |Fairfax |

|STATE |VA |

|OTYPE |1 |

|DISTANCE |10 |

|userID |123456789012345 |

Sample SOAP Request and Response

Please refer to the following examples:

SOAP Request

POST /wservices/CVServices.asmx HTTP/1.1

Host:

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

Content-Length: length

SOAPAction: " "

Fairfax

VA

1

10

123456789012345

SOAP Response

HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: length

< getOfficesByCityResponse xmlns="">

1743599

2002-03-13T13:21:44-04:00

68

2007-04-04T09:44:22-04:00

68

Alexandria Workforce Center - VEC



5520 Cherokee Avenue

Alexandria

VA

22312-2319

703-813-1300

703-813-1380

8:30-4:30 Mon, Tue, Thu, Fri 9:00-4:30 Wed

alexandria@vec.

Employment Services and Unemployment Insurance

A veterans representative is available at this location.

1

Local

1

5520 CHEROKEE AVE<br>ALEXANDRIA, VA 22312

38.80504812340750

-77.16691601195310

S5HPNTSCZA

ACTIVE

N

9.80

19313

2000-11-15T09:23:18-05:00

68

2007-02-22T12:29:01-05:00

516

Fairfax Workforce Service Center

13135 Lee Jackson Highway

Suite 340

Fairfax

VA

22033

703-803-0000

703-803-0042

8:30-4:30 Mon, Tue, Thu & Fri 9:00-4:30 Wed EDT

703-803-0075

fairfax@vec.virginia.us

Joe Smith - Manager Employment Service &

Unemployment Insurance

Special dispensations apply to individuals out of

work as a result of the attack on 9/11.

Unemployment benefits may range from $50 to $368

for a 12 to 26 weeks. Amount determined by wages

earned during base period. See office for details.

A veterans representative is available at this office.

1

Local

1

13135 LEE JACKSON MEMORIAL HWY<br>FAIRFAX, VA 22033

38.88190041955310

-77.40011445615830

S5HPNTSCZA

ACTIVE

N

7.20

32452368

2005-11-16T07:48:32-05:00

68

2007-05-11T10:15:47-04:00

508

Lake Anne SkillSource Affiliate Center



11484 Washington Plaza West

Suite 110

Reston

VA

20190

703-787-4974

703-787-9232

8 a.m.-4:30 p.m. Mon-Thu; 10 a.m.-4:30 p.m. Fri

703-742-0350

jane.brill@

The Center provices job search assistance, skills assessment, resume preparation, practice interviewing, career training, labor market information, job fairs and business service information.

A veterans representative is available with an appointment.

1

Local

1

11484 WASHINGTON PLZ W<br>RESTON, VA 20190

38.96829242553360

-77.34282637269470

S5HPNTSCZA

ACTIVE

N

8.50

1

VA

3

3

XML Schema Description

 

-

-

-

-

-

-

-

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

-

-

-

 

 

 

 

 

 

 

 

 

 

 

 

 

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

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

Google Online Preview   Download