Introduction
Welcome to the documentation for the ApprenticeshipStandards API. Currently this API is public but requires an API key for authentication. This API is a REST API following the {json:api} specification.
Authentication
Example authorization request:
curl -X 'GET' \
'https://admin.apprenticeshipstandards.org/api/v1/occupations' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiYmI1NjNlZWMtYTZmZi00MjZiLWFkNzUtNzNiM2IyZWM2MDA1IiwiYXBpX2tleV9pZCI6ImE1YWFmYzA0LTA1YmItNDVlMS04NDliLTEzOTlmMTNjNDg5OCJ9.EdwBMEPGBIZwarW1GTHzqpqus6rt8VsJZLM_cJgN8lE'
ApprenticeshipStandards uses API keys to allow access to the API. The API key must be included in all API requests to the server in a header that looks like the following:
Authorization: Bearer your-api-token
For readability, the headers will not be included in further examples.
Occupations
List occupations
Example request:
curl "https://admin.apprenticeshipstandards.org/api/v1/occupations"
Example JSON response:
{
"data": [
{
"id": "34448da3-6260-4b90-ba5d-fb7d6f1cbbe6",
"type": "occupations",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/occupations/34448da3-6260-4b90-ba5d-fb7d6f1cbbe6"
},
"attributes": {
"title": "3D Printing Technician",
"onet_code": "17-3026.00",
"rapids_code": "2078",
"time_based_hours": 2000,
"competency_based_hours": 2000
}
},
{
"id": "e6fc1a85-a3ca-4b91-9314-0869c14346e7",
"type": "occupations",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/occupations/e6fc1a85-a3ca-4b91-9314-0869c14346e7"
},
"attributes": {
"title": "ALARM OPERATOR (Gov Serv)",
"onet_code": "43-5031.00",
"rapids_code": "0870",
"time_based_hours": 2000,
"competency_based_hours": 2000
}
}
]
}
This endpoint retrieves all occupations.
HTTP Request
GET https://admin.apprenticeshipstandards.org/api/v1/occupations
Retrieve occupation
Example request:
curl "https://admin.apprenticeshipstandards.org/api/v1/occupations/34448da3-6260-4b90-ba5d-fb7d6f1cbbe6"
Example JSON response:
{
"data": {
"id": "34448da3-6260-4b90-ba5d-fb7d6f1cbbe6",
"type": "occupations",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/occupations/34448da3-6260-4b90-ba5d-fb7d6f1cbbe6"
},
"attributes": {
"title": "3D Printing Technician",
"onet_code": "17-3026.00",
"rapids_code": "2078",
"time_based_hours": 2000,
"competency_based_hours": 2000
}
}
}
This endpoint retrieves a specific occupation.
HTTP Request
GET https://admin.apprenticeshipstandards.org/api/v1/occupations/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the occupation to retrieve |
Standards
List standards
Example request:
curl "https://admin.apprenticeshipstandards.org/api/v1/standards"
Example JSON response:
{
"data": [
{
"id": "6ec4adc5-7430-41a8-bd41-154fffe51ba5",
"type": "standards",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/standards/6ec4adc5-7430-41a8-bd41-154fffe51ba5"
},
"attributes": {
"title": "Pipe Fitter",
"existing_title": null,
"sponsor_name": "Hardy Corporation",
"registration_agency": "Alabama (SAA)",
"onet_code": "47-2152.00",
"rapids_code": "0414",
"ojt_type": "time_based",
"term_months": 48,
"probationary_period_months": 1000,
"apprenticeship_to_journeyworker_ratio": "1:1",
"ojt_hours_min": null,
"ojt_hours_max": 8000,
"rsi_hours_min": null,
"rsi_hours_max": 680
}
},
{
"id": "7f1e3364-3815-4ca1-99e7-59af4f5eef38",
"type": "standards",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/standards/7f1e3364-3815-4ca1-99e7-59af4f5eef38"
},
"attributes": {
"title": "Pipe Fitter",
"existing_title": null,
"sponsor_name": "Hardy Corporation",
"registration_agency": "Alabama (SAA)",
"onet_code": "47-2152.00",
"rapids_code": "0414",
"ojt_type": "hybrid_based",
"term_months": 48,
"probationary_period_months": 1000,
"apprenticeship_to_journeyworker_ratio": "1:1",
"ojt_hours_min": null,
"ojt_hours_max": 8000,
"rsi_hours_min": null,
"rsi_hours_max": 680
}
},
{
"id": "36af0202-ec79-44e8-aaeb-b0f8f7a427ca",
"type": "standards",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/standards/36af0202-ec79-44e8-aaeb-b0f8f7a427ca"
},
"attributes": {
"title": "Pipe Fitter",
"existing_title": null,
"sponsor_name": "Hardy Corporation",
"registration_agency": "Alabama (SAA)",
"onet_code": "47-2152.00",
"rapids_code": "0091",
"ojt_type": "competency_based",
"term_months": 48,
"probationary_period_months": 1000,
"apprenticeship_to_journeyworker_ratio": "1:1",
"ojt_hours_min": null,
"ojt_hours_max": 8000,
"rsi_hours_min": null,
"rsi_hours_max": 680
}
}
]
}
This endpoint retrieves all standards.
HTTP Request
GET https://admin.apprenticeshipstandards.org/api/v1/standards
Query Parameters
To filter by multiple values, separate with a comma.
Example request with filters:
curl "https://admin.apprenticeshipstandards.org/api/v1/standards?filter[onet_code]=47-2152.00,51-0786.00"
| Parameter | Description |
|---|---|
| filter[title] | Filter standards by title |
| filter[onet_code] | Filter standards by ONET code |
| filter[rapids_code] | Filter standards by RAPIDS code |
Retrieve standard
Example request:
curl "https://admin.apprenticeshipstandards.org/api/v1/standards/34448da3-6260-4b90-ba5d-fb7d6f1cbbe6"
Example JSON response:
{
"data": {
"id": "6ec4adc5-7430-41a8-bd41-154fffe51ba5",
"type": "standards",
"links": {
"self": "https://admin.apprenticeshipstandards.org/api/v1/standards/6ec4adc5-7430-41a8-bd41-154fffe51ba5"
},
"attributes": {
"title": "Pipe Fitter",
"existing_title": null,
"sponsor_name": "Hardy Corporation",
"registration_agency": "Alabama (SAA)",
"onet_code": "47-2152.00",
"rapids_code": "0414",
"ojt_type": "time_based",
"term_months": 48,
"probationary_period_months": 1000,
"apprenticeship_to_journeyworker_ratio": "1:1",
"ojt_hours_min": null,
"ojt_hours_max": 8000,
"rsi_hours_min": null,
"rsi_hours_max": 680
}
}
}
This endpoint retrieves a specific standard.
HTTP Request
GET https://admin.apprenticeshipstandards.org/api/v1/standards/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the standard to retrieve |