Reference Manual (API Version 2.0)
Reference Manual Table of Contents
All Categories
Getting started
Version infoMy Next Move Services
Search careers with key wordsMi Próximo Paso Services
Search careers with key wordsMy Next Move for Veterans Services
Search careers with key words Find careers like your military jobO*NET OnLine Services
Keyword searchTaxonomy Services
Introduction Common use cases 2010 to active Active to 2010 2019 to active Active to 2019 2010 to 2019 2019 to 2010Database Services
Introduction List of data tables Table column information Data rows Filter and sort examplesOverview
Introduction Features by category Sample code Authentication Error handling Rate limits Pagination Documentation layout OpenAPI definitionMigrating from version 1.9
Introduction Should I migrate? How do I migrate? New features Removed featuresAccount management
Introduction Important concepts Signing up for Web Services Managing your projects Other use casesBrowse careers by industry
Industry listing Careers in industry (most people) Careers in industry (some people)O*NET Interest Profiler
Short Form Questions (60-question desktop version) Mini-IP Questions (30-question mobile version) Results Job Zones Matching careers RIASEC interests Careers related to single interestCareer listings
See all careersCareer report
Career overview Knowledge Skills Abilities Personality Technology Education Job Outlook Check Out My State Explore MoreBrowse careers by industry
Industry listing Careers in industry (most people) Careers in industry (some people)O*NET Interest Profiler
Short Form Questions (60-question desktop version) Mini-IP Questions (30-question mobile version) Results Job Zones Matching careers RIASEC interests Careers related to single interestCareer listings
See all careersCareer report
Career overview Knowledge Skills Abilities Personality Education Job Outlook Check Out My State Explore MoreBrowse careers by industry
Industry listing Careers in industry (most people) Careers in industry (some people)Career listings
See all careersCareer report
Career overview In the military Knowledge Skills Abilities Personality Technology Education Job Outlook Check Out My State Explore MoreFind occupations
See all occupationsAdvanced searches
O*NET data
Browse Bright Outlook occupations
Category listing Occupations in category All Bright Outlook occupationsBrowse by Career Cluster
Cluster listing Occupations in cluster Occupations in sub-cluster Occupations in all career clustersJob duties custom list
Introduction Occupation search Tasks in occupation Related occupations for tasksProfessional associations search
Occupation search Related associations for occupation Associations across all occupationsTechnology skills search
Example search Occupations for example Category search Occupations for categorySummary report
Tasks Technology Skills Work Activities Detailed Work Activities Work Context Job Zone Apprenticeship Skills Knowledge Education Abilities Interests Work Values Work Styles Related Occupations Professional Associations Military Career SummariesDetails report
Tasks Technology Skills Tools Used Work Activities Detailed Work Activities Work Context Job Zone Apprenticeship Skills Knowledge Education Abilities Interests Work Values Work Styles Related Occupations Professional Associations Military Career SummariesCustom report
Work Activities Outline customRelated activities search
The Related Activities search consists of three steps:
- The user selects their current occupation through a keyword search.
- The user selects one or more activities from that occupation.
- Related occupations are shown which share those activities.
Occupation search
"start": 1,
"end": 6,
"total": 6,
"occupation": [
{
"href": "https://api-v2.onetcenter.org/online/related_activities/activities/29-1051.00",
"code": "29-1051.00",
"title": "Pharmacists",
"tags": {}
},
{
"href": "https://api-v2.onetcenter.org/online/related_activities/activities/31-9095.00",
"code": "31-9095.00",
"title": "Pharmacy Aides",
"tags": {}
},
...
]
}
Field | Type |
---|---|
start | integer |
end | integer |
total | integer |
prev optional | string |
next optional | string |
occupation (contains nested items) | list of objects |
href (nested at level 1) | string |
code (nested at level 1) | string |
title (nested at level 1) | string |
tags (nested at level 1) (contains nested items) | object |
bright_outlook (nested at level 2) optional | boolean |
Path parameters
Query string parameters
Key | Type | Default | Description |
---|---|---|---|
keyword required | string | (none) | search query (word, phrase, title, or code) |
start | integer | 1 | Index of first returned result |
end | integer | start + 19 | Index of last returned result |
This response implements the selection of the user’s current occupation. Like the Keyword search service, call this service with an O*NET-SOC code, job title, or key words. Each result contains a href property linking to the corresponding Activities in occupation service.
Results are divided into pages; the first 20 results are returned by default.
Activities in occupation
{
"id": "4.A.2.a.2.I05.D04",
"title": "Verify accuracy of patient information."
},
{
"id": "4.A.4.b.6.I01.D04",
"title": "Advise patients on effects of health conditions or treatments."
},
{
"id": "4.A.4.a.1.I05.D01",
"title": "Communicate detailed medical information to patients or family members."
},
...
]
Response is a list of objects
Field | Type |
---|---|
id | string |
title | string |
Path parameters
Component | Type |
---|---|
O*NET-SOC code | string |
Query string parameters
This response provides a list of detailed work activities for the requested occupation. Each result contains an id property for use in the next step of the search.
Results are divided into pages; the first 20 results are returned by default.
Related occupations for activities
"start": 1,
"end": 18,
"total": 18,
"occupation": [
{
"href": "https://api-v2.onetcenter.org/online/occupations/29-1224.00/",
"code": "29-1224.00",
"title": "Radiologists",
"tags": {},
"job_zone": {
"code": 5,
"title": "Job Zone Five: Extensive Preparation Needed"
},
"activities": {
"shared": [
{
"id": "4.A.4.a.1.I05.D01",
"title": "Communicate detailed medical information to patients or family members."
},
...
],
"similar": [
{
"id": "4.A.4.a.1.I05.D05",
"title": "Explain medical procedures or test results to patients or family members."
}
],
"full": [
{
"id": "4.A.3.b.6.I06.D04",
"title": "Prepare reports summarizing patient diagnostic or care activities."
},
...
]
}
},
...
]
}
Field | Type |
---|---|
start | integer |
end | integer |
total | integer |
prev optional | string |
next optional | string |
occupation (contains nested items) | list of objects |
href (nested at level 1) | string |
code (nested at level 1) | string |
title (nested at level 1) | string |
tags (nested at level 1) (contains nested items) | object |
bright_outlook (nested at level 2) optional | boolean |
job_zone (nested at level 1) (contains nested items) | object |
code (nested at level 2) | integer |
title (nested at level 2) | string |
activities (nested at level 1) (contains nested items) | object |
shared (nested at level 2) (contains nested items) | list of objects |
id (nested at level 3) | string |
title (nested at level 3) | string |
similar (nested at level 2) (contains nested items) | list of objects |
id (nested at level 3) | string |
title (nested at level 3) | string |
full (nested at level 2) (contains nested items) | list of objects |
id (nested at level 3) | string |
title (nested at level 3) | string |
Path parameters
Component | Type |
---|---|
O*NET-SOC code | string |
Query string parameters
Key | Type | Default | Description |
---|---|---|---|
activities required | list of strings (comma-separated) |
(none) | Activity IDs to match |
sort | string Values: shared, similar, title, code, zone |
shared | sort order |
start | integer | 1 | Index of first returned result |
end | integer | start + 19 | Index of last returned result |
This response provides occupations related to a user’s current occupation, which share one or more of the selected detailed work activities. Call the service with the O*NET-SOC code of the user’s current occupation, and a comma-separated list of the DWA IDs selected in the previous step.
Each occupation in the results includes three activity lists: activities shared with the user’s selected activities, activities similar to the selected activities, and the full list of the occupation’s detailed work activities. Some of these lists may be empty.
Results are sorted by the number of shared activities; to change this, set the sort parameter to similar, title, code, or zone. Results are divided into pages; the first 20 results are returned by default.