{ "openapi": "3.0.0", "info": { "title": "enrola API", "description": "The enrola API lets your systems work with your organisation's data in enrola. You can list your live\nopportunities to show them on your own website, add opportunities, employers, employer contacts and\napplications, and read applications back.\n\nEverything on this page describes the API as it works today. The machine-readable OpenAPI document is\nat [\/api\/doc.json](\/api\/doc.json), so you can import it into Postman or generate a client from it.\n\n## Getting started\n\n1. **Get credentials.** Ask your enrola contact for an API `client_id` and `client_secret` for your\n organisation, and your organisation's ID.\n2. **Request an access token** from your server:\n\n ```\n curl \"https:\/\/app.enrola.co.uk\/api\/v1\/get-token?client_id=CLIENT_ID&client_secret=CLIENT_SECRET\"\n ```\n\n ```json\n { \"status\": \"success\", \"data\": { \"token\": \"ACCESS_TOKEN\" }, \"code\": 200 }\n ```\n3. **Call the API** with the token:\n\n ```\n curl -H \"Authorization: Bearer ACCESS_TOKEN\" \\\n \"https:\/\/app.enrola.co.uk\/api\/v1\/applications?organisation_id=123&limit=20\"\n ```\n\nThe examples use the production address. If you were given credentials for the test site, use\n`https:\/\/test.enrola.co.uk` instead.\n\n## Authentication\n\n- An access token lasts **24 hours**. When it expires, request a new one from `get-token`; there are\n no refresh tokens.\n- Send the token in an `Authorization: Bearer ACCESS_TOKEN` header. The `access_token` query parameter\n also works, but query strings are often written to logs, so prefer the header. Use one or the other\n in a request, not both.\n- `get-token` takes your client secret in the query string. Only call it from your own server, never\n from a browser or a mobile app, and never put the secret in client-side code.\n- **List opportunities** and **Opportunity details** also work without a token, so a website can show\n your live jobs directly. With a token, Opportunity details returns some extra fields.\n\n## Responses\n\nEvery response uses the same envelope, based on [JSend](https:\/\/github.com\/omniti-labs\/jsend):\n\n| Field | Meaning |\n|---|---|\n| `status` | `success`, or `error` when the request could not be completed |\n| `data` | The result. On an error, often the field or value that caused it |\n| `message` | A human-readable error message. Only present on errors |\n| `code` | The HTTP status code, repeated in the body |\n\n```json\n{ \"status\": \"error\", \"message\": \"Organisation not found\", \"data\": { \"organisation_id\": \"999\" }, \"code\": 400 }\n```\n\n## Errors\n\n| HTTP status | When |\n|---|---|\n| `400` | A parameter is missing or invalid. `data` says which one |\n| `401` | The access token is invalid or has expired. This response comes from the OAuth layer and has an `error` and `error_description` instead of the envelope |\n| `403` | No access token was sent, or your organisation does not have access to the record |\n| `404` | The record does not exist, or belongs to another organisation |\n| `500` | Something went wrong on our side. The message is always `Internal error` |\n\n## Sending data\n\nSend `POST` bodies as `application\/x-www-form-urlencoded` form fields, as shown on each endpoint, or as\na JSON object with `Content-Type: application\/json`. Dates use the `YYYY-MM-DD` format.\n\nFiles (CVs and file custom fields) can be sent as base64 content with a file name, or as an `https`\nURL that enrola downloads. Downloaded files must be 20 MB or smaller and come from a public host.\n\n## Lists and paging\n\n- **List applications** pages with `offset` (default 0) and `limit` (default 20, maximum 200).\n- **List opportunities** returns all of an organisation's live opportunities, up to 5,000, without\n paging.\n\n## Trying requests from this page\n\nThe **Test Request** button sends real requests to the site you are reading this on. On\n`app.enrola.co.uk` that is your live data: a test `POST` creates a real record. Use the test site to\nexperiment.\n\n## Changelog\n\n- **October 2026:** New documentation viewer, the OpenAPI document published at `\/api\/doc.json`, and\n documented authentication, response envelope and errors. The API itself did not change.\n- **September 2026:** Files can be sent by URL (`resume_url`, `custom_fields_values[][file_url]`).\n Opportunities gained salary ranges (`salary_minimum`, `salary_maximum`, `salary_interval`).\n", "version": "1.0.0" }, "paths": { "\/api\/v1\/get-token": { "get": { "tags": [ "Authentication" ], "summary": "Get an access token", "description": "Exchanges your API client credentials for an access token that lasts 24 hours. Call this from your server only: the client secret travels in the query string.", "operationId": "getToken", "parameters": [ { "name": "client_id", "in": "query", "description": "Your API client ID.", "required": true, "schema": { "type": "string" } }, { "name": "client_secret", "in": "query", "description": "Your API client secret.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The access token.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/GetTokenResponse" } }, "type": "object" } ] }, "example": { "status": "success", "data": { "token": "ACCESS_TOKEN" }, "code": 200 } } } }, "403": { "description": "The client ID or secret is wrong.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiError" } } } } }, "security": [] } }, "\/api\/v1\/opportunities": { "get": { "tags": [ "Opportunities" ], "summary": "List opportunities", "description": "Lists an organisation's live opportunities on the enrola job board, up to 5,000, without paging. Works without an access token, so a website can show the organisation's jobs.", "operationId": "listOpportunities", "parameters": [ { "name": "organisation_id", "in": "query", "description": "The organisation whose opportunities to list.", "required": true, "schema": { "type": "integer" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "default": "heading", "enum": [ "heading", "start_from" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] } }, { "name": "fulltext", "in": "query", "description": "Only return opportunities matching this text.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The organisation's live opportunities.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity" } } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" } }, "security": [ {}, { "bearer": [] }, { "access_token": [] } ] } }, "\/api\/v1\/opportunities\/detail\/{opportunityId}": { "get": { "tags": [ "Opportunities" ], "summary": "Opportunity details", "description": "Returns one opportunity, including the URL candidates use to apply. Works without an access token. With one, the response also includes number_of_applications and usage_of_workflow_statuses.", "operationId": "getOpportunity", "parameters": [ { "name": "opportunityId", "in": "path", "description": "The opportunity's public ID.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "The opportunity.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/Opportunity2" } }, "type": "object" } ] } } } }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "404": { "$ref": "#\/components\/responses\/NotFound" }, "500": { "$ref": "#\/components\/responses\/ServerError" } }, "security": [ {}, { "bearer": [] }, { "access_token": [] } ] } }, "\/api\/v1\/opportunities\/add": { "post": { "tags": [ "Opportunities" ], "summary": "Add opportunity", "operationId": "addOpportunity", "requestBody": { "description": "Form data", "content": { "application\/x-www-form-urlencoded": { "schema": { "required": [ "heading", "type_id", "employer_id" ], "properties": { "heading": { "description": "Opportunity Title.", "type": "string" }, "type_id": { "type": "integer" }, "employer_id": { "type": "integer" }, "excerpt": { "description": "Short Description for the Opportunity.", "type": "string" }, "body": { "description": "Main Description for the Opportunity.", "type": "string" }, "requirements": { "description": "Entry Requirements for the Opportunity.", "type": "string" }, "categories": { "description": "One or more categories (ID).", "type": "array", "items": { "type": "integer" } }, "sectors": { "description": "Sector\/s IDs for the Opportunity.", "type": "array", "items": { "type": "integer" } }, "apply_from": { "description": "Opening date for Applications to the Opportunity.", "type": "string" }, "apply_to": { "description": "Closing date for Applications to the Opportunity.", "type": "string" }, "start_from": { "description": "Opportunity start date.", "type": "string" }, "number_of_learners": { "description": "Number of places on the vacancy.", "type": "integer" }, "working_week": { "description": "Number of working hours per week.", "type": "string" }, "working_hours": { "description": "Number of working hours in a day.", "type": "string" }, "hours_per_week": { "description": "Number of hours per week, has to be between 16 - 48, can be null.", "type": "number" }, "things_to_consider": { "description": "Things to consider", "type": "string" }, "skills_required": { "description": "Skills Required.", "type": "string" }, "personal_qualities": { "description": "Personal Qualities.", "type": "string" }, "future_prospects": { "description": "Future Prospects.", "type": "string" }, "salary": { "description": "Starting salary", "type": "number" }, "salary_minimum": { "description": "Minimum salary for an optional salary range.", "type": "number" }, "salary_maximum": { "description": "Maximum salary for an optional salary range.", "type": "number" }, "salary_interval": {}, "address[street]": { "type": "string" }, "address[city]": { "type": "string" }, "address[ward]": { "type": "string" }, "address[district]": { "type": "string" }, "address[county]": { "type": "string" }, "address[country]": { "type": "string" }, "address[postcode]": { "type": "string" }, "nas_contracted_provider_ern": { "type": "number" }, "nas_standard_code": { "type": "number" }, "postcode": { "description": "DEPRECATED - use address[postcode] instead; Location Postcode", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The opportunity was created.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "properties": { "id": { "type": "integer", "example": 1234 }, "publicId": { "description": "Use this ID with Opportunity details.", "type": "string" } }, "type": "object" } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "403": { "$ref": "#\/components\/responses\/Forbidden" }, "500": { "$ref": "#\/components\/responses\/ServerError" } } } }, "\/api\/v1\/applications": { "get": { "tags": [ "Applications" ], "summary": "List applications", "description": "Lists an organisation's applications, newest first by default. Page through them with offset and limit.", "operationId": "listApplications", "parameters": [ { "name": "organisation_id", "in": "query", "required": true, "schema": { "type": "integer" } }, { "name": "opportunity_public_id", "in": "query", "description": "Only return applications to this opportunity.", "required": false, "schema": { "type": "string" } }, { "name": "workflow_status_name", "in": "query", "description": "Only return applications at this workflow status.", "required": false, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "How many applications to skip.", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "limit", "in": "query", "description": "How many applications to return.", "required": false, "schema": { "type": "integer", "default": 20, "maximum": 200, "minimum": 1 } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "type": "string", "default": "id", "enum": [ "id", "firstName", "lastName" ] } }, { "name": "order", "in": "query", "required": false, "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] } }, { "name": "search", "in": "query", "description": "Only return applications matching this text.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of applications.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Application" } } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "403": { "$ref": "#\/components\/responses\/Forbidden" } } } }, "\/api\/v1\/applications\/detail\/{applicationId}": { "get": { "tags": [ "Applications" ], "summary": "Application details", "operationId": "getApplication", "parameters": [ { "name": "applicationId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The application.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/Application2" } }, "type": "object" } ] } } } }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "403": { "$ref": "#\/components\/responses\/Forbidden" }, "404": { "$ref": "#\/components\/responses\/NotFound" } } } }, "\/api\/v1\/applications\/list-custom-fields": { "get": { "tags": [ "Applications" ], "summary": "List application custom fields", "description": "Lists the custom fields an organisation's applications can have. Send values for them with Add application, in custom_fields_values.", "operationId": "listApplicationCustomFields", "parameters": [ { "name": "organisation_id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The organisation's application custom fields.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/FormFieldType" } } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "403": { "$ref": "#\/components\/responses\/Forbidden" } } } }, "\/api\/v1\/applications\/add": { "post": { "tags": [ "Applications" ], "summary": "Add application", "operationId": "addApplication", "requestBody": { "description": "Form data", "content": { "application\/x-www-form-urlencoded": { "schema": { "required": [ "first_name", "last_name", "email", "birth_date", "postcode", "opportunity_id", "job_board_id" ], "properties": { "title": { "description": "Applicant's Title.", "type": "string" }, "first_name": { "description": "Applicant's First Name.", "type": "string" }, "middle_name": { "description": "Applicant's Middle Name\/s.", "type": "string" }, "last_name": { "description": "Applicant's Last Name.", "type": "string" }, "email": { "description": "Applicant's email address.", "type": "string" }, "phone": { "description": "Applicant's home phone number.", "type": "string" }, "mobile": { "description": "Applicant's mobile phone number.", "type": "string" }, "birth_date": { "description": "Applicant's birth date YYYY-MM-DD.", "type": "string" }, "national_insurance_number": { "description": "Applicant's National Insurance Number.", "type": "string" }, "nationality_id": { "description": "Applicant's Nationality.", "type": "integer" }, "country_of_origin": { "description": "Applicant's country of origin.", "type": "string" }, "employments[employer]": { "type": "string" }, "employments[job_title]": { "type": "string" }, "employments[duties]": { "type": "string" }, "employments[job_description]": {}, "employments[date_from]": { "type": "string" }, "employments[date_to]": { "type": "string" }, "personal_statement": { "description": "Applicant's Personal Statement.", "type": "string" }, "start_course_date": { "description": "Date when applicant start study on course (#1508) YYYY-MM-DD.", "type": "string" }, "end_course_date": { "description": "Date when applicant end study on course (#1508) YYYY-MM-DD.", "type": "string" }, "gender": { "description": "Applicant's Gender.", "type": "string" }, "passport_number": { "description": "Applicant's Passport number.", "type": "string" }, "place_of_issue": { "description": "Passport - place of issue.", "type": "string" }, "date_of_issue": { "description": "Passport date of issue (YYYY-MM-DD)." }, "date_of_expiry": { "description": "Passport date of expiry (YYYY-MM-DD).", "type": "string" }, "visa_issued_on": { "description": "Visa date of issue (YYYY-MM-DD).", "type": "string" }, "visa_number": { "description": "Applicant's Visa Number.", "type": "string" }, "visa_expiring_on": { "description": "Visa date of expiry (YYYY-MM-DD).", "type": "string" }, "emergency_contact_name": { "description": "Emergency Contact Number.", "type": "string" }, "emergency_contact_number": { "description": "Emergency Contact Number.", "type": "string" }, "emergency_contact_relationship": { "description": "Emergency Contact Relationship.", "type": "string" }, "ethnic_origin": { "description": "Applicant's Ethnic Origin (preset Govt list).", "type": "integer" }, "hobbies_and_interests": { "description": "Applicant's Hobbies and Interests.", "type": "string" }, "school_at_age16": { "description": "School Applicant attended at 16.", "type": "string" }, "place_of_birth": { "description": "Applicant's place of birth.", "type": "string" }, "disabilities[code]": { "type": "string" }, "ambitions": { "description": "What are the Applicant's Ambitions for the future.", "type": "string" }, "skills": { "description": "What are the Applicant's main Skills.", "type": "string" }, "strengths": { "description": "What are the Applicant's main Strengths.", "type": "string" }, "why_work": { "description": "Reason\/s why the Applicant wishes to work for the Employer.", "type": "string" }, "relevant_experience": { "description": "Applicant's non-employment experience that is relevant to the Opportunity applied for.", "type": "string" }, "valid_driving_licence": { "description": "Does the Applicant have a driving license.", "type": "boolean" }, "own_car": { "description": "Does the Applicant have a car\/vehicle.", "type": "boolean" }, "address": { "description": "Applicant's postal address.", "type": "string" }, "city": { "description": "Applicant's town\/city of residence.", "type": "string" }, "country": { "description": "Applicant's country of residence.", "type": "string" }, "county": { "description": "Applicant's county.", "type": "string" }, "postcode": { "description": "Applicant's postcode.", "type": "string" }, "opportunity_id": { "type": "integer" }, "job_board_id": { "type": "integer" }, "supervisor_id": { "type": "integer" }, "custom_fields_values[][id]": { "description": "Custom field ID.", "type": "number" }, "custom_fields_values[][value]": { "description": "Custom field value. For a File custom field, the base64-encoded file content, sent with file_name. Send either value or file_url.", "type": "string" }, "custom_fields_values[][file_url]": { "description": "File custom fields only: an https URL enrola downloads the file from and stores a copy of. The host must be public; up to 3 redirects are followed; the file must be 20 MB or smaller and of a type the field allows. Send either value or file_url.", "type": "string" }, "custom_fields_values[][file_name]": { "description": "File custom fields only: the file's name, including its extension. Required with a base64 value; optional with file_url, which otherwise uses the name the server gives or the last part of the URL path.", "type": "string" }, "resume_url": { "description": "An https URL of the applicant's CV. enrola downloads the file and stores a copy. The host must be public; up to 3 redirects are followed; the file must be 20 MB or smaller and a PDF, Word (doc, docx), OpenDocument text (odt), RTF or plain text file. Cannot be combined with resume_system_file_name or resume_relative_file_name.", "type": "string" }, "resume_file_name": { "description": "The CV's file name, including its extension. Optional; defaults to the name the server gives or the last part of the URL path.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The application was created.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/CreatedId" } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "403": { "$ref": "#\/components\/responses\/Forbidden" } } } }, "\/api\/v1\/employers\/detail\/{employerId}": { "get": { "tags": [ "Employers" ], "summary": "Employer details", "operationId": "getEmployer", "parameters": [ { "name": "employerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The employer.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/Employer" } }, "type": "object" } ] } } } }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "404": { "$ref": "#\/components\/responses\/NotFound" } } } }, "\/api\/v1\/employers": { "post": { "tags": [ "Employers" ], "summary": "Add employer", "operationId": "addEmployer", "requestBody": { "description": "Form data", "content": { "application\/x-www-form-urlencoded": { "schema": { "$ref": "#\/components\/schemas\/Employer2" } } } }, "responses": { "200": { "description": "The employer was created.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/CreatedId" } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "500": { "$ref": "#\/components\/responses\/ServerError" } } } }, "\/api\/v1\/employer-contacts\/{employerId}": { "get": { "tags": [ "Employers" ], "summary": "List employer contacts", "operationId": "listEmployerContacts", "parameters": [ { "name": "employerId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "The employer's contacts.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployerContact" } } }, "type": "object" } ] } } } }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "404": { "$ref": "#\/components\/responses\/NotFound" } } } }, "\/api\/v1\/employer-contacts\/add": { "post": { "tags": [ "Employers" ], "summary": "Add employer contact", "operationId": "addEmployerContact", "requestBody": { "description": "Form data", "content": { "application\/x-www-form-urlencoded": { "schema": { "required": [ "first_name", "last_name", "email", "employer_id" ], "properties": { "title": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "employer_id": { "type": "integer" }, "job_title": { "type": "string" }, "phone": { "type": "string" }, "mobile": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "town": { "type": "string" }, "county": { "type": "string" }, "postcode": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "The contact was created.", "content": { "application\/json": { "schema": { "allOf": [ { "$ref": "#\/components\/schemas\/ApiSuccess" }, { "properties": { "data": { "$ref": "#\/components\/schemas\/CreatedId" } }, "type": "object" } ] } } } }, "400": { "$ref": "#\/components\/responses\/BadRequest" }, "401": { "$ref": "#\/components\/responses\/Unauthorized" }, "403": { "$ref": "#\/components\/responses\/Forbidden" }, "404": { "$ref": "#\/components\/responses\/NotFound" } } } } }, "components": { "schemas": { "ApiSuccess": { "description": "The envelope around every successful response. `data` holds the result.", "required": [ "status", "code" ], "properties": { "status": { "type": "string", "enum": [ "success" ] }, "code": { "type": "integer", "example": 200 } }, "type": "object" }, "ApiError": { "description": "The envelope around an error.", "required": [ "status", "message", "code" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Invalid parameters" }, "data": { "description": "The field or value that caused the error, when there is one.", "type": "object", "nullable": true, "additionalProperties": true }, "code": { "type": "integer", "example": 400 } }, "type": "object" }, "OAuthError": { "description": "Returned by the OAuth layer when an access token is invalid or has expired.", "properties": { "error": { "type": "string", "example": "invalid_grant" }, "error_description": { "type": "string", "example": "The access token provided is invalid." } }, "type": "object" }, "CreatedId": { "description": "The ID of the record that was created.", "properties": { "id": { "type": "integer", "example": 1234 } }, "type": "object" }, "GetTokenResponse": { "properties": { "token": { "title": "The access token. Send it with each request; it lasts 24 hours.", "type": "string" } }, "type": "object" }, "Opportunity": { "required": [ "heading" ], "properties": { "employer_name": { "title": "Employer", "type": "string" }, "city": { "title": "Town\/City", "type": "string" }, "postcode": { "title": "Postcode", "type": "string" }, "lat": { "title": "Latitude", "type": "number", "format": "float" }, "lon": { "title": "Longitude", "type": "number", "format": "float" }, "id": { "title": "Public ID.", "type": "string" }, "type": { "title": "Opportunity type.", "allOf": [ { "$ref": "#\/components\/schemas\/OpportunityType" } ] }, "heading": { "title": "Opportunity Title.", "type": "string" }, "apply_from": { "title": "Opening date for Applications to the Opportunity.", "type": "string", "format": "date-time" }, "apply_to": { "title": "Closing date for Applications to the Opportunity.", "type": "string", "format": "date-time" }, "start_from": { "title": "Opportunity start date.", "type": "string", "format": "date-time" }, "status": { "type": "string" }, "post_date": { "title": "Opportunity post date.", "type": "string", "format": "date-time" }, "salary_minimum": { "title": "Optional range for Indeed and the enrola iframe; other job boards use the minimum.", "type": "number", "format": "float", "maximum": 999999999, "minimum": 0 }, "salary_maximum": { "type": "number", "format": "float", "maximum": 999999999, "minimum": 0 }, "delivery_site": { "title": "Training Delivery Site.", "allOf": [ { "$ref": "#\/components\/schemas\/DeliverySite" } ] } }, "type": "object" }, "Opportunity2": { "required": [ "heading" ], "properties": { "internalId": { "title": "Opportunity Internal ID.", "type": "integer" }, "number_of_applications": { "type": "integer" }, "custom_fields_values": { "title": "Custom fields", "description": "Custom field", "type": "array", "items": { "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "value": { "type": "string" } } } }, "id": { "title": "Public ID.", "type": "string" }, "type": { "title": "Opportunity type.", "allOf": [ { "$ref": "#\/components\/schemas\/OpportunityType2" } ] }, "heading": { "title": "Opportunity Title.", "type": "string" }, "excerpt": { "title": "Short Description for the Opportunity.", "type": "string" }, "body": { "title": "Main Description for the Opportunity.", "type": "string" }, "requirements": { "title": "Entry Requirements for the Opportunity.", "type": "string" }, "categories": { "title": "One or more categories (ID).", "type": "array", "items": { "$ref": "#\/components\/schemas\/OpportunityCategory" } }, "sectors": { "title": "Sector\/s for the Opportunity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Sector" } }, "apply_from": { "title": "Opening date for Applications to the Opportunity.", "type": "string", "format": "date-time" }, "apply_to": { "title": "Closing date for Applications to the Opportunity.", "type": "string", "format": "date-time" }, "apply_url": { "title": "Application url.", "type": "string" }, "start_from": { "title": "Opportunity start date.", "type": "string", "format": "date-time" }, "status": { "type": "string" }, "post_date": { "title": "Opportunity post date.", "type": "string", "format": "date-time" }, "employer": { "title": "Employer.", "allOf": [ { "$ref": "#\/components\/schemas\/Employer3" } ] }, "number_of_learners": { "title": "Number of places on the vacancy.", "type": "integer" }, "working_week": { "title": "Number of working hours per week.", "type": "string" }, "hours_per_week": { "title": "Number of hours per week, has to be between 16 - 48, can be null.", "type": "number", "format": "float", "maximum": 48, "minimum": 16 }, "training_to_be_provided": { "type": "string" }, "expected_duration": { "title": "Expected duration of the Opportunity.", "type": "integer" }, "duration_type": { "title": "Duration type of the Opportunity.", "type": "string" }, "things_to_consider": { "title": "Things to consider", "type": "string" }, "skills_required": { "title": "Skills Required.", "type": "array", "items": { "type": "string" } }, "future_prospects": { "title": "Future Prospects.", "type": "string" }, "salary": { "title": "Starting salary", "type": "number", "format": "float" }, "salary_minimum": { "title": "Optional range for Indeed and the enrola iframe; other job boards use the minimum.", "type": "number", "format": "float", "maximum": 999999999, "minimum": 0 }, "salary_maximum": { "type": "number", "format": "float", "maximum": 999999999, "minimum": 0 }, "salary_interval": { "title": "Salary interval, must be \"day\", \"week\", \"month\", \"year\", default value is \"week\"", "type": "string" }, "career_map_level": { "type": "integer" }, "nas_standard": { "title": "NAS standard.", "allOf": [ { "$ref": "#\/components\/schemas\/NasStandard" } ] }, "nas_contact_email": { "title": "NAS contact email address.", "type": "string" }, "addresses": { "title": "Opportunity address", "allOf": [ { "$ref": "#\/components\/schemas\/ArrayCollection" } ] }, "delivery_site": { "title": "Training Delivery Site.", "allOf": [ { "$ref": "#\/components\/schemas\/DeliverySite2" } ] } }, "type": "object" }, "Application": { "required": [ "title", "first_name", "last_name", "email", "birth_date", "opportunity", "city", "postcode" ], "properties": { "id": { "title": "Unique ID for the application.", "type": "integer" }, "title": { "title": "Applicant's Title.", "type": "string" }, "first_name": { "title": "Applicant's First Name.", "type": "string" }, "middle_name": { "title": "Applicant's Middle Name\/s.", "type": "string" }, "last_name": { "title": "Applicant's Last Name.", "type": "string" }, "email": { "title": "Applicant's email address.", "type": "string" }, "phone": { "title": "Applicant's home phone number.", "type": "string" }, "mobile": { "title": "Applicant's mobile phone number.", "type": "string" }, "workflow_status": { "title": "Value of the current status for the application.", "allOf": [ { "$ref": "#\/components\/schemas\/WorkflowStatus" } ] }, "birth_date": { "title": "Applicant's birth date YYYY-MM-DD.", "type": "string", "format": "date-time", "maximum": 0, "exclusiveMaximum": true }, "national_insurance_number": { "title": "Applicant's National Insurance Number.", "type": "string" }, "country_of_origin": { "title": "Applicant's country of origin.", "type": "string" }, "job_board": { "title": "Value for Source of Application (Job Board if applicable).", "allOf": [ { "$ref": "#\/components\/schemas\/JobBoard" } ] }, "opportunity": { "$ref": "#\/components\/schemas\/Opportunity3" }, "uln": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "disabilities": { "title": "List of disabilities.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationDisability" } }, "address": { "title": "Applicant's postal address.", "type": "string" }, "city": { "title": "Applicant's town\/city of residence.", "type": "string" }, "country": { "title": "Applicant's country of residence.", "type": "string" }, "county": { "title": "Applicant's county.", "type": "string" }, "postcode": { "title": "Applicant's postcode.", "allOf": [ { "$ref": "#\/components\/schemas\/Location" } ] } }, "type": "object" }, "Application2": { "required": [ "title", "first_name", "last_name", "email", "birth_date", "opportunity", "city", "postcode" ], "properties": { "age_at_start_date": { "title": "Applicant's age when opportunity starts", "type": "integer" }, "custom_fields_values": { "title": "Custom fields", "description": "Custom field", "type": "array", "items": { "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "value": { "type": "string" } } } }, "id": { "title": "Unique ID for the application.", "type": "integer" }, "title": { "title": "Applicant's Title.", "type": "string" }, "first_name": { "title": "Applicant's First Name.", "type": "string" }, "middle_name": { "title": "Applicant's Middle Name\/s.", "type": "string" }, "last_name": { "title": "Applicant's Last Name.", "type": "string" }, "email": { "title": "Applicant's email address.", "type": "string" }, "phone": { "title": "Applicant's home phone number.", "type": "string" }, "mobile": { "title": "Applicant's mobile phone number.", "type": "string" }, "workflow_status": { "title": "Value of the current status for the application.", "allOf": [ { "$ref": "#\/components\/schemas\/WorkflowStatus2" } ] }, "birth_date": { "title": "Applicant's birth date YYYY-MM-DD.", "type": "string", "format": "date-time", "maximum": 0, "exclusiveMaximum": true }, "national_insurance_number": { "title": "Applicant's National Insurance Number.", "type": "string" }, "nationality": { "$ref": "#\/components\/schemas\/Nationality" }, "country_of_origin": { "title": "Applicant's country of origin.", "type": "string" }, "job_board": { "title": "Value for Source of Application (Job Board if applicable).", "allOf": [ { "$ref": "#\/components\/schemas\/JobBoard2" } ] }, "opportunity": { "$ref": "#\/components\/schemas\/Opportunity4" }, "qualifications": { "title": "List of LRS learning events.", "type": "array", "items": { "$ref": "#\/components\/schemas\/LRSLearningEvent" } }, "course_results": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CourseResult" } }, "uln": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "disabilities": { "title": "List of disabilities.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationDisability2" } }, "address": { "title": "Applicant's postal address.", "type": "string" }, "city": { "title": "Applicant's town\/city of residence.", "type": "string" }, "country": { "title": "Applicant's country of residence.", "type": "string" }, "county": { "title": "Applicant's county.", "type": "string" }, "postcode": { "title": "Applicant's postcode.", "allOf": [ { "$ref": "#\/components\/schemas\/Location2" } ] } }, "type": "object" }, "FormFieldType": { "properties": { "id": { "title": "Use this when referring to custom field, since custom field label is not unique", "type": "integer" }, "label": { "title": "Name of the field specified by user; shown to all users as-is", "type": "string" }, "field_class": { "title": "Specifies what HTML form type is used for this custom field", "type": "string" }, "required": { "title": "Specifies if user is forced to input non-blank value (admin area only)", "type": "boolean" }, "choices": { "title": "Choices available for this custom field", "type": "array", "items": { "$ref": "#\/components\/schemas\/FormFieldChoice" } } }, "type": "object" }, "Employer": { "required": [ "name", "contact" ], "properties": { "name": { "title": "Employer name.", "type": "string" }, "description": { "title": "Short description of the Employer.", "type": "string" }, "email": { "title": "Employer's email.", "type": "string" }, "website": { "title": "Employer website.", "type": "string" }, "contact": { "$ref": "#\/components\/schemas\/EmployerContact2" }, "external_id": { "title": "External ID.", "type": "string" }, "sic_code": { "type": "string" }, "filing_history_link": { "type": "string" }, "company_overview_link": { "type": "string" }, "officers_link": { "type": "string" }, "address": { "title": "Employer's address.", "type": "string" }, "ward": { "title": "Employer's ward.", "type": "string" }, "district": { "title": "Employer's district.", "type": "string" }, "city": { "title": "Employer's city.", "type": "string" }, "county": { "title": "Employer's county.", "type": "string" }, "country": { "title": "Employer's country.", "type": "string" }, "postcode": { "title": "Employer's postcode.", "type": "string" } }, "type": "object" }, "Employer2": { "required": [ "organisation_id", "name" ], "properties": { "organisation_id": { "title": "Organisation ID.", "type": "integer" }, "name": { "title": "Employer name.", "type": "string" }, "description": { "title": "Short description of the Employer.", "type": "string" }, "category": { "type": "string" }, "industry": { "type": "string" }, "email": { "title": "Employer's email.", "type": "string" }, "phone": { "title": "Employer's phone.", "type": "string" }, "website": { "title": "Employer website.", "type": "string" }, "company_number": { "type": "string" }, "annual_revenue": { "type": "string" }, "employees_number": { "type": "string" }, "vat_number": { "type": "string" }, "eds_urn": { "type": "integer" }, "sic_code": { "type": "string" }, "custom_fields_values[][id]": { "title": "Custom field ID", "type": "integer" }, "custom_fields_values[][value]": { "title": "Custom field value", "type": "string" }, "address": { "title": "Employer's address.", "type": "string" }, "ward": { "title": "Employer's ward.", "type": "string" }, "district": { "title": "Employer's district.", "type": "string" }, "city": { "title": "Employer's city.", "type": "string" }, "county": { "title": "Employer's county.", "type": "string" }, "country": { "title": "Employer's country.", "type": "string" }, "postcode": { "title": "Employer's postcode.", "type": "string" } }, "type": "object" }, "EmployerContact": { "required": [ "first_name", "last_name", "email" ], "properties": { "first_name": { "title": "Contact's First Name.", "type": "string" }, "last_name": { "title": "Contact's Last Name.", "type": "string" }, "email": { "title": "Email", "type": "string" }, "phone": { "title": "Phone", "type": "string" }, "mobile": { "title": "Mobile", "type": "string" } }, "type": "object" }, "OpportunityType": { "required": [ "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "visible_on_enrola_job_board": { "type": "boolean" } }, "type": "object" }, "DeliverySite": { "properties": { "id": { "type": "integer" }, "campus_name": { "type": "string" } }, "type": "object" }, "OpportunityType2": { "required": [ "name" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "visible_on_enrola_job_board": { "type": "boolean" } }, "type": "object" }, "OpportunityCategory": { "required": [ "name", "slug" ], "properties": { "id": { "type": "integer" }, "name": { "title": "Category name for the Opportunity.", "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "sort_order": { "type": "integer" }, "parent": { "$ref": "#\/components\/schemas\/Category" }, "children": { "$ref": "#\/components\/schemas\/Collection" }, "is_active": { "type": "boolean" }, "is_default": { "type": "boolean" }, "level": { "type": "integer" }, "opportunities": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity5" } }, "job_board_categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/JobBoardCategory" } } }, "type": "object" }, "Sector": { "required": [ "slug", "name" ], "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "name": { "title": "Sector's name for the Opportunity.", "type": "string" }, "job_board_sectors": { "type": "array", "items": { "$ref": "#\/components\/schemas\/JobBoardSector" } }, "opportunities": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity5" } } }, "type": "object" }, "Employer3": { "required": [ "name" ], "properties": { "id": { "title": "Unique enrola ID for the Employer.", "type": "integer" }, "name": { "title": "Employer name.", "type": "string" }, "description": { "title": "Short description of the Employer.", "type": "string" }, "email": { "title": "Employer's email.", "type": "string" }, "phone": { "title": "Employer's phone.", "type": "string" }, "address": { "title": "Employer's address.", "type": "string" }, "ward": { "title": "Employer's ward.", "type": "string" }, "district": { "title": "Employer's district.", "type": "string" }, "city": { "title": "Employer's city.", "type": "string" }, "county": { "title": "Employer's county.", "type": "string" }, "country": { "title": "Employer's country.", "type": "string" }, "postcode": { "title": "Employer's postcode.", "type": "string" } }, "type": "object" }, "NasStandard": { "properties": { "name": { "type": "string" }, "code": { "type": "integer" } }, "type": "object" }, "ArrayCollection": { "type": "object" }, "DeliverySite2": { "type": "object" }, "WorkflowStatus": { "required": [ "name" ], "properties": { "name": { "title": "Name of the current status for that application.", "type": "string" } }, "type": "object" }, "JobBoard": { "required": [ "name" ], "properties": { "name": { "title": "Name for Source of Application (Job Board if applicable).", "type": "string" } }, "type": "object" }, "Opportunity3": { "required": [ "heading" ], "properties": { "publicId": { "type": "string" }, "id": { "title": "Unique ID for the opportunity.", "type": "integer" }, "heading": { "title": "Opportunity Title.", "type": "string" }, "sectors": { "title": "Sector\/s for the Opportunity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Sector" } }, "employer": { "title": "Employer.", "allOf": [ { "$ref": "#\/components\/schemas\/Employer4" } ] }, "external_id": { "title": "External ID.", "type": "string" } }, "type": "object" }, "ApplicationDisability": { "properties": { "code": { "title": "Applicant's disabilities or learning difficulties (preset Govt list).", "type": "string" } }, "type": "object" }, "Location": { "required": [ "name" ], "properties": { "name": { "type": "string" } }, "type": "object" }, "WorkflowStatus2": { "required": [ "name" ], "properties": { "name": { "title": "Name of the current status for that application.", "type": "string" } }, "type": "object" }, "Nationality": { "properties": { "id": { "type": "integer" }, "slug": { "type": "string" } }, "type": "object" }, "JobBoard2": { "required": [ "name" ], "properties": { "name": { "title": "Name for Source of Application (Job Board if applicable).", "type": "string" } }, "type": "object" }, "Opportunity4": { "required": [ "heading" ], "properties": { "publicId": { "type": "string" }, "custom_fields_values": { "title": "Custom fields", "description": "Custom field", "type": "array", "items": { "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "value": { "type": "string" } } } }, "id": { "title": "Unique ID for the opportunity.", "type": "integer" }, "heading": { "title": "Opportunity Title.", "type": "string" }, "sectors": { "title": "Sector\/s for the Opportunity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Sector" } }, "employer": { "title": "Employer.", "allOf": [ { "$ref": "#\/components\/schemas\/Employer5" } ] }, "external_id": { "title": "External ID.", "type": "string" } }, "type": "object" }, "LRSLearningEvent": { "properties": { "achievement_award_date": { "type": "string", "format": "date-time" }, "subject": { "type": "string" }, "subject_code": { "type": "string" }, "level": { "type": "string" }, "grade": { "type": "string" } }, "type": "object" }, "CourseResult": { "properties": { "course_name": { "type": "string" }, "level": { "type": "string" }, "score": { "type": "string" }, "date_achieved": { "type": "string", "format": "date-time" } }, "type": "object" }, "ApplicationDisability2": { "properties": { "code": { "title": "Applicant's disabilities or learning difficulties (preset Govt list).", "type": "string" } }, "type": "object" }, "Location2": { "required": [ "name" ], "properties": { "name": { "type": "string" } }, "type": "object" }, "FormFieldChoice": { "required": [ "value" ], "properties": { "value": { "title": "Label of the choice specified by user; shown to all users as-is.", "description": "Values here are acceptable when referring to choices of specific custom field.", "type": "string" } }, "type": "object" }, "EmployerContact2": { "required": [ "first_name", "last_name" ], "properties": { "first_name": { "title": "Contact's First Name.", "type": "string" }, "last_name": { "title": "Contact's Last Name.", "type": "string" } }, "type": "object" }, "Category": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "sort_order": { "type": "integer" }, "parent": { "$ref": "#\/components\/schemas\/Category" }, "children": { "$ref": "#\/components\/schemas\/Collection" }, "is_active": { "type": "boolean" }, "is_default": { "type": "boolean" } }, "type": "object" }, "Collection": { "type": "object" }, "Opportunity5": { "required": [ "heading" ], "properties": { "internalId": { "title": "Opportunity Internal ID.", "type": "integer" }, "number_of_applications": { "type": "integer" }, "employer_name": { "title": "Employer", "type": "string" }, "city": { "title": "Town\/City", "type": "string" }, "postcode": { "title": "Postcode", "type": "string" }, "lat": { "title": "Latitude", "type": "number", "format": "float" }, "lon": { "title": "Longitude", "type": "number", "format": "float" }, "publicId": { "type": "string" }, "custom_fields_values": { "title": "Custom fields", "description": "Custom field", "type": "array", "items": { "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "value": { "type": "string" } } } }, "id": { "title": "Unique ID for the opportunity.", "type": "integer" }, "organisation": { "title": "Organisation (ID).", "allOf": [ { "$ref": "#\/components\/schemas\/Organisation" } ] }, "type": { "title": "Opportunity type.", "allOf": [ { "$ref": "#\/components\/schemas\/OpportunityType3" } ] }, "heading": { "title": "Opportunity Title.", "type": "string" }, "excerpt": { "title": "Short Description for the Opportunity.", "type": "string" }, "body": { "title": "Main Description for the Opportunity.", "type": "string" }, "requirements": { "title": "Entry Requirements for the Opportunity.", "type": "string" }, "categories": { "title": "One or more categories (ID).", "type": "array", "items": { "$ref": "#\/components\/schemas\/OpportunityCategory" } }, "sectors": { "title": "Sector\/s for the Opportunity.", "type": "array", "items": { "$ref": "#\/components\/schemas\/Sector" } }, "apply_from": { "title": "Opening date for Applications to the Opportunity.", "type": "string", "format": "date-time" }, "apply_to": { "title": "Closing date for Applications to the Opportunity.", "type": "string", "format": "date-time" }, "apply_url": { "title": "Application url.", "type": "string" }, "start_from": { "title": "Opportunity start date.", "type": "string", "format": "date-time" }, "labels": { "$ref": "#\/components\/schemas\/OpportunityLabel" }, "status": { "type": "string" }, "post_date": { "title": "Opportunity post date.", "type": "string", "format": "date-time" }, "employer": { "title": "Employer.", "allOf": [ { "$ref": "#\/components\/schemas\/Employer6" } ] }, "number_of_learners": { "title": "Number of places on the vacancy.", "type": "integer" }, "working_week": { "title": "Number of working hours per week.", "type": "string" }, "hours_per_week": { "title": "Number of hours per week, has to be between 16 - 48, can be null.", "type": "number", "format": "float", "maximum": 48, "minimum": 16 }, "training_to_be_provided": { "type": "string" }, "expected_duration": { "title": "Expected duration of the Opportunity.", "type": "integer" }, "duration_type": { "title": "Duration type of the Opportunity.", "type": "string" }, "things_to_consider": { "title": "Things to consider", "type": "string" }, "skills_required": { "title": "Skills Required.", "type": "array", "items": { "type": "string" } }, "future_prospects": { "title": "Future Prospects.", "type": "string" }, "external_id": { "title": "External ID.", "type": "string" }, "salary": { "title": "Starting salary", "type": "number", "format": "float" }, "salary_minimum": { "title": "Optional range for Indeed and the enrola iframe; other job boards use the minimum.", "type": "number", "format": "float", "maximum": 999999999, "minimum": 0 }, "salary_maximum": { "type": "number", "format": "float", "maximum": 999999999, "minimum": 0 }, "salary_interval": { "title": "Salary interval, must be \"day\", \"week\", \"month\", \"year\", default value is \"week\"", "type": "string" }, "career_map_level": { "type": "integer" }, "nas_standard": { "title": "NAS standard.", "allOf": [ { "$ref": "#\/components\/schemas\/NasStandard2" } ] }, "nas_contact_email": { "title": "NAS contact email address.", "type": "string" }, "supervisors": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "minItems": 1 }, "info_requests": { "title": "More info requests.", "type": "array", "items": { "$ref": "#\/components\/schemas\/OpportunityRequestInfo" } }, "addresses": { "title": "Opportunity address", "allOf": [ { "$ref": "#\/components\/schemas\/ArrayCollection" } ] }, "delivery_site": { "title": "Training Delivery Site.", "allOf": [ { "$ref": "#\/components\/schemas\/DeliverySite3" } ] } }, "type": "object" }, "JobBoardCategory": { "required": [ "name", "remote_id", "job_board", "opportunity_category" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "remote_id": { "type": "string" }, "job_board": { "$ref": "#\/components\/schemas\/JobBoard3" }, "opportunity_category": { "$ref": "#\/components\/schemas\/OpportunityCategory" } }, "type": "object" }, "JobBoardSector": { "required": [ "name", "remote_id", "job_board", "sector" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "remote_id": { "type": "string" }, "job_board": { "$ref": "#\/components\/schemas\/JobBoard3" }, "sector": { "$ref": "#\/components\/schemas\/Sector" } }, "type": "object" }, "Employer4": { "required": [ "name" ], "properties": { "id": { "title": "Unique enrola ID for the Employer.", "type": "integer" }, "name": { "title": "Employer name.", "type": "string" } }, "type": "object" }, "Employer5": { "required": [ "name" ], "properties": { "id": { "title": "Unique enrola ID for the Employer.", "type": "integer" }, "name": { "title": "Employer name.", "type": "string" } }, "type": "object" }, "Organisation": { "type": "object" }, "OpportunityType3": { "required": [ "name" ], "properties": { "id": { "type": "integer" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" }, "opportunities": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity5" } }, "name": { "type": "string" }, "workflow_statuses": { "type": "array", "items": { "$ref": "#\/components\/schemas\/WorkflowStatus3" } }, "fe_form_configs": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationFeFormConfig" } }, "new_application_email_subject": { "type": "string" }, "new_application_email_template": { "type": "string" }, "deletable": { "type": "boolean" }, "type": { "type": "string" }, "visible_on_enrola_job_board": { "type": "boolean" } }, "type": "object" }, "OpportunityLabel": { "required": [ "name", "color" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string", "maxLength": 7, "minLength": 4, "pattern": ".*(^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$).*" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" } }, "type": "object" }, "Employer6": { "required": [ "organisation", "organisation_id", "name", "contact", "submitted_feedback_survey_at", "contract_document", "certificate_document_expires_at" ], "properties": { "custom_fields_values": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployerCustomFieldValue" } }, "id": { "title": "Unique enrola ID for the Employer.", "type": "integer" }, "unique_id": { "title": "Public ID.", "type": "string" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" }, "organisation_id": { "title": "Organisation ID.", "type": "integer" }, "name": { "title": "Employer name.", "type": "string" }, "description": { "title": "Short description of the Employer.", "type": "string" }, "category": { "type": "string" }, "industry": { "type": "string" }, "email": { "title": "Employer's email.", "type": "string" }, "phone": { "title": "Employer's phone.", "type": "string" }, "full_company_name": { "type": "string" }, "website": { "title": "Employer website.", "type": "string" }, "logo": { "$ref": "#\/components\/schemas\/EmployerLogo" }, "company_number": { "type": "string" }, "annual_revenue": { "type": "string" }, "employees_number": { "type": "string" }, "vat_number": { "type": "string" }, "opportunities": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity5" } }, "users": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" }, "minItems": 1 }, "contacts": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployerContact3" } }, "contact": { "$ref": "#\/components\/schemas\/EmployerContact3" }, "first_application_date": { "type": "string", "format": "date-time" }, "external_id": { "title": "External ID.", "type": "string" }, "eds_urn": { "type": "integer" }, "status": { "type": "string" }, "apprenticeship_levy": { "type": "string" }, "sic_code": { "type": "string" }, "filing_history_link": { "type": "string" }, "company_overview_link": { "type": "string" }, "officers_link": { "type": "string" }, "feedback_requester": { "title": "User who sent a reauest for employer's feedback.", "allOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "feedback_supported_job_advert": { "type": "string" }, "feedback_candidates_screened": { "type": "string" }, "feedback_accurate_summary": { "type": "string" }, "feedback_service_responsive": { "type": "string" }, "feedback_weekly_updated": { "type": "string" }, "feedback_overall_rate": { "type": "string" }, "feedback_other_comments": { "type": "string" }, "submitted_feedback_survey_at": { "type": "string", "format": "date-time" }, "labels": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployerLabel" } }, "workflow_status": { "$ref": "#\/components\/schemas\/WorkflowStatusEmployer" }, "custom_fields_values[][id]": { "title": "Custom field ID", "type": "integer" }, "custom_fields_values[][value]": { "title": "Custom field value", "type": "string" }, "address": { "title": "Employer's address.", "type": "string" }, "ward": { "title": "Employer's ward.", "type": "string" }, "district": { "title": "Employer's district.", "type": "string" }, "city": { "title": "Employer's city.", "type": "string" }, "county": { "title": "Employer's county.", "type": "string" }, "country": { "title": "Employer's country.", "type": "string" }, "postcode": { "title": "Employer's postcode.", "type": "string" }, "liability_insurance_certificate_document": { "$ref": "#\/components\/schemas\/EmployerDocument" }, "health_and_safety_assessment_document": { "$ref": "#\/components\/schemas\/EmployerDocument" }, "contract_document": { "$ref": "#\/components\/schemas\/EmployerDocument" }, "certificate_document_expires_at": { "type": "string", "format": "date-time" }, "request_info": { "$ref": "#\/components\/schemas\/EmployerRequestInfo" }, "request_liability_insurance_certificate": { "$ref": "#\/components\/schemas\/EmployerRequestInfo" }, "liability_insurer": { "title": "Employer Liability Insurer", "type": "string" }, "policy_number": { "title": "Policy Number", "type": "string" }, "eligible_for1618_incentive": { "title": "Eligible for 16-18 incentive", "type": "boolean" }, "agreement_identifier_reference": { "title": "Agreement Identifier Reference (DAS)", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "NasStandard2": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "type": "integer" }, "max_funding": { "type": "integer" }, "course_type": { "title": "The Recruitment API course type, for example Standard or Foundation.", "description": "This is synchronised from NAS reference data for each provider UKPRN.", "type": "string" } }, "type": "object" }, "User": { "required": [ "email" ], "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "enabled": { "type": "boolean" }, "email": { "type": "string", "pattern": "[a-zA-Z0-9_.\\-@]+" }, "plain_password": { "type": "string" }, "password": { "type": "string" }, "salt": { "type": "string" }, "phone": { "type": "string" }, "client": { "$ref": "#\/components\/schemas\/Client" }, "visible_table_columns": { "title": "Visible columns in tables", "type": "object", "additionalProperties": true }, "minimized_panels": { "title": "Hidden Summary Panels (Dashboards) in Dashboard, Opportunities, Applications, Employers sections", "type": "object", "additionalProperties": true }, "reset_password_hash": { "type": "string" }, "reset_password_expires_at": { "type": "string", "format": "date-time" }, "email_auth_code": { "type": "string" }, "email_auth_code_expires_at": { "type": "string", "format": "date-time" }, "created_by": { "$ref": "#\/components\/schemas\/User" }, "access_tokens": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AccessToken" } }, "visible_panels": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserVisiblePanels" } }, "saved_searches": { "$ref": "#\/components\/schemas\/Collection" }, "accounts": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserAccountLookup" } }, "marketing_enabled": { "type": "boolean" }, "role": { "type": "string" }, "opportunities": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Opportunity5" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "OpportunityRequestInfo": { "required": [ "fields", "token", "opportunity" ], "properties": { "id": { "type": "integer" }, "token": { "type": "string" }, "response_at": { "type": "string", "format": "date-time" }, "merged_at": { "type": "string", "format": "date-time" }, "created_by": { "$ref": "#\/components\/schemas\/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "opportunity": { "title": "Opportunity (ID)", "allOf": [ { "$ref": "#\/components\/schemas\/Opportunity5" } ] } }, "type": "object" }, "DeliverySite3": { "properties": { "id": { "type": "integer" }, "campus_name": { "type": "string" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" } }, "type": "object" }, "JobBoard3": { "required": [ "name" ], "properties": { "name": { "title": "Name for Source of Application (Job Board if applicable).", "type": "string" } }, "type": "object" }, "WorkflowStatus3": { "required": [ "name", "type" ], "properties": { "id": { "type": "integer" }, "name": { "title": "Name of the current status for that application.", "type": "string" }, "type": { "type": "string" }, "subject": { "type": "string" }, "template": { "type": "string" }, "opportunity_type": { "title": "Opportunity type.", "allOf": [ { "$ref": "#\/components\/schemas\/OpportunityType3" } ] }, "order_number": { "type": "integer" }, "applications": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Application3" } }, "deleted": { "type": "boolean" } }, "type": "object" }, "ApplicationFeFormConfig": { "properties": { "id": { "type": "integer" }, "opportunity_type": { "$ref": "#\/components\/schemas\/OpportunityType3" }, "workflow_status": { "$ref": "#\/components\/schemas\/WorkflowStatus3" }, "panel_name": { "title": "Panel name", "type": "string" }, "field_name": { "title": "Field name", "type": "string" }, "required": { "type": "boolean" }, "minimum_characters": { "type": "integer" }, "custom_field": { "$ref": "#\/components\/schemas\/FormFieldType" }, "custom_panel": { "$ref": "#\/components\/schemas\/CustomPanel" } }, "type": "object" }, "EmployerCustomFieldValue": { "properties": { "id": { "type": "integer" }, "custom_field": { "$ref": "#\/components\/schemas\/FormFieldType" }, "value": { "type": "string" }, "entity": { "$ref": "#\/components\/schemas\/Employer6" } }, "type": "object" }, "EmployerLogo": { "properties": { "name": { "type": "string" }, "size": { "type": "integer" }, "id": { "type": "integer" }, "file_system_name": { "type": "string" }, "mime_type": { "type": "string" }, "adapter": { "type": "string" }, "parent": { "$ref": "#\/components\/schemas\/File" }, "default_thumb": { "type": "boolean" }, "custom_path": { "type": "string" }, "max_files": { "type": "integer" }, "naming_convention": { "type": "integer" }, "any_mime_type_allowed": { "type": "boolean" } }, "type": "object" }, "EmployerContact3": { "required": [ "first_name", "last_name", "email", "employer" ], "properties": { "custom_fields_values": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployerContactCustomFieldValue" } }, "id": { "type": "integer" }, "title": { "title": "Title", "type": "string", "enum": [ "Ms", "Miss", "Mrs", "Mr", "Mx" ] }, "first_name": { "title": "Contact's First Name.", "type": "string" }, "last_name": { "title": "Contact's Last Name.", "type": "string" }, "job_title": { "type": "string" }, "email": { "title": "Email", "type": "string" }, "phone": { "title": "Phone", "type": "string" }, "mobile": { "title": "Mobile", "type": "string" }, "fax": { "type": "string" }, "address": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "town": { "type": "string" }, "county": { "type": "string" }, "postcode": { "type": "string" }, "employer": { "$ref": "#\/components\/schemas\/Employer6" }, "labels": { "type": "array", "items": { "$ref": "#\/components\/schemas\/EmployerContactLabel" } }, "users": { "type": "array", "items": { "$ref": "#\/components\/schemas\/User" } }, "external_id": { "title": "External ID", "type": "string" }, "external_employer_id": { "title": "External ID", "type": "string" }, "workflow_status": { "$ref": "#\/components\/schemas\/WorkflowStatusEmployerContact" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "EmployerLabel": { "required": [ "name", "color" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string", "maxLength": 7, "minLength": 4, "pattern": ".*(^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$).*" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" } }, "type": "object" }, "WorkflowStatusEmployer": { "required": [ "name", "type" ], "properties": { "id": { "type": "integer" }, "name": { "title": "Name of the current status for that application.", "type": "string" }, "type": { "type": "string" }, "subject": { "type": "string" }, "template": { "type": "string" }, "organisation": { "title": "Opportunity type.", "allOf": [ { "$ref": "#\/components\/schemas\/Organisation" } ] }, "order_number": { "type": "integer" }, "deleted": { "type": "boolean" } }, "type": "object" }, "EmployerDocument": { "properties": { "name": { "type": "string" }, "size": { "type": "integer" }, "id": { "type": "integer" }, "file_system_name": { "type": "string" }, "mime_type": { "type": "string" }, "adapter": { "type": "string" }, "parent": { "$ref": "#\/components\/schemas\/File" }, "default_thumb": { "type": "boolean" }, "custom_path": { "type": "string" }, "max_files": { "type": "integer" }, "naming_convention": { "type": "integer" }, "any_mime_type_allowed": { "type": "boolean" } }, "type": "object" }, "EmployerRequestInfo": { "required": [ "fields" ], "properties": { "token": { "type": "string" }, "requested_at": { "type": "string", "format": "date-time" }, "submitted_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "Client": { "properties": { "id": { "type": "integer" }, "user": { "$ref": "#\/components\/schemas\/User" } }, "type": "object" }, "AccessToken": { "properties": { "id": { "type": "integer" }, "client": { "$ref": "#\/components\/schemas\/Client" }, "user": { "$ref": "#\/components\/schemas\/User" } }, "type": "object" }, "UserVisiblePanels": { "properties": { "id": { "type": "integer" }, "user": { "$ref": "#\/components\/schemas\/User" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" }, "visible_panels": { "title": "Visible panels in opportunity\/application\/employer section", "type": "object", "additionalProperties": true } }, "type": "object" }, "UserAccountLookup": { "properties": { "user": { "$ref": "#\/components\/schemas\/User" }, "account": { "$ref": "#\/components\/schemas\/Account" }, "type": { "type": "string" }, "id": { "type": "integer" } }, "type": "object" }, "Application3": { "required": [ "title", "first_name", "last_name", "email", "birth_date", "opportunity", "opportunity_external_id", "personal_statement", "city", "ward", "district", "postcode" ], "properties": { "age_at_start_date": { "title": "Applicant's age when opportunity starts", "type": "integer" }, "custom_fields_values": { "title": "Custom fields", "description": "Custom field", "type": "array", "items": { "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "value": { "type": "string" } } } }, "id": { "title": "Unique ID for the application.", "type": "integer" }, "title": { "title": "Applicant's Title.", "type": "string" }, "first_name": { "title": "Applicant's First Name.", "type": "string" }, "middle_name": { "title": "Applicant's Middle Name\/s.", "type": "string" }, "last_name": { "title": "Applicant's Last Name.", "type": "string" }, "email": { "title": "Applicant's email address.", "type": "string" }, "phone": { "title": "Applicant's home phone number.", "type": "string" }, "mobile": { "title": "Applicant's mobile phone number.", "type": "string" }, "workflow_status": { "title": "Value of the current status for the application.", "allOf": [ { "$ref": "#\/components\/schemas\/WorkflowStatus3" } ] }, "birth_date": { "title": "Applicant's birth date YYYY-MM-DD.", "type": "string", "format": "date-time", "maximum": 0, "exclusiveMaximum": true }, "national_insurance_number": { "title": "Applicant's National Insurance Number.", "type": "string" }, "nationality": { "$ref": "#\/components\/schemas\/Nationality2" }, "nationality_id": { "title": "Applicant's Nationality.", "type": "integer" }, "country_of_origin": { "title": "Applicant's country of origin.", "type": "string" }, "job_board": { "title": "Value for Source of Application (Job Board if applicable).", "allOf": [ { "$ref": "#\/components\/schemas\/JobBoard3" } ] }, "job_board_id": { "title": "Job board ID.", "type": "integer" }, "opportunity": { "$ref": "#\/components\/schemas\/Opportunity5" }, "opportunity_id": { "title": "Opportunity ID.", "type": "integer" }, "opportunity_external_id": { "title": "Opportunity External ID.", "type": "string" }, "supervisor": { "$ref": "#\/components\/schemas\/User" }, "supervisor_id": { "title": "Supervisor ID.", "type": "integer" }, "work history": { "title": "List of Applicant's employment history.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationEmployment" } }, "courses": { "title": "List of courses Applicant has taken.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationCourse" } }, "qualifications": { "title": "List of LRS learning events.", "type": "array", "items": { "$ref": "#\/components\/schemas\/LRSLearningEvent2" } }, "info_requests": { "title": "More info requests.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationRequestInfo" } }, "personal_statement": { "title": "Applicant's Personal Statement.", "type": "string" }, "logs": { "title": "List of logged events.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationLog" } }, "start_course_date": { "title": "Date when applicant start study on course (#1508) YYYY-MM-DD.", "type": "string", "format": "date-time" }, "end_course_date": { "title": "Date when applicant end study on course (#1508) YYYY-MM-DD.", "type": "string", "format": "date-time" }, "gender": { "title": "Applicant's Gender.", "type": "string" }, "passport_number": { "title": "Applicant's Passport number.", "type": "string" }, "place_of_issue": { "title": "Passport - place of issue.", "type": "string" }, "date_of_issue": { "title": "Passport date of issue (YYYY-MM-DD).", "type": "string", "format": "date-time" }, "date_of_expiry": { "title": "Passport date of expiry (YYYY-MM-DD).", "type": "string", "format": "date-time" }, "visa_issued_on": { "title": "Visa date of issue (YYYY-MM-DD).", "type": "string" }, "visa_number": { "title": "Applicant's Visa Number.", "type": "string" }, "visa_expiring_on": { "title": "Visa date of expiry (YYYY-MM-DD).", "type": "string", "format": "date-time" }, "emergency_contact_name": { "title": "Emergency Contact Name.", "type": "string" }, "emergency_contact_relationship": { "title": "Emergency Contact Relationship.", "type": "string" }, "emergency_contact_number": { "title": "Emergency Contact Number.", "type": "string" }, "study_mode": { "title": "mode of study.", "type": "string" }, "intake": { "title": "intake.", "type": "string" }, "ethnic_origin": { "title": "Applicant's Ethnic Origin (preset Govt list).", "type": "integer" }, "hobbies_and_interests": { "title": "Applicant's Hobbies and Interests.", "type": "string" }, "course_results": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CourseResult2" } }, "assessment_date": { "type": "string", "format": "date-time" }, "attended_assessment": { "type": "boolean" }, "assessment_interview_score": { "type": "string" }, "initial_assessment_interview_notes": { "type": "string" }, "external_id": { "title": "External ID.", "type": "string" }, "uln": { "type": "string" }, "school_at_age16": { "title": "School Applicant attended at 16.", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "disabilities": { "title": "List of disabilities.", "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationDisability3" } }, "travel_duration": { "title": "The length of time it takes to travel to nearest opportunity location, expressed in seconds.", "type": "integer" }, "notes": { "type": "string" }, "ambitions": { "title": "What are the Applicant's Ambitions for the future.", "type": "string" }, "skills": { "title": "What are the Applicant's main Skills.", "type": "string" }, "strengths": { "title": "What are the Applicant's main Strengths.", "type": "string" }, "why_work": { "title": "Reason\/s why the Applicant wishes to work for the Employer.", "type": "string" }, "relevant_experience": { "title": "Applicant's non-employment experience that is relevant to the Opportunity applied for.", "type": "string" }, "valid_driving_licence": { "title": "Does the Applicant have a driving license.", "type": "boolean" }, "own_car": { "title": "Does the Applicant have a car\/vehicle.", "type": "boolean" }, "labels": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationLabel" } }, "address": { "title": "Applicant's postal address.", "type": "string" }, "city": { "title": "Applicant's town\/city of residence.", "type": "string" }, "ward": { "type": "string" }, "district": { "type": "string" }, "country": { "title": "Applicant's country of residence.", "type": "string" }, "county": { "title": "Applicant's county.", "type": "string" }, "postcode": { "title": "Applicant's postcode.", "allOf": [ { "$ref": "#\/components\/schemas\/Location3" } ] } }, "type": "object" }, "CustomPanel": { "required": [ "section", "label" ], "properties": { "id": { "type": "integer" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" }, "section": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "File": { "properties": { "name": { "type": "string" }, "size": { "type": "integer" }, "id": { "type": "integer" }, "file_system_name": { "type": "string" }, "mime_type": { "type": "string" }, "adapter": { "type": "string" }, "parent": { "$ref": "#\/components\/schemas\/File" }, "default_thumb": { "type": "boolean" }, "custom_path": { "type": "string" }, "max_files": { "type": "integer" }, "naming_convention": { "type": "integer" }, "any_mime_type_allowed": { "type": "boolean" } }, "type": "object" }, "EmployerContactCustomFieldValue": { "properties": { "id": { "type": "integer" }, "custom_field": { "$ref": "#\/components\/schemas\/FormFieldType" }, "value": { "type": "string" }, "entity": { "$ref": "#\/components\/schemas\/EmployerContact3" } }, "type": "object" }, "EmployerContactLabel": { "required": [ "name", "color" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string", "maxLength": 7, "minLength": 4, "pattern": ".*(^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$).*" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" } }, "type": "object" }, "WorkflowStatusEmployerContact": { "required": [ "name", "type" ], "properties": { "id": { "type": "integer" }, "name": { "title": "Name of the current status for that application.", "type": "string" }, "type": { "type": "string" }, "subject": { "type": "string" }, "template": { "type": "string" }, "organisation": { "title": "Opportunity type.", "allOf": [ { "$ref": "#\/components\/schemas\/Organisation" } ] }, "order_number": { "type": "integer" }, "deleted": { "type": "boolean" } }, "type": "object" }, "Account": { "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "active_from": { "type": "string", "format": "date-time" }, "active_to": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "verified": { "type": "boolean" }, "users": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserAccountLookup" } }, "organisations": { "title": "todo: check if this is used in queries and fix mapping to OneToOne", "type": "array", "items": { "$ref": "#\/components\/schemas\/Organisation" } } }, "type": "object" }, "Nationality2": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string" }, "sort_order": { "type": "integer" }, "parent": { "$ref": "#\/components\/schemas\/Category" }, "children": { "$ref": "#\/components\/schemas\/Collection" }, "is_active": { "type": "boolean" }, "is_default": { "type": "boolean" } }, "type": "object" }, "ApplicationEmployment": { "type": "object" }, "ApplicationCourse": { "type": "object" }, "LRSLearningEvent2": { "properties": { "id": { "type": "integer" }, "application": { "title": "Application (ID).", "allOf": [ { "$ref": "#\/components\/schemas\/Application3" } ] }, "learner": { "title": "Learner (ID).", "allOf": [ { "$ref": "#\/components\/schemas\/Learner" } ] }, "achievement_award_date": { "type": "string", "format": "date-time" }, "achievement_provider_name": { "type": "string" }, "achievement_provider_ukprn": { "type": "string" }, "awarding_organisation_name": { "type": "string" }, "qualification_type": { "type": "string" }, "subject": { "type": "string" }, "subject_code": { "type": "string" }, "level": { "type": "string" }, "grade": { "type": "string" }, "status": { "type": "string" }, "credits": { "type": "integer" }, "under_data_challenge": { "type": "string" }, "fetched_from_api": { "type": "boolean" } }, "type": "object" }, "ApplicationRequestInfo": { "required": [ "fields", "token", "application" ], "properties": { "id": { "type": "integer" }, "token": { "type": "string" }, "response_at": { "type": "string", "format": "date-time" }, "merged_at": { "type": "string", "format": "date-time" }, "created_by": { "$ref": "#\/components\/schemas\/User" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "application": { "title": "Application (ID)", "allOf": [ { "$ref": "#\/components\/schemas\/Application3" } ] } }, "type": "object" }, "ApplicationLog": { "properties": { "id": { "type": "integer" }, "who": { "title": "Event user", "allOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "when": { "title": "Event time", "type": "string", "format": "date-time" }, "what": { "title": "Event action", "type": "string" }, "data": { "title": "Additional event data", "type": "string" }, "application": { "title": "Application (ID)", "allOf": [ { "$ref": "#\/components\/schemas\/Application3" } ] } }, "type": "object" }, "CourseResult2": { "properties": { "id": { "type": "integer" }, "course_name": { "type": "string" }, "level": { "type": "string" }, "score": { "type": "string" }, "result": { "type": "string" }, "date_achieved": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "application": { "$ref": "#\/components\/schemas\/Application3" }, "learner": { "$ref": "#\/components\/schemas\/Learner" } }, "type": "object" }, "ApplicationDisability3": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "code": { "title": "Applicant's disabilities or learning difficulties (preset Govt list).", "type": "string" }, "one_file_l15_id": { "type": "string" }, "one_file_l16_id": { "type": "string" } }, "type": "object" }, "ApplicationLabel": { "required": [ "name", "color" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string", "maxLength": 7, "minLength": 4, "pattern": ".*(^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$).*" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" } }, "type": "object" }, "Location3": { "required": [ "name" ], "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "Learner": { "properties": { "id": { "type": "integer" }, "organisation": { "$ref": "#\/components\/schemas\/Organisation" }, "reference_number": { "type": "string" }, "uln": { "type": "string" }, "title": { "type": "string" }, "family_name": { "type": "string" }, "given_name": { "type": "string" }, "birth_date": { "type": "string", "format": "date-time" }, "ethnicity": { "type": "integer" }, "sex": { "type": "string" }, "lldd_cats": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ApplicationDisability3" } }, "primary_lldd": { "$ref": "#\/components\/schemas\/ApplicationDisability3" }, "lldd_health_prob": { "type": "integer" }, "ni_number": { "type": "string" }, "prior_attain": { "type": "string" }, "prior_level": { "type": "string" }, "prior_date": { "type": "string", "format": "date-time" }, "postcode_prior": { "$ref": "#\/components\/schemas\/Location3" }, "tel_no": { "type": "string" }, "email": { "type": "string" }, "emp_id": { "type": "integer" }, "emergency_contact1_name": { "type": "string" }, "emergency_contact1_number": { "type": "string" }, "emergency_contact1_relationship": { "type": "string" }, "emergency_contact2_name": { "type": "string" }, "emergency_contact2_number": { "type": "string" }, "emergency_contact2_relationship": { "type": "string" }, "highest_level_qualification": { "type": "string" }, "_lrslearning_events": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LRSLearningEvent2" } }, "funding1_type": { "type": "string" }, "funding1_code": { "type": "string" }, "funding1_date_from": { "type": "string", "format": "date-time" }, "funding1_date_to": { "type": "string", "format": "date-time" }, "funding2_type": { "type": "string" }, "funding2_code": { "type": "string" }, "funding2_date_from": { "type": "string", "format": "date-time" }, "funding2_date_to": { "type": "string", "format": "date-time" }, "training_cost_tnp1_amount": { "type": "integer" }, "training_cost_tnp1_date_from": { "type": "string", "format": "date-time" }, "training_cost_tnp2_amount": { "type": "integer" }, "training_cost_tnp2_date_from": { "type": "string", "format": "date-time" }, "nas_standard": { "$ref": "#\/components\/schemas\/NasStandard2" }, "delivery_location_postcode": { "$ref": "#\/components\/schemas\/Location3" }, "programme_type": { "type": "integer" }, "funding_model": { "type": "integer" }, "planned_off_the_job_hours": { "type": "integer" }, "actual_off_the_job_hours": { "type": "integer" }, "end_point_assessment_organisation": { "type": "string" }, "completion_status": { "type": "integer" }, "withdrawal_reason": { "type": "integer" }, "employment_status": { "type": "integer" }, "employment_status_from_date": { "type": "string", "format": "date-time" }, "employment_length": { "type": "integer" }, "employment_intensity_indicator": { "type": "integer" }, "weekly_contracted_hours": { "type": "integer" }, "job_title": { "type": "string" }, "employer_name": { "type": "string" }, "employer_ern": { "type": "integer" }, "job_description": { "type": "string" }, "entry_requirements": { "type": "string" }, "employer_main_contact_first_name": { "type": "string" }, "employer_main_contact_last_name": { "type": "string" }, "employer_main_contact_email": { "type": "string" }, "employer_main_contact_mobile": { "type": "string" }, "course_results": { "type": "array", "items": { "$ref": "#\/components\/schemas\/CourseResult2" } }, "assessment_date": { "type": "string", "format": "date-time" }, "attended_assessment": { "type": "boolean" }, "assessment_interview_score": { "type": "string" }, "initial_assessment_interview_notes": { "type": "string" }, "course_fetch_username": { "type": "string" }, "created_by": { "$ref": "#\/components\/schemas\/User" }, "employer_address": { "type": "string" }, "employer_city": { "type": "string" }, "employer_ward": { "type": "string" }, "employer_district": { "type": "string" }, "employer_country": { "type": "string" }, "employer_county": { "type": "string" }, "employer_postcode": { "$ref": "#\/components\/schemas\/Location3" }, "employer_employees_number": { "type": "string" }, "employer_liability_insurer": { "type": "string" }, "employer_policy_number": { "type": "string" }, "employer_certificate_document_expires_at": { "type": "string", "format": "date-time" }, "employer_eligible_for1618_incentive": { "type": "boolean" }, "employer_agreement_identifier_reference": { "type": "string" }, "assessor_first_name": { "type": "string" }, "assessor_last_name": { "type": "string" }, "assessor_email": { "type": "string" }, "assessor_phone": { "type": "string" }, "annual_leave_days": { "type": "integer" }, "attached_to_ehcp": { "type": "boolean" }, "evidence_of_ehcp": { "type": "boolean" }, "household_situation": { "type": "array", "items": { "type": "string" } }, "logs": { "title": "List of logged events.", "type": "array", "items": { "$ref": "#\/components\/schemas\/LearnerLog" } }, "attainment_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "address": { "type": "string" }, "city": { "type": "string" }, "ward": { "type": "string" }, "district": { "type": "string" }, "country": { "type": "string" }, "county": { "type": "string" }, "postcode": { "$ref": "#\/components\/schemas\/Location3" } }, "type": "object" }, "LearnerLog": { "properties": { "id": { "type": "integer" }, "who": { "title": "Event user", "allOf": [ { "$ref": "#\/components\/schemas\/User" } ] }, "when": { "title": "Event time", "type": "string", "format": "date-time" }, "what": { "title": "Event action", "type": "string" }, "data": { "title": "Additional event data", "type": "string" }, "learner": { "title": "Learner (ID)", "allOf": [ { "$ref": "#\/components\/schemas\/Learner" } ] } }, "type": "object" } }, "responses": { "BadRequest": { "description": "A parameter is missing or invalid.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiError" }, "example": { "status": "error", "message": "Invalid parameters", "data": { "organisation_id": "This value should not be empty." }, "code": 400 } } } }, "Unauthorized": { "description": "The access token is invalid or has expired.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OAuthError" } } } }, "Forbidden": { "description": "No access token was sent, or your organisation does not have access to this record.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiError" }, "example": { "status": "error", "message": "Access denied to organisation", "data": { "organisation_id": "123" }, "code": 403 } } } }, "NotFound": { "description": "The record does not exist, or your organisation does not have access to it.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiError" }, "example": { "status": "error", "message": "Not found", "code": 404 } } } }, "ServerError": { "description": "Something went wrong on enrola's side.", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ApiError" }, "example": { "status": "error", "message": "Internal error", "code": 500 } } } } }, "securitySchemes": { "bearer": { "type": "http", "description": "The access token from `get-token`, sent as `Authorization: Bearer ACCESS_TOKEN`.", "scheme": "bearer" }, "access_token": { "type": "apiKey", "description": "The same access token, sent as a query parameter. Prefer the header.", "name": "access_token", "in": "query" } } }, "security": [ { "bearer": [] }, { "access_token": [] } ], "tags": [ { "name": "Authentication", "description": "Get an access token for the other endpoints." }, { "name": "Opportunities", "description": "Jobs and apprenticeships. Listing and viewing work without a token." }, { "name": "Applications", "description": "Applications to your opportunities, and the custom fields they can carry." }, { "name": "Employers", "description": "Employers and their contacts." } ] }