{ "openapi": "3.1.0", "info": { "title": "O*NET Web Services API", "version": "2.0.0" }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" } }, "responses": { "UnauthorizedError": { "description": "API key is missing or invalid", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } } }, "ParameterError": { "description": "Parameter is missing or invalid", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string" } }, "required": [ "error" ], "additionalProperties": false } } } } }, "schemas": { "ServiceReference": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false }, "ServiceList": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceReference" } } } }, "security": [ { "ApiKeyAuth": [] } ], "paths": { "/veterans/search": { "parameters": [], "get": { "description": "Search careers with key words", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/military": { "parameters": [], "get": { "description": "Find careers like your military job", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "military_match": { "type": "array", "items": { "properties": { "branch": { "type": "string", "enum": [ "all", "air_force", "army", "coast_guard", "marine_corps", "navy", "space_force" ] }, "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" }, "external_info": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } }, "required": [ "branch", "code", "title", "active" ], "additionalProperties": false } }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "match_type": { "type": "string", "enum": [ "most_duties", "some_duties", "crosswalk", "keyword" ] }, "preparation_needed": { "type": "string" }, "pay_grade": { "type": "string" } }, "required": [ "href", "code", "title", "tags", "match_type" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (military code or title)" }, { "name": "branch", "in": "query", "schema": { "type": "string", "enum": [ "all", "air_force", "army", "coast_guard", "marine_corps", "navy", "space_force" ], "default": "all" }, "description": "limit results to branch" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/job_preparation/": { "parameters": [], "get": { "description": "Careers sorted by Job Preparation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/veterans/interests/": { "parameters": [], "get": { "description": "Careers sorted by Interests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/veterans/industries/": { "parameters": [], "get": { "description": "Browse careers by industry", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "most_people": { "type": "string" }, "some_people": { "type": "string" }, "code": { "type": "integer", "minimum": 1 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/veterans/careers/": { "parameters": [], "get": { "description": "See all careers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/career_clusters/": { "parameters": [], "get": { "description": "Browse careers by cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "cluster_grouping": { "type": "string" } }, "required": [ "href", "code", "title", "cluster_grouping" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/veterans/bright_outlook/": { "parameters": [], "get": { "description": "Careers with a Bright Outlook", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/veterans/": { "parameters": [], "get": { "description": "My Next Move for Veterans services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/taxonomy/": { "parameters": [], "get": { "description": "O*NET-SOC Taxonomy services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/technology/examples/search": { "parameters": [], "get": { "description": "Technology example search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" } }, "required": [ "title", "href" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "example" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word or phrase)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/technology/categories/search": { "parameters": [], "get": { "description": "Technology category search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "category": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "href": { "type": "string" } }, "required": [ "code", "title", "href" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "category" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word or phrase)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/technology/": { "parameters": [], "get": { "description": "Technology Skills Search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/stem_occupations/all": { "parameters": [], "get": { "description": "Occupations in STEM type", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_family": { "properties": { "code": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "stem_occupation_type": { "type": "array", "items": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [ "href", "code", "title", "tags", "job_family", "stem_occupation_type" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "job_family", "in": "query", "schema": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "description": "filter by job family" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "job_family", "title", "code", "stem_occupation_type" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/stem_occupations/": { "parameters": [], "get": { "description": "Browse STEM Occupations", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "job_family": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } }, "required": [ "href", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/soft_skills/results": { "parameters": [], "get": { "description": "Occupations with related skills", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "skills_matched": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "skills_other": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [ "href", "code", "title", "tags", "job_zone", "skills_matched", "skills_other" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "skills", "in": "query", "schema": { "type": "array", "items": { "type": "string", "pattern": "^2\\.[AB]\\.\\d\\.[a-z]$" } }, "style": "form", "explode": false, "required": true, "description": "Skill codes to match" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "skills_covered", "my_matches", "title", "code", "zone" ], "default": "skills_covered" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/soft_skills/": { "parameters": [], "get": { "description": "Soft Skills Custom List", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "social": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } } }, "required": [ "code", "title", "description", "example" ], "additionalProperties": false } }, "thinking": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } } }, "required": [ "code", "title", "description", "example" ], "additionalProperties": false } } }, "required": [ "social", "thinking" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/search": { "parameters": [], "get": { "description": "Keyword search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/related_activities/search": { "parameters": [], "get": { "description": "Occupation search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/related_activities/": { "parameters": [], "get": { "description": "Related Activities Search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/work_styles/": { "parameters": [], "get": { "description": "Browse by Work Styles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/work_context/": { "parameters": [], "get": { "description": "Browse by Work Context", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/work_activities/": { "parameters": [], "get": { "description": "Browse by Work Activities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/skills_cf/": { "parameters": [], "get": { "description": "Browse by Cross-Functional Skills", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/skills_basic/": { "parameters": [], "get": { "description": "Browse by Basic Skills", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/knowledge/": { "parameters": [], "get": { "description": "Browse by Knowledge", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/interests/": { "parameters": [], "get": { "description": "Browse by Interests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "interest_code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "href", "id", "interest_code", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/abilities/": { "parameters": [], "get": { "description": "Browse by Abilities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "child": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/onet_data/": { "parameters": [], "get": { "description": "Browse by O*NET Data services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/occupations/": { "parameters": [], "get": { "description": "See All Occupations", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "datalevel": { "type": "boolean" }, "zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "datalevel" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code", "zone" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/job_zones/all": { "parameters": [], "get": { "description": "Occupations in all job zones", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code", "job_zone" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/job_zones/": { "parameters": [], "get": { "description": "Browse by Job Zone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/job_families/all": { "parameters": [], "get": { "description": "Occupations in all job families", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_family": { "properties": { "code": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_family" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code", "family" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/job_families/": { "parameters": [], "get": { "description": "Browse by Job Family", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/job_duties/search": { "parameters": [], "get": { "description": "Occupation search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/job_duties/": { "parameters": [], "get": { "description": "Job Duties Custom List", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/industries/all": { "parameters": [], "get": { "description": "Occupations in industry", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "industry_data_from": { "type": "string" }, "percent_employed_by_industry": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "percent": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "code", "title" ], "additionalProperties": false } }, "projected_growth": { "type": "string" }, "projected_openings": { "type": "integer" } }, "required": [ "href", "code", "title", "tags", "percent_employed_by_industry", "projected_growth", "projected_openings" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code", "growth", "openings" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/industries/": { "parameters": [], "get": { "description": "Browse by Industry", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 10, "maximum": 99 }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/hot_technology/": { "parameters": [], "get": { "description": "Hot Technologies", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" }, "job_postings": { "type": "integer", "minimum": 0 } }, "required": [ "href", "title", "job_postings" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "job_postings", "title" ], "default": "job_postings" }, "description": "sort order" } ] } }, "/online/crosswalks/SOC": { "parameters": [], "get": { "description": "SOC crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "code", "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/RAPIDS": { "parameters": [], "get": { "description": "RAPIDS crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "code", "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/occupation_handbook": { "parameters": [], "get": { "description": "Occupation Handbook crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/military": { "parameters": [], "get": { "description": "Military crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "code", "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "branch", "in": "query", "schema": { "type": "string", "enum": [ "all", "air_force", "army", "coast_guard", "marine_corps", "navy", "space_force" ], "default": "all" }, "description": "military branch" }, { "name": "active", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "true" }, "description": "return codes in active use" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/ESCO": { "parameters": [], "get": { "description": "ESCO crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "code", "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/education": { "parameters": [], "get": { "description": "Education crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "code", "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/DOT": { "parameters": [], "get": { "description": "DOT crosswalk search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "match": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "code", "title", "occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "match" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (title or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/crosswalks/": { "parameters": [], "get": { "description": "Crosswalk services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/career_clusters/all": { "parameters": [], "get": { "description": "Occupations in all clusters", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "career_cluster": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } }, "sub_cluster": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } }, "required": [ "href", "code", "title", "tags", "career_cluster", "sub_cluster" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "cluster", "sub_cluster", "title", "code" ], "default": "cluster" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/career_clusters/": { "parameters": [], "get": { "description": "Browse by Career Cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "cluster_grouping": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/bright_outlook/all": { "parameters": [], "get": { "description": "Occupations in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "category": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [ "href", "code", "title", "tags", "category" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/bright_outlook/": { "parameters": [], "get": { "description": "Browse Bright Outlook Occupations", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/associations/search": { "parameters": [], "get": { "description": "Occupation search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/associations/all": { "parameters": [], "get": { "description": "Associations related to any O*NET-SOC occupation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "association": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "ally": { "type": "boolean" } }, "required": [ "title", "url", "ally" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "association" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "ally", "title", "related_occupation" ], "default": "ally" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/associations/": { "parameters": [], "get": { "description": "Professional Associations Search", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/online/": { "parameters": [], "get": { "description": "O*NET OnLine services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/search": { "parameters": [], "get": { "description": "Search careers with key words", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/job_preparation/": { "parameters": [], "get": { "description": "Careers sorted by Job Preparation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/interests/": { "parameters": [], "get": { "description": "Careers sorted by Interests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/interestprofiler/results": { "parameters": [], "get": { "description": "Interest Profiler results", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "careers": { "type": "string" }, "result": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "score": { "type": "integer", "minimum": 0 } }, "required": [ "href", "code", "title", "description", "score" ], "additionalProperties": false } } }, "required": [ "result" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "answers", "in": "query", "schema": { "type": "string", "pattern": "^[12345]{30}([12345]{30})?$" }, "required": true, "description": "answers to Interest Profiler question list" } ] } }, "/mpp/interestprofiler/questions_30": { "parameters": [], "get": { "description": "Interest Profiler questions (mobile)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "answer_option": { "type": "array", "items": { "properties": { "value": { "type": "integer", "minimum": 1, "maximum": 5 }, "name": { "type": "string" } }, "required": [ "value", "name" ], "additionalProperties": false } }, "question": { "type": "array", "items": { "properties": { "index": { "type": "integer", "minimum": 1 }, "area": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "text": { "type": "string" } }, "required": [ "index", "area", "text" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "answer_option", "question" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/interestprofiler/questions": { "parameters": [], "get": { "description": "Interest Profiler questions (desktop)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "answer_option": { "type": "array", "items": { "properties": { "value": { "type": "integer", "minimum": 1, "maximum": 5 }, "name": { "type": "string" } }, "required": [ "value", "name" ], "additionalProperties": false } }, "question": { "type": "array", "items": { "properties": { "index": { "type": "integer", "minimum": 1 }, "area": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "text": { "type": "string" } }, "required": [ "index", "area", "text" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "answer_option", "question" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/interestprofiler/job_zones": { "parameters": [], "get": { "description": "Interest Profiler Job Zones", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" }, "examples": { "type": "string" }, "svp_range": { "type": "string" } }, "required": [ "code", "title", "experience", "training", "education", "examples", "svp_range" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/interestprofiler/interests/": { "parameters": [], "get": { "description": "Interest Profiler interest areas", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "score": { "type": "integer", "minimum": 0 } }, "required": [ "href", "code", "title", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/interestprofiler/careers": { "parameters": [], "get": { "description": "Interest Profiler matching careers for score", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "fit": { "type": "string", "enum": [ "Good", "Great", "Best" ] } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "answers", "in": "query", "schema": { "type": "string", "pattern": "^[12345]{30}([12345]{30})?$" }, "required": false, "description": "answers to Interest Profiler question list" }, { "name": "realistic", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Realistic score from Interest Profiler results" }, { "name": "investigative", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Investigative score from Interest Profiler results" }, { "name": "artistic", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Artistic score from Interest Profiler results" }, { "name": "social", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Social score from Interest Profiler results" }, { "name": "enterprising", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Enterprising score from Interest Profiler results" }, { "name": "conventional", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Conventional score from Interest Profiler results" }, { "name": "zone", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": false, "description": "return careers only from this Job Zone" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/interestprofiler/": { "parameters": [], "get": { "description": "Interest Profiler services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/industries/": { "parameters": [], "get": { "description": "Browse careers by industry", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "most_people": { "type": "string" }, "some_people": { "type": "string" }, "code": { "type": "integer", "minimum": 1 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/careers/": { "parameters": [], "get": { "description": "See all careers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/career_clusters/": { "parameters": [], "get": { "description": "Browse careers by cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "cluster_grouping": { "type": "string" } }, "required": [ "href", "code", "title", "cluster_grouping" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/bright_outlook/": { "parameters": [], "get": { "description": "Careers with a Bright Outlook", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mpp/": { "parameters": [], "get": { "description": "Mi Próximo Paso services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/search": { "parameters": [], "get": { "description": "Search careers with key words", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "keyword", "in": "query", "schema": { "type": "string" }, "required": true, "description": "search query (word, phrase, title, or code)" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/job_preparation/": { "parameters": [], "get": { "description": "Careers sorted by Job Preparation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/interests/": { "parameters": [], "get": { "description": "Careers sorted by Interests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/interestprofiler/results": { "parameters": [], "get": { "description": "Interest Profiler results", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "careers": { "type": "string" }, "result": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "score": { "type": "integer", "minimum": 0 } }, "required": [ "href", "code", "title", "description", "score" ], "additionalProperties": false } } }, "required": [ "result" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "answers", "in": "query", "schema": { "type": "string", "pattern": "^[12345]{30}([12345]{30})?$" }, "required": true, "description": "answers to Interest Profiler question list" } ] } }, "/mnm/interestprofiler/questions_30": { "parameters": [], "get": { "description": "Interest Profiler questions (mobile)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "answer_option": { "type": "array", "items": { "properties": { "value": { "type": "integer", "minimum": 1, "maximum": 5 }, "name": { "type": "string" } }, "required": [ "value", "name" ], "additionalProperties": false } }, "question": { "type": "array", "items": { "properties": { "index": { "type": "integer", "minimum": 1 }, "area": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "text": { "type": "string" } }, "required": [ "index", "area", "text" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "answer_option", "question" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/interestprofiler/questions": { "parameters": [], "get": { "description": "Interest Profiler questions (desktop)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "answer_option": { "type": "array", "items": { "properties": { "value": { "type": "integer", "minimum": 1, "maximum": 5 }, "name": { "type": "string" } }, "required": [ "value", "name" ], "additionalProperties": false } }, "question": { "type": "array", "items": { "properties": { "index": { "type": "integer", "minimum": 1 }, "area": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "text": { "type": "string" } }, "required": [ "index", "area", "text" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "answer_option", "question" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/interestprofiler/job_zones": { "parameters": [], "get": { "description": "Interest Profiler Job Zones", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" }, "examples": { "type": "string" }, "svp_range": { "type": "string" } }, "required": [ "code", "title", "experience", "training", "education", "examples", "svp_range" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/interestprofiler/interests/": { "parameters": [], "get": { "description": "Interest Profiler interest areas", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "score": { "type": "integer", "minimum": 0 } }, "required": [ "href", "code", "title", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/interestprofiler/careers": { "parameters": [], "get": { "description": "Interest Profiler matching careers for score", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "fit": { "type": "string", "enum": [ "Good", "Great", "Best" ] } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "answers", "in": "query", "schema": { "type": "string", "pattern": "^[12345]{30}([12345]{30})?$" }, "required": false, "description": "answers to Interest Profiler question list" }, { "name": "realistic", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Realistic score from Interest Profiler results" }, { "name": "investigative", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Investigative score from Interest Profiler results" }, { "name": "artistic", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Artistic score from Interest Profiler results" }, { "name": "social", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Social score from Interest Profiler results" }, { "name": "enterprising", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Enterprising score from Interest Profiler results" }, { "name": "conventional", "in": "query", "schema": { "type": "integer", "minimum": 0 }, "required": false, "description": "Conventional score from Interest Profiler results" }, { "name": "zone", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": false, "description": "return careers only from this Job Zone" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/interestprofiler/": { "parameters": [], "get": { "description": "Interest Profiler services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/industries/": { "parameters": [], "get": { "description": "Browse careers by industry", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "most_people": { "type": "string" }, "some_people": { "type": "string" }, "code": { "type": "integer", "minimum": 1 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/careers/": { "parameters": [], "get": { "description": "See all careers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/career_clusters/": { "parameters": [], "get": { "description": "Browse careers by cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "cluster_grouping": { "type": "string" } }, "required": [ "href", "code", "title", "cluster_grouping" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/bright_outlook/": { "parameters": [], "get": { "description": "Careers with a Bright Outlook", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/mnm/": { "parameters": [], "get": { "description": "My Next Move services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/database/": { "parameters": [], "get": { "description": "O*NET Database services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "info": { "type": "string" }, "rows": { "type": "string" }, "table_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "info", "rows", "table_id", "title", "description" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/about/": { "parameters": [], "get": { "description": "About O*NET Web Services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "taxonomy": { "properties": { "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "url", "name" ], "additionalProperties": false }, "database": { "properties": { "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "url", "name" ], "additionalProperties": false }, "api_version": { "type": "string" } }, "required": [ "taxonomy", "database", "api_version" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/": { "parameters": [], "get": { "description": "Service categories", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" } ] } }, "/veterans/job_preparation/{code}": { "parameters": [], "get": { "description": "Careers in Job Zone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" } }, "required": [ "title", "experience", "training", "education" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": true, "description": "Job Zone code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/interests/{code}": { "parameters": [], "get": { "description": "Careers in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "title", "description" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "required": true, "description": "category code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/industries/{code}/some_people": { "parameters": [], "get": { "description": "Careers in industry (some people)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "percent_employed" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1 }, "required": true, "description": "Industry code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/industries/{code}/most_people": { "parameters": [], "get": { "description": "Careers in industry (most people)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "percent_employed" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1 }, "required": true, "description": "Industry code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/careers/{code}/technology": { "parameters": [], "get": { "description": "Technology", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title" ], "additionalProperties": false } } }, "required": [ "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/skills": { "parameters": [], "get": { "description": "Skills", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/personality": { "parameters": [], "get": { "description": "Personality", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "top_interest": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "work_styles": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/knowledge": { "parameters": [], "get": { "description": "Knowledge", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/job_outlook": { "parameters": [], "get": { "description": "Job Outlook", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "outlook": { "properties": { "category": { "type": "string" }, "description": { "type": "string" } }, "required": [ "category", "description" ], "additionalProperties": false }, "bright_outlook": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } }, "salary": { "properties": { "soc_code": { "type": "string" }, "annual_10th_percentile": { "type": "integer", "minimum": 0 }, "annual_10th_percentile_over": { "type": "integer", "minimum": 0 }, "annual_median": { "type": "integer", "minimum": 0 }, "annual_median_over": { "type": "integer", "minimum": 0 }, "annual_90th_percentile": { "type": "integer", "minimum": 0 }, "annual_90th_percentile_over": { "type": "integer", "minimum": 0 }, "hourly_10th_percentile": { "type": "number", "minimum": 0 }, "hourly_10th_percentile_over": { "type": "number", "minimum": 0 }, "hourly_median": { "type": "number", "minimum": 0 }, "hourly_median_over": { "type": "number", "minimum": 0 }, "hourly_90th_percentile": { "type": "number", "minimum": 0 }, "hourly_90th_percentile_over": { "type": "number", "minimum": 0 } }, "required": [ "soc_code" ], "additionalProperties": false } }, "required": [ "outlook", "salary" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/in_the_military": { "parameters": [], "get": { "description": "Where in the military", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "air_force": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "code", "title", "active" ], "additionalProperties": false } }, "army": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "code", "title", "active" ], "additionalProperties": false } }, "coast_guard": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "code", "title", "active" ], "additionalProperties": false } }, "marine_corps": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "code", "title", "active" ], "additionalProperties": false } }, "navy": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "code", "title", "active" ], "additionalProperties": false } }, "space_force": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "active": { "type": "boolean" } }, "required": [ "code", "title", "active" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "branch", "in": "query", "schema": { "type": "string", "enum": [ "all", "air_force", "army", "coast_guard", "marine_corps", "navy", "space_force" ], "default": "all" }, "description": "Limit results to branch" } ] } }, "/veterans/careers/{code}/explore_more": { "parameters": [], "get": { "description": "Explore More", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "careers": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } }, "industries": { "type": "array", "items": { "properties": { "most_people": { "type": "string" }, "some_people": { "type": "string" }, "code": { "type": "integer", "minimum": 1 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/education": { "parameters": [], "get": { "description": "Education", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "job_zone": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" } }, "required": [ "href", "code", "title", "experience", "training", "education" ], "additionalProperties": false }, "education_usually_needed": { "type": "array", "items": { "type": "string" } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/check_out_my_state": { "parameters": [], "get": { "description": "Check Out My State", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "job_outlook": { "type": "string" } }, "required": [ "code", "name", "job_outlook" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "name", "job_outlook" ], "default": "name" }, "description": "sort order" } ] } }, "/veterans/careers/{code}/abilities": { "parameters": [], "get": { "description": "Abilities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/careers/{code}/": { "parameters": [], "get": { "description": "Career overview", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "also_called": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "summary": { "type": "boolean" } }, "required": [ "title", "summary" ], "additionalProperties": false } }, "sample_of_military_titles": { "properties": { "air_force": { "type": "array", "items": { "type": "string" } }, "army": { "type": "array", "items": { "type": "string" } }, "coast_guard": { "type": "array", "items": { "type": "string" } }, "marine_corps": { "type": "array", "items": { "type": "string" } }, "navy": { "type": "array", "items": { "type": "string" } }, "space_force": { "type": "array", "items": { "type": "string" } } }, "required": [], "additionalProperties": false }, "what_they_do": { "type": "string" }, "on_the_job": { "type": "array", "items": { "type": "string" } }, "word_cloud_terms": { "type": "array", "items": { "type": "string" } }, "career_video": { "type": "boolean" }, "contents": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } }, "required": [ "code", "title", "tags", "what_they_do", "on_the_job", "contents" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/veterans/career_clusters/{code}": { "parameters": [], "get": { "description": "Careers in cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "overview": { "type": "string" }, "sub_clusters": { "type": "array", "items": { "type": "string" } }, "example_programs": { "type": "array", "items": { "type": "string" } }, "source_url": { "type": "string" } }, "required": [ "title", "overview", "sub_clusters", "example_programs", "source_url" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d{4}00$" }, "required": true, "description": "Career Cluster code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/veterans/bright_outlook/{code}": { "parameters": [], "get": { "description": "Careers in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" } }, "required": [ "title" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "grow", "openings", "emerging" ] }, "required": true, "description": "category code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/taxonomy/{source}/{target}/{code}": { "parameters": [], "get": { "description": "O*NET-SOC taxonomy crosswalk", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "code", "title", "description" ], "additionalProperties": false } } }, "required": [ "code", "title", "description", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "source", "in": "path", "schema": { "type": "string", "enum": [ "2010", "2019", "active" ] }, "required": true, "description": "Source O*NET-SOC taxonomy" }, { "name": "target", "in": "path", "schema": { "type": "string", "enum": [ "2010", "2019", "active" ] }, "required": true, "description": "Target O*NET-SOC taxonomy" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code from source taxonomy" } ] } }, "/taxonomy/{source}/{target}/": { "parameters": [], "get": { "description": "O*NET-SOC taxonomy crosswalk services", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceList" } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "source", "in": "path", "schema": { "type": "string", "enum": [ "2010", "2019", "active" ] }, "required": true, "description": "Source O*NET-SOC taxonomy" }, { "name": "target", "in": "path", "schema": { "type": "string", "enum": [ "2010", "2019", "active" ] }, "required": true, "description": "Target O*NET-SOC taxonomy" } ] } }, "/online/technology/examples/{title}": { "parameters": [], "get": { "description": "Occupations for technology", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "source_url": { "type": "string" }, "license_url": { "type": "string" } }, "required": [ "title", "description" ], "additionalProperties": false }, "category": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "category", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "title", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Technology Skill title" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code", "job_zone" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/technology/categories/{code}": { "parameters": [], "get": { "description": "Occupations for technology category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "example": { "type": "array", "items": { "type": "string" } } }, "required": [ "code", "title", "description", "example" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "pattern": "\\d{8}" }, "required": true, "description": "Technology category code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code", "job_zone" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/stem_occupations/{code}": { "parameters": [], "get": { "description": "Occupations in STEM type", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_family": { "properties": { "code": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_family" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": true, "description": "STEM occupation type" }, { "name": "job_family", "in": "query", "schema": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "description": "filter by job family" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "job_family", "title", "code" ], "default": "job_family" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/related_activities/results/{code}": { "parameters": [], "get": { "description": "Occupations with related activities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "activities": { "properties": { "shared": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } }, "similar": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } }, "full": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } } }, "required": [ "shared", "similar", "full" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_zone", "activities" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "activities", "in": "query", "schema": { "type": "array", "items": { "type": "string", "pattern": "^4\\.A\\.[1234]\\.[abc]\\.\\d\\.I\\d\\d\\.D\\d\\d$" } }, "style": "form", "explode": false, "required": true, "description": "Activity IDs to match" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "shared", "similar", "title", "code", "zone" ], "default": "shared" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/related_activities/activities/{code}": { "parameters": [], "get": { "description": "Activities for occupation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/onet_data/work_styles/{id}": { "parameters": [], "get": { "description": "Occupations for selected Work Styles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^1\\.C(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "title", "code" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/work_context/{id}": { "parameters": [], "get": { "description": "Occupations for selected Work Context", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "example": { "type": "array", "items": { "properties": { "context": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "context", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "context": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^4\\.C(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "context", "title", "code" ], "default": "context" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/work_activities/{id}": { "parameters": [], "get": { "description": "Occupations for selected Work Activity", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "level_not_relevant": { "type": "boolean" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 }, "detailed_work_activities": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } } }, "required": [ "href", "code", "title", "tags", "job_zone", "detailed_work_activities" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^4\\.A(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "level", "title", "code" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/skills_cf/{id}": { "parameters": [], "get": { "description": "Occupations for selected Cross-Functional Skill", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "level_not_relevant": { "type": "boolean" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^2\\.B(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "level", "title", "code" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/skills_basic/{id}": { "parameters": [], "get": { "description": "Occupations for selected Basic Skill", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "level_not_relevant": { "type": "boolean" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^2\\.A(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "level", "title", "code" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/knowledge/{id}": { "parameters": [], "get": { "description": "Occupations for selected Knowledge", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "level_not_relevant": { "type": "boolean" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^2\\.C(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "level", "title", "code" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/interests/{interest_code}": { "parameters": [], "get": { "description": "Occupations for selected interest code", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "interest_code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "interest_code", "name", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "interest_code": { "type": "string" }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "featured": { "type": "boolean" } }, "required": [ "href", "code", "title", "tags", "interest_code", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "interest_code", "in": "path", "schema": { "type": "string", "pattern": "^[RIASEC]{1,3}$" }, "required": true, "description": "interest code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "interest_code", "job_zone", "code", "title" ], "default": "job_zone" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/onet_data/abilities/{id}": { "parameters": [], "get": { "description": "Occupations for selected Ability", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "example": { "type": "array", "items": { "properties": { "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "level", "description" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "level": { "type": "integer", "minimum": 0, "maximum": 100 }, "level_not_relevant": { "type": "boolean" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^1\\.A(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "element ID" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "level", "title", "code" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/work_styles": { "parameters": [], "get": { "description": "Work Styles occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/work_context": { "parameters": [], "get": { "description": "Work Context occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "response": { "type": "array", "items": { "properties": { "percentage_of_respondents": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "percentage_of_respondents", "description" ], "additionalProperties": false } } }, "required": [ "id", "related", "name", "description", "response" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/work_activities": { "parameters": [], "get": { "description": "Work Activities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/technology_skills": { "parameters": [], "get": { "description": "Technology Skills occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "hot_technology": { "properties": { "total": { "type": "integer" }, "href": { "type": "string" } }, "required": [ "total", "href" ], "additionalProperties": false }, "in_demand_skills": { "properties": { "total": { "type": "integer" }, "href": { "type": "string" } }, "required": [ "total", "href" ], "additionalProperties": false }, "category": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "related": { "type": "string" }, "title": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "href" ], "additionalProperties": false } }, "example_more": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "href" ], "additionalProperties": false } } }, "required": [ "code", "related", "title", "example" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "category" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/tasks": { "parameters": [], "get": { "description": "Tasks occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "task": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "related", "title" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "task" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/skills": { "parameters": [], "get": { "description": "Skills occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/related_occupations": { "parameters": [], "get": { "description": "Related Occupations occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "supplemental": { "type": "boolean" } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/professional_associations": { "parameters": [], "get": { "description": "Professional Associations occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "source": { "type": "array", "items": { "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "ally": { "type": "boolean" }, "category": { "properties": { "code": { "type": "string", "enum": [ "national", "regional", "other" ] }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "url", "name", "category" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "source" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "category", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "national", "regional", "other" ] }, "default": [ "national", "regional", "other" ] }, "style": "form", "explode": false, "description": "categories to return" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/military_career_summaries": { "parameters": [], "get": { "description": "Military Career Summaries occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career_summary": { "type": "array", "items": { "properties": { "url": { "type": "string" }, "title": { "type": "string" } }, "required": [ "url", "title" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career_summary" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/knowledge": { "parameters": [], "get": { "description": "Knowledge occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/job_zone": { "parameters": [], "get": { "description": "Job Zone occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "education": { "type": "string" }, "related_experience": { "type": "string" }, "job_training": { "type": "string" }, "job_zone_examples": { "type": "string" }, "svp_range": { "type": "string" } }, "required": [ "code", "title", "education", "related_experience", "job_training", "job_zone_examples", "svp_range" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/occupations/{code}/summary/interests": { "parameters": [], "get": { "description": "Interests occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "interest_code": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "interest_code", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/occupations/{code}/summary/education": { "parameters": [], "get": { "description": "Education occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "response": { "type": "array", "items": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 12 }, "title": { "type": "string" }, "description": { "type": "string" }, "percentage_of_respondents": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [ "response" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/occupations/{code}/summary/detailed_work_activities": { "parameters": [], "get": { "description": "Detailed Work Activities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "activity": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "related": { "type": "string" } }, "required": [ "id", "title", "related" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "activity" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/apprenticeship": { "parameters": [], "get": { "description": "Apprenticeship Opportunities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example_title": { "type": "array", "items": { "type": "string" } } }, "required": [ "start", "end", "total", "example_title" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/summary/abilities": { "parameters": [], "get": { "description": "Abilities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/related/work_styles/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Work Styles", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^1\\.C(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "Work Styles element ID" } ] } }, "/online/occupations/{code}/related/work_context/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Work Context", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^4\\.C(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "Work Context element ID" } ] } }, "/online/occupations/{code}/related/work_activities/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Work Activity", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^4\\.A(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "Work Activity element ID" } ] } }, "/online/occupations/{code}/related/technology_skills/{category_code}": { "parameters": [], "get": { "description": "Related occupations for selected Technology Skill category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "example": { "type": "array", "items": { "type": "string" } }, "occupation_total": { "type": "integer", "minimum": 0 }, "see_more": { "type": "string" } }, "required": [ "code", "title", "example", "occupation_total", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "example": { "type": "array", "items": { "type": "string" } } }, "required": [ "href", "code", "title", "tags", "example" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "category_code", "in": "path", "schema": { "type": "integer" }, "required": true, "description": "category code" } ] } }, "/online/occupations/{code}/related/tasks/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Task", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "title", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^\\d+$" }, "required": true, "description": "Task ID" } ] } }, "/online/occupations/{code}/related/skills/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Skill", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^2\\.[AB](\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "Skill element ID" } ] } }, "/online/occupations/{code}/related/knowledge/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Knowledge", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^2\\.C(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "Knowledge element ID" } ] } }, "/online/occupations/{code}/related/interests/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Interest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "interest_code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "interest_code", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^1\\.B\\.1\\.[a-f]$" }, "required": true, "description": "Interest element ID" } ] } }, "/online/occupations/{code}/related/detailed_work_activities/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Detailed Work Activity", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "title", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^4\\.A\\.[1234]\\.[abc]\\.\\d\\.I\\d\\d\\.D\\d\\d(,4\\.A\\.[1234]\\.[abc]\\.\\d\\.I\\d\\d\\.D\\d\\d)*$" }, "required": true, "description": "DWA ID" } ] } }, "/online/occupations/{code}/related/abilities/{id}": { "parameters": [], "get": { "description": "Related occupations for selected Ability", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "summary": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "see_more": { "type": "string" } }, "required": [ "id", "name", "description", "see_more" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "id", "in": "path", "schema": { "type": "string", "pattern": "^1\\.A(\\.[A-Za-z0-9]+)+$" }, "required": true, "description": "Ability element ID" } ] } }, "/online/occupations/{code}/in_demand_skills": { "parameters": [], "get": { "description": "In Demand Skills occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "href" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "example" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "percentage", "title" ], "default": "percentage" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/hot_technology": { "parameters": [], "get": { "description": "Hot Technology occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "href" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "example" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "percentage", "title" ], "default": "percentage" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/work_styles": { "parameters": [], "get": { "description": "Work Styles occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "name" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/work_context": { "parameters": [], "get": { "description": "Work Context occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "context": { "type": "integer", "minimum": 0, "maximum": 100 }, "response": { "type": "array", "items": { "properties": { "percentage_of_respondents": { "type": "integer", "minimum": 0, "maximum": 100 }, "description": { "type": "string" } }, "required": [ "percentage_of_respondents", "description" ], "additionalProperties": false } } }, "required": [ "id", "related", "name", "description", "response" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "context", "name" ], "default": "context" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/work_activities": { "parameters": [], "get": { "description": "Work Activities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "name" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/technology_skills": { "parameters": [], "get": { "description": "Technology Skills occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "hot_technology": { "properties": { "total": { "type": "integer" }, "href": { "type": "string" } }, "required": [ "total", "href" ], "additionalProperties": false }, "in_demand_skills": { "properties": { "total": { "type": "integer" }, "href": { "type": "string" } }, "required": [ "total", "href" ], "additionalProperties": false }, "category": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "related": { "type": "string" }, "title": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "href" ], "additionalProperties": false } }, "example_more": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "href": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title", "href" ], "additionalProperties": false } } }, "required": [ "code", "related", "title", "example" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "category" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/tasks": { "parameters": [], "get": { "description": "Tasks occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "task": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "title": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 }, "category": { "type": "string", "enum": [ "Core", "Supplemental", "New" ] } }, "required": [ "id", "related", "title" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "task" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "category", "importance", "title" ], "default": "category" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/skills": { "parameters": [], "get": { "description": "Skills occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "name" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/related_occupations": { "parameters": [], "get": { "description": "Related Occupations occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "supplemental": { "type": "boolean" } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/professional_associations": { "parameters": [], "get": { "description": "Professional Associations occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "source": { "type": "array", "items": { "properties": { "url": { "type": "string" }, "name": { "type": "string" }, "ally": { "type": "boolean" }, "category": { "properties": { "code": { "type": "string", "enum": [ "national", "regional", "other" ] }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "required": [ "url", "name", "category" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "source" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "category", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "national", "regional", "other" ] }, "default": [ "national", "regional", "other" ] }, "style": "form", "explode": false, "description": "categories to return" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/military_career_summaries": { "parameters": [], "get": { "description": "Military Career Summaries occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career_summary": { "type": "array", "items": { "properties": { "url": { "type": "string" }, "title": { "type": "string" } }, "required": [ "url", "title" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career_summary" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/knowledge": { "parameters": [], "get": { "description": "Knowledge occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "name" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/job_zone": { "parameters": [], "get": { "description": "Job Zone occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "education": { "type": "string" }, "related_experience": { "type": "string" }, "job_training": { "type": "string" }, "job_zone_examples": { "type": "string" }, "svp_range": { "type": "string" } }, "required": [ "code", "title", "education", "related_experience", "job_training", "job_zone_examples", "svp_range" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/occupations/{code}/details/interests": { "parameters": [], "get": { "description": "Interests occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "occupational_interest": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "occupational_interest", "name" ], "default": "occupational_interest" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/education": { "parameters": [], "get": { "description": "Education occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "response": { "type": "array", "items": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 12 }, "title": { "type": "string" }, "description": { "type": "string" }, "percentage_of_respondents": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [ "response" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/occupations/{code}/details/detailed_work_activities": { "parameters": [], "get": { "description": "Detailed Work Activities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "activity": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "related": { "type": "string" } }, "required": [ "id", "title", "related" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "activity" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/apprenticeship": { "parameters": [], "get": { "description": "Apprenticeship Opportunities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example_title": { "type": "array", "items": { "type": "string" } } }, "required": [ "start", "end", "total", "example_title" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/details/abilities": { "parameters": [], "get": { "description": "Abilities occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "related": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "id", "related", "name", "description" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "element" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "importance", "name" ], "default": "importance" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/occupations/{code}/custom/work_activities_outline": { "parameters": [], "get": { "description": "Work Activities Outline occupation report", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "activity": { "type": "array", "items": { "properties": { "activity_type": { "type": "string", "enum": [ "gwa", "iwa", "dwa", "task" ] }, "id": { "type": "string" }, "related": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 }, "related_activity": { "type": "array", "items": { "$ref": "#" } } }, "required": [ "activity_type", "id", "title" ], "additionalProperties": false } } }, "required": [ "activity" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "display", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "gwa", "iwa", "dwa", "task" ] }, "default": [ "gwa", "iwa", "dwa", "task" ] }, "style": "form", "explode": false, "description": "activity types to return" } ] } }, "/online/occupations/{code}/": { "parameters": [], "get": { "description": "Occupation report overview", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "description": { "type": "string" }, "sample_of_reported_titles": { "type": "array", "items": { "type": "string" } }, "also_see": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } }, "bright_outlook": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } }, "updated": { "properties": { "year": { "type": "integer" }, "contents": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "source": { "type": "string" }, "year": { "type": "integer" } }, "required": [ "title" ], "additionalProperties": false } } }, "required": [ "year", "contents" ], "additionalProperties": false }, "summary_contents": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } }, "details_contents": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } }, "custom_contents": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } }, "required": [ "code", "title", "tags", "description", "summary_contents", "details_contents", "custom_contents" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/job_zones/{code}": { "parameters": [], "get": { "description": "Occupations in Job Zone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": true, "description": "Job Zone code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/job_families/{code}": { "parameters": [], "get": { "description": "Occupations in job family", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^[12345][13579]-0000$" }, "required": true, "description": "job family code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/job_duties/tasks/{code}": { "parameters": [], "get": { "description": "Tasks for occupation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string", "pattern": "^\\d+$" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/online/job_duties/results/{code}": { "parameters": [], "get": { "description": "Occupations with related tasks", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "tasks": { "properties": { "closely_related": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } }, "less_related": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } }, "full": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "title": { "type": "string" } }, "required": [ "id", "title" ], "additionalProperties": false } } }, "required": [ "closely_related", "less_related", "full" ], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags", "job_zone", "tasks" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "tasks", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "style": "form", "explode": false, "required": true, "description": "Task IDs to match" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "closely_related", "all_related", "title", "code", "zone" ], "default": "closely_related" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/industries/{code}": { "parameters": [], "get": { "description": "Occupations in industry", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "industry_data_from": { "type": "string" }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 }, "projected_growth": { "type": "string" }, "projected_openings": { "type": "integer" } }, "required": [ "href", "code", "title", "tags", "percent_employed", "projected_growth", "projected_openings" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 10, "maximum": 99 }, "required": true, "description": "industry code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "percent", "title", "code", "growth", "openings" ], "default": "percent" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/hot_technology/{title}": { "parameters": [], "get": { "description": "Occupations for hot technology", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "description": { "type": "string" }, "source_url": { "type": "string" }, "license_url": { "type": "string" } }, "required": [ "description" ], "additionalProperties": false }, "category": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "integer" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "job_zone": { "properties": { "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "job_zone", "in_demand" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "category", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "title", "in": "path", "schema": { "type": "string" }, "required": true, "description": "Hot Technology title" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "percentage", "title", "code", "job_zone" ], "default": "percentage" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/career_clusters/sub_clusters/{code}": { "parameters": [], "get": { "description": "Occupations in sub-cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "overview": { "type": "string" }, "detail": { "type": "string" }, "example_programs": { "type": "array", "items": { "type": "string" } }, "source_url": { "type": "string" } }, "required": [ "title", "overview", "example_programs", "source_url" ], "additionalProperties": false }, "cluster": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "cluster", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d{6}$" }, "required": true, "description": "sub-cluster code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/career_clusters/{code}": { "parameters": [], "get": { "description": "Occupations in cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "overview": { "type": "string" }, "detail": { "type": "string" }, "source_url": { "type": "string" } }, "required": [ "title", "overview", "source_url" ], "additionalProperties": false }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "sub_cluster": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } } }, "required": [ "href", "code", "title", "tags", "sub_cluster" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d{4}00$" }, "required": true, "description": "cluster code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "sub_cluster", "title", "code" ], "default": "sub_cluster" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/bright_outlook/{code}": { "parameters": [], "get": { "description": "Occupations in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "occupation" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "grow", "openings", "emerging" ] }, "required": true, "description": "category code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "title", "code" ], "default": "title" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/online/associations/{code}": { "parameters": [], "get": { "description": "Associations for occupation", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "association": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "ally": { "type": "boolean" }, "related_occupation": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "title", "url", "ally", "related_occupation" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "association" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "ally", "title", "related_occupation" ], "default": "ally" }, "description": "sort order" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/job_preparation/{code}": { "parameters": [], "get": { "description": "Careers in Job Zone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" } }, "required": [ "title", "experience", "training", "education" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": true, "description": "Job Zone code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/interests/{code}": { "parameters": [], "get": { "description": "Careers in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "title", "description" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "required": true, "description": "category code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/interestprofiler/interests/{code}": { "parameters": [], "get": { "description": "Interest Profiler careers for single interest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "required": true, "description": "single interest area for career exploration" }, { "name": "zone", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": false, "description": "return careers only from this Job Zone" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/industries/{code}/some_people": { "parameters": [], "get": { "description": "Careers in industry (some people)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "percent_employed" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1 }, "required": true, "description": "Industry code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/industries/{code}/most_people": { "parameters": [], "get": { "description": "Careers in industry (most people)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "percent_employed" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1 }, "required": true, "description": "Industry code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/careers/{code}/technology": { "parameters": [], "get": { "description": "Technology", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title" ], "additionalProperties": false } } }, "required": [ "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/skills": { "parameters": [], "get": { "description": "Skills", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/personality": { "parameters": [], "get": { "description": "Personality", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "top_interest": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "work_styles": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/knowledge": { "parameters": [], "get": { "description": "Knowledge", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/job_outlook": { "parameters": [], "get": { "description": "Job Outlook", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "outlook": { "properties": { "category": { "type": "string" }, "description": { "type": "string" } }, "required": [ "category", "description" ], "additionalProperties": false }, "bright_outlook": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } }, "salary": { "properties": { "soc_code": { "type": "string" }, "annual_10th_percentile": { "type": "integer", "minimum": 0 }, "annual_10th_percentile_over": { "type": "integer", "minimum": 0 }, "annual_median": { "type": "integer", "minimum": 0 }, "annual_median_over": { "type": "integer", "minimum": 0 }, "annual_90th_percentile": { "type": "integer", "minimum": 0 }, "annual_90th_percentile_over": { "type": "integer", "minimum": 0 }, "hourly_10th_percentile": { "type": "number", "minimum": 0 }, "hourly_10th_percentile_over": { "type": "number", "minimum": 0 }, "hourly_median": { "type": "number", "minimum": 0 }, "hourly_median_over": { "type": "number", "minimum": 0 }, "hourly_90th_percentile": { "type": "number", "minimum": 0 }, "hourly_90th_percentile_over": { "type": "number", "minimum": 0 } }, "required": [ "soc_code" ], "additionalProperties": false } }, "required": [ "outlook", "salary" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/explore_more": { "parameters": [], "get": { "description": "Explore More", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "careers": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } }, "industries": { "type": "array", "items": { "properties": { "most_people": { "type": "string" }, "some_people": { "type": "string" }, "code": { "type": "integer", "minimum": 1 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/education": { "parameters": [], "get": { "description": "Education", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "job_zone": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" } }, "required": [ "href", "code", "title", "experience", "training", "education" ], "additionalProperties": false }, "education_usually_needed": { "type": "array", "items": { "type": "string" } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/check_out_my_state": { "parameters": [], "get": { "description": "Check Out My State", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "job_outlook": { "type": "string" } }, "required": [ "code", "name", "job_outlook" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "name", "job_outlook" ], "default": "name" }, "description": "sort order" } ] } }, "/mpp/careers/{code}/abilities": { "parameters": [], "get": { "description": "Abilities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/careers/{code}/": { "parameters": [], "get": { "description": "Career overview", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "also_called": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "summary": { "type": "boolean" } }, "required": [ "title", "summary" ], "additionalProperties": false } }, "what_they_do": { "type": "string" }, "on_the_job": { "type": "array", "items": { "type": "string" } }, "career_video": { "type": "boolean" }, "contents": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } }, "required": [ "code", "title", "tags", "what_they_do", "on_the_job", "contents" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mpp/career_clusters/{code}": { "parameters": [], "get": { "description": "Careers in cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "overview": { "type": "string" }, "sub_clusters": { "type": "array", "items": { "type": "string" } }, "example_programs": { "type": "array", "items": { "type": "string" } }, "source_url": { "type": "string" } }, "required": [ "title", "overview", "sub_clusters", "example_programs", "source_url" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d{4}00$" }, "required": true, "description": "Career Cluster code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mpp/bright_outlook/{code}": { "parameters": [], "get": { "description": "Careers in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" } }, "required": [ "title" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "grow", "openings", "emerging" ] }, "required": true, "description": "category code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/job_preparation/{code}": { "parameters": [], "get": { "description": "Careers in Job Zone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" } }, "required": [ "title", "experience", "training", "education" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": true, "description": "Job Zone code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/interests/{code}": { "parameters": [], "get": { "description": "Careers in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "description": { "type": "string" } }, "required": [ "title", "description" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "required": true, "description": "category code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/interestprofiler/interests/{code}": { "parameters": [], "get": { "description": "Interest Profiler careers for single interest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "realistic", "investigative", "artistic", "social", "enterprising", "conventional" ] }, "required": true, "description": "single interest area for career exploration" }, { "name": "zone", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 5 }, "required": false, "description": "return careers only from this Job Zone" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/industries/{code}/some_people": { "parameters": [], "get": { "description": "Careers in industry (some people)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "percent_employed" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1 }, "required": true, "description": "Industry code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/industries/{code}/most_people": { "parameters": [], "get": { "description": "Careers in industry (most people)", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "example": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "percent_employed": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "href", "code", "title", "tags", "percent_employed" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "integer", "minimum": 1 }, "required": true, "description": "Industry code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/careers/{code}/technology": { "parameters": [], "get": { "description": "Technology", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "integer" }, "title": { "type": "string" }, "example": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "hot_technology": { "type": "boolean" }, "in_demand": { "type": "boolean" }, "percentage": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "title" ], "additionalProperties": false } } }, "required": [ "code", "title" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/skills": { "parameters": [], "get": { "description": "Skills", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/personality": { "parameters": [], "get": { "description": "Personality", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "top_interest": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "name", "description" ], "additionalProperties": false }, "work_styles": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/knowledge": { "parameters": [], "get": { "description": "Knowledge", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/job_outlook": { "parameters": [], "get": { "description": "Job Outlook", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "outlook": { "properties": { "category": { "type": "string" }, "description": { "type": "string" } }, "required": [ "category", "description" ], "additionalProperties": false }, "bright_outlook": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "code", "title" ], "additionalProperties": false } }, "salary": { "properties": { "soc_code": { "type": "string" }, "annual_10th_percentile": { "type": "integer", "minimum": 0 }, "annual_10th_percentile_over": { "type": "integer", "minimum": 0 }, "annual_median": { "type": "integer", "minimum": 0 }, "annual_median_over": { "type": "integer", "minimum": 0 }, "annual_90th_percentile": { "type": "integer", "minimum": 0 }, "annual_90th_percentile_over": { "type": "integer", "minimum": 0 }, "hourly_10th_percentile": { "type": "number", "minimum": 0 }, "hourly_10th_percentile_over": { "type": "number", "minimum": 0 }, "hourly_median": { "type": "number", "minimum": 0 }, "hourly_median_over": { "type": "number", "minimum": 0 }, "hourly_90th_percentile": { "type": "number", "minimum": 0 }, "hourly_90th_percentile_over": { "type": "number", "minimum": 0 } }, "required": [ "soc_code" ], "additionalProperties": false } }, "required": [ "outlook", "salary" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/explore_more": { "parameters": [], "get": { "description": "Explore More", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "careers": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } }, "industries": { "type": "array", "items": { "properties": { "most_people": { "type": "string" }, "some_people": { "type": "string" }, "code": { "type": "integer", "minimum": 1 }, "title": { "type": "string" } }, "required": [ "code", "title" ], "additionalProperties": false } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/education": { "parameters": [], "get": { "description": "Education", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "job_zone": { "properties": { "href": { "type": "string" }, "code": { "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "type": "string" }, "experience": { "type": "string" }, "training": { "type": "string" }, "education": { "type": "string" } }, "required": [ "href", "code", "title", "experience", "training", "education" ], "additionalProperties": false }, "education_usually_needed": { "type": "array", "items": { "type": "string" } } }, "required": [], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/check_out_my_state": { "parameters": [], "get": { "description": "Check Out My State", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "job_outlook": { "type": "string" } }, "required": [ "code", "name", "job_outlook" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" }, { "name": "sort", "in": "query", "schema": { "type": "string", "enum": [ "name", "job_outlook" ], "default": "name" }, "description": "sort order" } ] } }, "/mnm/careers/{code}/abilities": { "parameters": [], "get": { "description": "Abilities", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "element": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "name", "element" ], "additionalProperties": false } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/careers/{code}/": { "parameters": [], "get": { "description": "Career overview", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false }, "also_called": { "type": "array", "items": { "properties": { "title": { "type": "string" }, "summary": { "type": "boolean" } }, "required": [ "title", "summary" ], "additionalProperties": false } }, "what_they_do": { "type": "string" }, "on_the_job": { "type": "array", "items": { "type": "string" } }, "word_cloud_terms": { "type": "array", "items": { "type": "string" } }, "career_video": { "type": "boolean" }, "contents": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "title": { "type": "string" } }, "required": [ "href", "title" ], "additionalProperties": false } } }, "required": [ "code", "title", "tags", "what_they_do", "on_the_job", "contents" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d\\d-\\d\\d\\d\\d\\.\\d\\d$" }, "required": true, "description": "O*NET-SOC code" } ] } }, "/mnm/career_clusters/{code}": { "parameters": [], "get": { "description": "Careers in cluster", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" }, "overview": { "type": "string" }, "sub_clusters": { "type": "array", "items": { "type": "string" } }, "example_programs": { "type": "array", "items": { "type": "string" } }, "source_url": { "type": "string" } }, "required": [ "title", "overview", "sub_clusters", "example_programs", "source_url" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "pattern": "^\\d{4}00$" }, "required": true, "description": "Career Cluster code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/mnm/bright_outlook/{code}": { "parameters": [], "get": { "description": "Careers in category", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "summary": { "properties": { "title": { "type": "string" } }, "required": [ "title" ], "additionalProperties": false }, "career": { "type": "array", "items": { "properties": { "href": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "tags": { "properties": { "bright_outlook": { "type": "boolean" } }, "required": [], "additionalProperties": false } }, "required": [ "href", "code", "title", "tags" ], "additionalProperties": false } } }, "required": [ "start", "end", "total", "summary", "career" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "code", "in": "path", "schema": { "type": "string", "enum": [ "grow", "openings", "emerging" ] }, "required": true, "description": "category code" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/database/rows/{table_id}": { "parameters": [], "get": { "description": "Data rows", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "start": { "type": "integer", "minimum": 1 }, "end": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "prev": { "type": "string" }, "next": { "type": "string" }, "row": { "type": "array", "items": { "type": "object" } } }, "required": [ "start", "end", "total", "row" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "table_id", "in": "path", "schema": { "type": "string", "pattern": "^\\w+$" }, "required": true, "description": "Identifier of the desired table" }, { "name": "filter", "in": "query", "explode": true, "schema": { "type": "array", "items": { "type": "string", "pattern": "^\\w+\\.n?(na|((eq|contains|startswith|endswith|lt|lte|gt|gte|before|onbefore|after|onafter)\\..+))$" } }, "description": "Filter criteria" }, { "name": "sort", "in": "query", "explode": true, "schema": { "type": "array", "items": { "type": "string", "pattern": "^\\w+(\\.descending)?$" } }, "description": "Column ID to use for sorting" }, { "name": "start", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Index of first returned result" }, { "name": "end", "in": "query", "schema": { "type": "integer", "minimum": 1 }, "description": "Index of last returned result" } ] } }, "/database/info/{table_id}": { "parameters": [], "get": { "description": "Table column information", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "rows": { "type": "string" }, "table_id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "data_dictionary": { "type": "string" }, "download": { "properties": { "excel": { "type": "string" }, "text": { "type": "string" }, "mysql": { "type": "string" }, "sql_server": { "type": "string" }, "oracle": { "type": "string" } }, "required": [] }, "column": { "type": "array", "items": { "properties": { "column_id": { "type": "string" }, "optional": { "type": "boolean" }, "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string" }, "format": { "type": "string" } }, "required": [ "column_id", "optional", "title", "description", "type", "format" ], "additionalProperties": false } } }, "required": [ "rows", "table_id", "title", "description", "data_dictionary", "download", "column" ], "additionalProperties": false } } } }, "401": { "$ref": "#/components/responses/UnauthorizedError" }, "422": { "$ref": "#/components/responses/ParameterError" } }, "parameters": [ { "name": "X-API-Key", "in": "header", "schema": { "type": "string" }, "required": true, "description": "O*NET Web Services API Key" }, { "name": "table_id", "in": "path", "schema": { "type": "string", "pattern": "^\\w+$" }, "required": true, "description": "Identifier of the desired table" } ] } } }, "tags": [], "servers": [ { "url": "https://api-v2.onetcenter.org/" } ] }