{
"openapi": "3.0.1",
"info": {
"title": "Recruitment API",
"description": "Create adverts for Find an apprenticeship using your own system.",
"version": "1"
},
"servers": [
{
"url": "https://api.apprenticeships.education.gov.uk/managevacancies"
}
],
"paths": {
"/accountlegalentities": {
"get": {
"tags": [
"AccountLegalEntities"
],
"summary": "GET list of Account Legal Entities.",
"description": "Get a list of Account Legal Entities that are connected to your subscription. The AccountLegalEntityPublicHashedId is required for Vacancy creation.\r\nIf you are a provider only Accounts that have given permission for you to act on there behalf will show in the list. If you are an employer then only\r\nlegal entities that have a signed agreement will be in the list.",
"operationId": "get-accountlegalentities",
"parameters": [
{
"name": "X-Version",
"in": "header",
"schema": {
"type": "string"
},
"required": true,
"example": "1"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetAccountLegalEntitiesListResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountLegalEntitiesListResponse"
},
"example": {
"accountLegalEntities": [
{
"accountLegalEntityName": "string",
"accountLegalEntityPublicHashedId": "string",
"accountPublicHashedId": "string",
"accountName": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetAccountLegalEntitiesListResponse"
},
"example": {
"accountLegalEntities": [
{
"accountLegalEntityName": "string",
"accountLegalEntityPublicHashedId": "string",
"accountPublicHashedId": "string",
"accountName": "string"
}
]
}
}
}
}
}
}
},
"/referencedata/qualifications": {
"get": {
"tags": [
"ReferenceData"
],
"parameters": [
{
"name": "X-Version",
"in": "header",
"schema": {
"type": "string"
},
"required": true,
"example": "1"
}
],
"summary": "GET list of qualifications.",
"description": "Returns list of qualifications to be used when creating a Vacancy.",
"operationId": "get-referencedata-qualifications",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetQualificationsResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetQualificationsResponse"
},
"example": {
"qualifications": [
"string"
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetQualificationsResponse"
},
"example": {
"qualifications": [
"string"
]
}
}
}
}
}
}
},
"/referencedata/skills": {
"get": {
"tags": [
"ReferenceData"
],
"parameters": [
{
"name": "X-Version",
"in": "header",
"schema": {
"type": "string"
},
"required": true,
"example": "1"
}
],
"summary": "GET list of candidate skills.",
"description": "Returns list of candidate skills to be used when creating a Vacancy.",
"operationId": "get-referencedata-skills",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetCandidateSkillsListResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCandidateSkillsListResponse"
},
"example": {
"candidateSkills": [
"string"
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetCandidateSkillsListResponse"
},
"example": {
"candidateSkills": [
"string"
]
}
}
}
}
}
}
},
"/referencedata/courses": {
"get": {
"tags": [
"ReferenceData"
],
"parameters": [
{
"name": "X-Version",
"in": "header",
"schema": {
"type": "string"
},
"required": true,
"example": "1"
}
],
"summary": "GET list of courses.",
"description": "Returns list of courses to be used when creating a Vacancy. The `Id` should be used for `standardsLarsCode` in create Vacancy",
"operationId": "get-referencedata-courses",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/GetTrainingCoursesListResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetTrainingCoursesListResponse"
},
"example": {
"trainingCourses": [
{
"larsCode": 0,
"title": "string",
"route": "string"
}
]
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/GetTrainingCoursesListResponse"
},
"example": {
"trainingCourses": [
{
"larsCode": 0,
"title": "string",
"route": "string"
}
]
}
}
}
}
}
}
},
"/vacancy/{id}": {
"post": {
"tags": [
"Vacancy"
],
"summary": "POST apprenticeship vacancy",
"description": "Creates an apprenticeship vacancy using the specified values",
"operationId": "post-vacancy-id",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Format - uuid. The unique ID of the Apprenticeship advert.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "X-Version",
"in": "header",
"schema": {
"type": "string"
},
"required": true,
"example": "1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyRequest"
},
"example": {
"title": "Library assistant apprenticeship",
"numberOfPositions": 0,
"closingDate": "2019-08-24T:14:15:22Z",
"startDate": "2019-08-24T:14:15:22Z",
"contractingParties": {
"accountLegalEntityPublicHashedId": "string",
"ukprn": 0
},
"wage": {
"wageType": "FixedWage",
"fixedWageYearlyAmount": 25000,
"wageAdditionalInformation": "string",
"CompanyBenefitsInformation": "string",
"weeklyHours": 0,
"workingWeekDescription": "string",
"duration": 18,
"durationUnit": "Month"
},
"address": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"postcode": "string"
},
"shortDescription": "string",
"description": "Your daily tasks could include: working within a team to deliver a menu of high-quality food each service prepare food in a way that meets food hygiene standards storing food correctly",
"outcomeDescription": "string",
"trainingDescription": "One day per week, in-person at college",
"additionalTrainingDescription": "You’ll have an apprenticeship advisor who will support you through your apprenticeship.",
"standardLarsCode": "119",
"employerNameOption": "RegisteredName",
"alternativeEmployerName": "string",
"employerDescription": "Car manufacturer or clothes retailer",
"anonymousReason": "string",
"employerWebsiteUrl": "string",
"disabilityConfident": "No",
"submitterContactDetails": {
"name": "string",
"email": "string",
"phone": "string"
},
"skills": [
"string"
],
"qualifications": [
{
"qualificationType": "string",
"level": 7,
"subject": "string",
"grade": "C or 4",
"weighting": "Essential"
}
],
"thingsToConsider": "string",
"applicationMethod": "ThroughFindAnApprenticeship",
"applicationInstructions": "string",
"applicationUrl": "string",
"additionalQuestion1": "Do you have a driving licence?",
"additionalQuestion2": "What is your interest in this industry?"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyRequest"
},
"example": {
"title": "Library assistant apprenticeship",
"numberOfPositions": 0,
"closingDate": "2019-08-24T:14:15:22Z",
"startDate": "2019-08-24T:14:15:22Z",
"contractingParties": {
"accountLegalEntityPublicHashedId": "string",
"ukprn": 0
},
"wage": {
"wageType": "FixedWage",
"fixedWageYearlyAmount": 25000,
"wageAdditionalInformation": "string",
"CompanyBenefitsInformation": "string",
"weeklyHours": 0,
"workingWeekDescription": "string",
"duration": 18,
"durationUnit": "Month"
},
"address": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"postcode": "string"
},
"shortDescription": "string",
"description": "Your daily tasks could include: working within a team to deliver a menu of high-quality food each service prepare food in a way that meets food hygiene standards storing food correctly",
"outcomeDescription": "string",
"trainingDescription": "One day per week, in-person at college",
"additionalTrainingDescription": "You’ll have an apprenticeship advisor who will support you through your apprenticeship.",
"standardLarsCode": "119",
"employerNameOption": "RegisteredName",
"alternativeEmployerName": "string",
"employerDescription": "Car manufacturer or clothes retailer",
"anonymousReason": "string",
"employerWebsiteUrl": "string",
"disabilityConfident": "No",
"submitterContactDetails": {
"name": "string",
"email": "string",
"phone": "string"
},
"skills": [
"string"
],
"qualifications": [
{
"qualificationType": "string",
"level": 7,
"subject": "string",
"grade": "C or 4",
"weighting": "Essential"
}
],
"thingsToConsider": "string",
"applicationMethod": "ThroughFindAnApprenticeship",
"applicationInstructions": "string",
"applicationUrl": "string",
"additionalQuestion1": "Do you have a driving licence?",
"additionalQuestion2": "What is your interest in this industry?"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyRequest"
},
"example": {
"title": "Library assistant apprenticeship",
"numberOfPositions": 0,
"closingDate": "2019-08-24T:14:15:22Z",
"startDate": "2019-08-24T:14:15:22Z",
"contractingParties": {
"accountLegalEntityPublicHashedId": "string",
"ukprn": 0
},
"wage": {
"wageType": "FixedWage",
"fixedWageYearlyAmount": 25000,
"wageAdditionalInformation": "string",
"CompanyBenefitsInformation": "string",
"weeklyHours": 0,
"workingWeekDescription": "string",
"duration": 18,
"durationUnit": "Month"
},
"address": {
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"postcode": "string"
},
"shortDescription": "string",
"description": "Your daily tasks could include: working within a team to deliver a menu of high-quality food each service prepare food in a way that meets food hygiene standards storing food correctly",
"outcomeDescription": "string",
"trainingDescription": "One day per week, in-person at college",
"additionalTrainingDescription": "You’ll have an apprenticeship advisor who will support you through your apprenticeship.",
"standardLarsCode": "119",
"employerNameOption": "RegisteredName",
"alternativeEmployerName": "string",
"employerDescription": "Car manufacturer or clothes retailer",
"anonymousReason": "string",
"employerWebsiteUrl": "string",
"disabilityConfident": "No",
"submitterContactDetails": {
"name": "string",
"email": "string",
"phone": "string"
},
"skills": [
"string"
],
"qualifications": [
{
"qualificationType": "string",
"level": 7,
"subject": "string",
"grade": "C or 4",
"weighting": "Essential"
}
],
"thingsToConsider": "string",
"applicationMethod": "ThroughFindAnApprenticeship",
"applicationInstructions": "string",
"applicationUrl": "string",
"additionalQuestion1": "Do you have a driving licence?",
"additionalQuestion2": "What is your interest in this industry?"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyResponse"
},
"example": {
"vacancyReference": "1000000001"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyResponse"
},
"example": {
"vacancyReference": "1000000001"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyExampleForbiddenResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyExampleForbiddenResponse"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"traceId": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyExampleForbiddenResponse"
},
"example": {
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.3",
"title": "Forbidden",
"status": 403,
"traceId": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyExampleBadRequestResponse"
},
"examples": {
"default": {
"value": null
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyExampleBadRequestResponse"
},
"example": {
"errors": {
"qualifications": [
"Required property 'qualifications' not found in JSON. Path '', line 42, position 1."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateVacancyExampleBadRequestResponse"
},
"example": {
"errors": {
"qualifications": [
"Required property 'qualifications' not found in JSON. Path '', line 42, position 1."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ContractingParties": {
"required": [
"accountLegalEntityPublicHashedId"
],
"type": "object",
"properties": {
"accountLegalEntityPublicHashedId": {
"minLength": 1,
"type": "string",
"description": "The unique identification number for the apprentice’s employer. Use `GET accountlegalentites` to obtain the hashed ID for the employer."
},
"ukprn": {
"type": "integer",
"description": "The UK provider reference number (UKPRN) for the apprenticeship’s training provider.",
"format": "int32"
}
},
"additionalProperties": false
},
"CreateVacancyAddress": {
"required": [
"addressLine1",
"postcode"
],
"type": "object",
"properties": {
"addressLine1": {
"minLength": 1,
"type": "string",
"description": "First line of the address where the apprentice will work."
},
"addressLine2": {
"type": "string",
"description": "Second line of the address where the apprentice will work.",
"nullable": true
},
"addressLine3": {
"type": "string",
"description": "Third line of the address where the apprentice will work.",
"nullable": true
},
"addressLine4": {
"type": "string",
"description": "Fourth line of the address where the apprentice will work.",
"nullable": true
},
"postcode": {
"minLength": 1,
"type": "string",
"description": "Postcode of the address where the apprentice will work."
}
},
"additionalProperties": false,
"description": "Address for the apprenticeship advert. Must contain address line 1 and a valid postcode."
},
"CreateVacancyApplicationMethod": {
"enum": [
"ThroughFindAnApprenticeship",
"ThroughExternalApplicationSite"
],
"type": "string",
"description": "Choose from:\r\n- `throughFindAnApprenticeship` lets applicants apply through Find an apprenticeship.
- `throughExternalApplicationSite` means you’ll use your own website to accept applications.
"
},
"CreateVacancyDisabilityConfident": {
"enum": [
"No",
"Yes"
],
"type": "string",
"description": "Say whether the employer is part of the Department for Work and Pension’s Disability Confident scheme. If Yes:\r\n- we’ll show a Disability Confident logo on the vacancy
- If `applicationMethod` is `throughFindAnApprenticeship`, we'll ask applicants whether they want to apply through the Disability Confident scheme.
"
},
"CreateVacancyExampleBadRequestResponse": {
"type": "object",
"properties": {
"errors": {
"$ref": "#/components/schemas/Errors"
},
"type": {
"type": "string",
"description": "",
"format": "uri",
"nullable": true,
"example": "https://tools.ietf.org/html/rfc7231#section-6.5.1"
},
"title": {
"type": "string",
"description": "Title of the error response",
"nullable": true,
"example": "One or more validation errors occurred."
},
"status": {
"type": "integer",
"description": "The http status code of the error",
"format": "int64",
"example": 400
},
"traceId": {
"type": "string",
"description": "",
"nullable": true,
"example": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
}
},
"additionalProperties": false
},
"CreateVacancyExampleForbiddenResponse": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "",
"format": "uri",
"nullable": true,
"example": "https://tools.ietf.org/html/rfc7231#section-6.5.3"
},
"title": {
"type": "string",
"description": "Title of the error response",
"nullable": true,
"example": "Forbidden"
},
"status": {
"type": "integer",
"description": "The http status code of the error",
"format": "int64",
"example": 403
},
"traceId": {
"type": "string",
"description": "",
"nullable": true,
"example": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
}
},
"additionalProperties": false
},
"CreateVacancyQualification": {
"required": [
"level"
],
"type": "object",
"properties": {
"qualificationType": {
"type": "string",
"description": "The type of qualification you want. Use `GET referencedata/qualifications` to see what qualification types you can use.",
"nullable": true
},
"level": {
"type": "integer",
"description": "If `qualificationType` is `BTEC`, you must tell us what level of BTEC you’re looking for.",
"format": "int32",
"example": 7
},
"subject": {
"type": "string",
"description": "The name of the subject for the qualification.",
"nullable": true
},
"grade": {
"type": "string",
"description": "The grade for the qualification. GCSEs must include the 1 to 9 grading system.",
"nullable": true,
"example": "C or 4"
},
"weighting": {
"$ref": "#/components/schemas/QualificationWeighting"
}
},
"additionalProperties": false
},
"CreateVacancyRequest": {
"required": [
"applicationMethod",
"closingDate",
"contractingParties",
"description",
"disabilityConfident",
"employerDescription",
"numberOfPositions",
"outcomeDescription",
"qualifications",
"shortDescription",
"skills",
"standardLarsCode",
"startDate",
"submitterContactDetails",
"title",
"trainingDescription",
"wage"
],
"type": "object",
"properties": {
"title": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "The title for the apprenticeship vacancy on Find an apprenticeship. Must include: apprentice or apprenticeship.",
"example": "Library assistant apprenticeship"
},
"numberOfPositions": {
"type": "integer",
"description": "The number of apprentices being recruited for the apprenticeship.",
"format": "int32"
},
"closingDate": {
"type": "string",
"description": "The last date people can apply for the apprenticeship. Must be at least 2 weeks in the future.",
"format": "date-time",
"example": "2019-08-24T:14:15:22Z"
},
"startDate": {
"type": "string",
"description": "The planned date for the apprenticeship’s start. We suggest using a date 2 weeks after the closing date.",
"format": "date-time",
"example": "2019-08-24T:14:15:22Z"
},
"contractingParties": {
"$ref": "#/components/schemas/ContractingParties"
},
"wage": {
"$ref": "#/components/schemas/CreateVacancyWage"
},
"address": {
"$ref": "#/components/schemas/CreateVacancyAddress"
},
"shortDescription": {
"maxLength": 350,
"minLength": 1,
"type": "string",
"description": "A short summary of the overall apprenticeship. This appears at the top of the vacancy on Find an apprenticeship."
},
"description": {
"maxLength": 4000,
"minLength": 1,
"type": "string",
"description": "What the apprentice will do at work. We suggest including day-to-day duties. Must include at least 3 bullet points (written in HTML).",
"example": "Your daily tasks could include: working within a team to deliver a menu of high-quality food each service prepare food in a way that meets food hygiene standards storing food correctly"
},
"outcomeDescription": {
"maxLength": 4000,
"minLength": 1,
"type": "string",
"description": "What progression or outcome the apprentice can expect at the end of the apprenticeship."
},
"trainingDescription": {
"maxLength": 4000,
"minLength": 1,
"type": "string",
"description": "Where and when an apprentice’s training will take place. Don’t include any other information about the training here.\r\nIf you submit an advert without providing this field, we’ll display a message on Find an apprenticeship saying that the training schedule hasn’t been agreed yet.",
"example": "One day per week, in-person at college"
},
"additionalTrainingDescription": {
"maxLength": 4000,
"type": "string",
"description": "Further information about an apprentice’s training, such as details about the training provider or how the course will be structured.",
"nullable": true,
"example": "You’ll have an apprenticeship advisor who will support you through your apprenticeship."
},
"standardLarsCode": {
"minLength": 1,
"type": "string",
"description": "The code from the learning aim reference service (LARS) for the apprenticeship’s training course (also known as a ‘standard’). See all codes using `GET referencedata/courses`.",
"example": "119"
},
"employerNameOption": {
"$ref": "#/components/schemas/EmployerNameOption"
},
"alternativeEmployerName": {
"maxLength": 100,
"type": "string",
"description": "When `employerNameOption` is set to `tradingName`, use this field to set the company’s name yourself with the correct formatting.",
"nullable": true
},
"employerDescription": {
"maxLength": 100,
"minLength": 1,
"type": "string",
"description": "When `employerNameOption` is set to `anonymousName`, give a brief description of the company to help people understand what they do.",
"example": "Car manufacturer or clothes retailer"
},
"anonymousReason": {
"maxLength": 200,
"type": "string",
"description": "When `employerNameOption` is set to `anonymousName`, tell us why you need to hide the company's name.\r\nThis will not appear on Find an apprenticeship but is needed for our quality assurance team to approve your vacancy.",
"nullable": true
},
"employerWebsiteUrl": {
"type": "string",
"description": "The web address for the employer’s website.",
"nullable": true
},
"disabilityConfident": {
"$ref": "#/components/schemas/CreateVacancyDisabilityConfident"
},
"submitterContactDetails": {
"$ref": "#/components/schemas/SubmitterContactDetails"
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Skills and qualities an apprentice should have for this apprenticeship. We’ll show this on the vacancy.\r\nIf `applicationMethod` is `ThroughFindAnApprenticeship`, we’ll also ask applicants for examples of when they’ve used these skills.\r\nUse `GET referencedata/skills` to see our default selection of skills or add your own."
},
"qualifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateVacancyQualification"
},
"description": "Qualifications obtained from `GET referendata/qualifications`. You must supply at least one qualification required."
},
"thingsToConsider": {
"maxLength": 4000,
"type": "string",
"description": "Other requirements for the applicant, such as needing a Disclosure and Barring Service (DBS) check.",
"nullable": true
},
"applicationMethod": {
"$ref": "#/components/schemas/CreateVacancyApplicationMethod"
},
"applicationInstructions": {
"type": "string",
"description": "If `applicationMethod` is `throughExternalSite`, you can give some information about the application process.",
"nullable": true
},
"applicationUrl": {
"type": "string",
"description": "If `applicationMethod` is `throughExternalSite`, provide the web address for your application website.",
"nullable": true
},
"additionalQuestion1": {
"maxLength": 250,
"pattern": "^\\w(.*)\\w\\?(\\s\\w(.*)\\w[\\.\\?])*$",
"type": "string",
"description": "If `applicationMethod` is `throughFindAnApprenticeship`, you can add questions for us to add to the application form.\r\nNote that we automatically ask all applicants ‘What are your skills and strengths?’ and ‘What interests you about this apprenticeship?’",
"nullable": true,
"example": "Do you have a driving licence?"
},
"additionalQuestion2": {
"maxLength": 250,
"pattern": "^\\w(.*)\\w\\?(\\s\\w(.*)\\w[\\.\\?])*$",
"type": "string",
"description": "If `applicationMethod` is `throughFindAnApprenticeship`, add another question to the application form.",
"nullable": true,
"example": "What is your interest in this industry?"
}
},
"additionalProperties": false
},
"CreateVacancyResponse": {
"type": "object",
"properties": {
"vacancyReference": {
"type": "string",
"description": "",
"nullable": true,
"example": "1000000001"
}
},
"additionalProperties": false
},
"CreateVacancyWage": {
"required": [
"duration",
"durationUnit",
"wageType",
"weeklyHours",
"workingWeekDescription"
],
"type": "object",
"properties": {
"wageType": {
"$ref": "#/components/schemas/WageType"
},
"fixedWageYearlyAmount": {
"type": "number",
"description": "If `WageType` is `FixedWage`, enter the yearly amount the apprentice will earn.",
"format": "double",
"nullable": true,
"example": 25000
},
"wageAdditionalInformation": {
"maxLength": 250,
"type": "string",
"description": "Additional information about pay, such as when the apprentice might get a pay rise.",
"nullable": true
},
"CompanyBenefitsInformation": {
"maxLength": 250,
"type": "string",
"description": "Describe benefits the company offers.",
"nullable": true
},
"weeklyHours": {
"maxLength": 48,
"minLength": 16,
"type": "number",
"description": "The total number of hours per week. This includes both work and training.",
"format": "double"
},
"workingWeekDescription": {
"maxLength": 250,
"minLength": 1,
"type": "string",
"description": "Information about the working schedule, such as daily working hours."
},
"duration": {
"type": "integer",
"description": "How long the apprenticeship will be. Use duration to set a number, and then `durationUnit` to say whether it’s months or years. Apprenticeships must be longer than a year.",
"format": "int32",
"example": 18
},
"durationUnit": {
"$ref": "#/components/schemas/DurationUnit"
}
},
"additionalProperties": false
},
"DurationUnit": {
"enum": [
"Month",
"Year"
],
"type": "string",
"description": "Set the unit of time for `duration`."
},
"EmployerNameOption": {
"enum": [
"RegisteredName",
"TradingName",
"Anonymous"
],
"type": "string",
"description": "Choose how the employer’s company name appears on Find an apprenticeship. Choose from: \r\n`registeredName` uses company’s name from the Companies House database (normally in all caps).\r\n`tradingName` lets you set the company’s name yourself, using `alternativeEmployerName` to correctly format the name.\r\n`anonymous` hides the company’s name on the vacancy. Note you’ll need to provide `employerDescription` and `anonymousReason`"
},
"Errors": {
"type": "object",
"properties": {
"qualifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "",
"nullable": true,
"example": [
"Required property 'qualifications' not found in JSON. Path '', line 42, position 1."
]
}
},
"additionalProperties": false
},
"GetAccountLegalEntitiesItem": {
"type": "object",
"properties": {
"accountLegalEntityName": {
"type": "string",
"nullable": true
},
"accountLegalEntityPublicHashedId": {
"type": "string",
"nullable": true
},
"accountPublicHashedId": {
"type": "string",
"nullable": true
},
"accountName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"GetAccountLegalEntitiesListResponse": {
"type": "object",
"properties": {
"accountLegalEntities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetAccountLegalEntitiesItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetCandidateSkillsListResponse": {
"type": "object",
"properties": {
"candidateSkills": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetQualificationsResponse": {
"type": "object",
"properties": {
"qualifications": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetTrainingCoursesListResponse": {
"type": "object",
"properties": {
"trainingCourses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GetTrainingCoursesListResponseItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"GetTrainingCoursesListResponseItem": {
"type": "object",
"properties": {
"larsCode": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string",
"nullable": true
},
"route": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"QualificationWeighting": {
"enum": [
"Essential",
"Desired"
],
"type": "string",
"description": "How much you want an application to have the qualification."
},
"SubmitterContactDetails": {
"required": [
"email",
"name",
"phone"
],
"type": "object",
"properties": {
"name": {
"minLength": 1,
"type": "string",
"description": "The name of a contact who applicants can contact to discuss the apprenticeship."
},
"email": {
"minLength": 1,
"type": "string",
"description": "The contact's email address."
},
"phone": {
"minLength": 1,
"type": "string",
"description": "The contact's phone number."
}
},
"additionalProperties": false
},
"WageType": {
"enum": [
"FixedWage",
"NationalMinimumWageForApprentices",
"NationalMinimumWage",
"CompetitiveSalary"
],
"type": "string",
"description": "Choose from:\r\n`WageType.NationalMinimumWageForApprentices` sets the wage to the National Minimum Wage for apprentices\r\n`WageType.NationalMinimumWage` sets the wage to the National Minimum Wage \r\n`WageType.FixedWage` lets you set a fixed wage for the apprenticeship\r\n`WageType.CompetitiveSalary` does not set an exact wage and shows the word ‘Competitive’\r\nNational Minimum Wages will change every year on 1 April. We automatically update adverts to the correct National Minimum Wages."
}
},
"securitySchemes": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
}
}
},
"security": [
{
"apiKeyHeader": []
}
]
}