Overview
Allows users to search and view details of Job Profiles from the National Careers Service
Documents
- job-profiles-v1.json
- Uploaded schema
Current release
| Release name | Available from |
|---|---|
| 1 | 11 May 2026 |
Operations
GET Run job-profiles-healthcheck
- Description
-
This function will run job-profiles-healthcheck
- URL template
- /health/healthcheck
Show / Hide additional information
Response Codes
| Status code | Description |
|---|---|
| 200 | - |
GET Run job-profiles-ping
- Description
-
This function will run job-profiles-ping
- URL template
- /health/ping
Show / Hide additional information
Response Codes
| Status code | Description |
|---|---|
| 200 | - |
GET Run job-profiles-search
- Description
-
This function will run job-profiles-search
- URL template
- /search/{searchTerm}
Show / Hide additional information
Parameters
| Name | Type | Location | Field | Description |
|---|---|---|---|---|
| searchTerm | string | Path | Required | - |
Response Codes
| Status code | Description |
|---|---|
| 200 | - |
GET Run summary
- Description
-
This function will run summary
- URL template
- /summary
Show / Hide additional information
Response Codes
| Status code | Description |
|---|---|
| 200 | - |
GET Run Zjob-profiles-detail
- Description
-
This function will run Zjob-profiles-detail
- URL template
- /{canonicalName}
Show / Hide additional information
Parameters
| Name | Type | Location | Field | Description |
|---|---|---|---|---|
| canonicalName | string | Path | Required | - |
Response Codes
| Status code | Description |
|---|---|
| 200 | - |
Back to top