Job Listings by Keyword - Careeronestop



| |

|Job Listings by Keyword |

|Web service Consumption Instructions |

| |

| |

| |

| |

| |

| |

| |

| |

| |

| |

| |

| |

|[pic] |

| |

| |

|Last Revised |

|11/26/2013 |

| |

Table of Contents

1. Introduction 3

2. Background 3

3. Web service URL 3

4. Web service Example 3

4.1 Request Example 3

4.2 Response Example 4

5. Web service Parameters 5

5.1 Request Parameters Explanation 5

5.2 Response Parameters Explanation 6

6. Web service Errors 8

7. Additional Examples 9

7.1 Use case – 1 9

7.2 Use case – 2 11

Introduction

The job listing by keyword service is a RESTful API that enables developers to query and retrieve the total jobs count and jobs listing for a specific keyword or an O*NET code. The returned list object contains the number of jobs available in the area as reported by Direct Employers Association (DEA)

Background

This webservice returns the number of jobs posted for a specific keyword or an O*NET code. Jobs list is originiated from Direct Employers Association and this service internally utilizes DEA web based API.

Web service URL



Web service Example

1 Request Example

&keyword=nurse&location=20191&radius=25&sortfield=rel&sortdirection=rel&startrow=1&endrow=10&days=45

2 Response Example

[pic]

Web service Parameters

1 Request Parameters Explanation

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

|keyword |Yes |Keyword to find matching jobs. Eg: Nurse. |

| | |This field also accepts O*NET code as the keyword to find all the jobs that are coded against this |

| | |O*NET code. for. e.g., Computer Programmers, O*NET Code 15-1021.00 would be sent as “15102100.” |

|location |Yes |The location to use to determine available job postings. Acceptable values are 5-digit zip codes, |

| | |state names or 2-letter state abbreviations. For national data use the numeral “0.” |

|radius |Yes |The radius, in miles of the job opportunities search area. Applies to zip code searches only. |

|sortfield |Yes |Default sort field is “rel”. Sorts by Relevancy. |

| | |Other allowed values are jobtitle, company, location, accquisitiondate. |

|sortdirection |Yes |Default is sorted by “rel” Relevency. |

| | |Other allowed values are “asc” and “dsc” directions. |

|startrow |Yes |Specifies the start row . Allowed values are 1 to 500. Useful when implementing paging. |

|endrow |Yes |Specifies the end row . Allowed values are 1 to 500. Useful when implementing paging. |

|days |Yes |Date range to get the jobs. 2 for jobs posted in the last two days. |

| | |0 means no date range. |

2 Response Parameters Explanation

The web service returns a XML serialized “JobModule” object with general information about the request and a list of matching jobs objects.

OccupationMatchResult 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. |

|Jobs |A collection of job objects returned by the keyword search. (See Job object below) |

|jobsKWInfo |Provides information on the Keyword and the total number of jobs found. |

Error Number & Description

|Error Number |Description |

|106 |No Location Information 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 {n} job(s) – (n is number) |

|-14 |Invalid State Or ZipCode |

|-15 |ASL Geocoding Webservice Down |

|-16 |Acinet Webservice Down |

Job Object

|Name |Description |

|AccquisitionDate |The date US.jobs first provided the job through webservice. |

|Company |Company name that owns the job that is posted |

|EverGreen_YN |Flag to determine a Green job. (Provided by Us.Jobs) |

|JobCityName |City Name of the Job |

|JobId |Internal Job Id |

|JobState |State of the Job |

|JobTitle |Title of the Job |

|JobZipCode |Zipcode of the job |

|JvId |Job view id. To access jobs detailed view |

|Location |Job Location (Includes all the location elements like city, state or zipcode) |

|URL |The URL to view the job |

Web service Errors

Error codes returned from the webservice and their descriptions are described below.

|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 - 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.” | |

7. Additional Examples

7.1 Use case – 1

A user would like to see job postings for the keyword “nurse” They would like to use the zip code “20171” for the geographic center of the search and a radius of 25 miles.

Request Parameter Specifications

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

| Parameter |Value |

|userid | |

|keyword |nurse |

|location |va |

|radius |25 |

|sortfield |rel |

|sortdirection |rel |

|startrow |1 |

|endrow |2 |

|days |45 |

Request URL:



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

Response :

[pic]

7.2 Use case – 2

A user would like to see job postings for Machinists(O*NET Code: 51-4041.00). They would like to use the O*NET code instead of keyword and the zip code “55102” for the geographic center of the search and a radius of 20 miles.

Request Parameter Specifications

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

| Parameter |Value |

|userid | |

|onetcode |51404100 |

|location |55102 |

|radius |25 |

|sortfield |rel |

|sortdirection |rel |

|startrow |1 |

|endrow |2 |

|days |45 |

Request URL:



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

Response :

[pic]

-----------------------

2

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

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

Google Online Preview   Download