{
  "openapi": "3.0.1",
  "info": {
    "title": "Recruitment API Sandbox",
    "description": "Create an advert on Find an apprenticeship using your existing systems.",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://api-sandbox.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": "Success",
            "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": "Success",
            "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": "Success",
            "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": "Success",
            "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"
            }
          },
          {
            "name": "X-Version",
            "in": "header",
            "schema": {
              "type": "string"
            },
            "required": true,
            "example": "1"
          }
        ],
        "requestBody": {
          "content": {
            "application/json-patch+json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVacancyRequest"
              },
              "example": {
                "submitterContactDetails": {
                  "name": "string",
                  "email": "string",
                  "phone": "string"
                },
                "contractingParties": {
                  "ukprn": 0,
                  "accountLegalEntityPublicHashedId": "string"
                },
                "title": "Apprenticeship in Advanced Baking",
                "description": "string",
                "standardLarsCode": "119",
                "alternativeEmployerName": "string",
                "shortDescription": "string",
                "numberOfPositions": 0,
                "outcomeDescription": "string",
                "closingDate": "string",
                "startDate": "string",
                "employerDescription": "string",
                "trainingDescription": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "addressLine3": "string",
                  "addressLine4": "string",
                  "postcode": "string"
                },
                "wage": {
                  "wageAdditionalInformation": "string",
                  "fixedWageYearlyAmount": 0,
                  "weeklyHours": 0,
                  "duration": 0,
                  "workingWeekDescription": "string",
                  "wageType": "FixedWage",
                  "durationUnit": "Month"
                },
                "skills": [
                  "string"
                ],
                "employerNameOption": "RegisteredName",
                "anonymousReason": "string",
                "qualifications": [
                  {
                    "qualificationType": "string",
                    "subject": "string",
                    "grade": "string",
                    "weighting": "Essential"
                  }
                ],
                "applicationInstructions": "string",
                "applicationUrl": "string",
                "applicationMethod": "ThroughFindAnApprenticeship",
                "disabilityConfident": "No",
                "thingsToConsider": "string",
                "employerWebsiteUrl": "string"
              }
            },
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVacancyRequest"
              },
              "example": {
                "submitterContactDetails": {
                  "name": "string",
                  "email": "string",
                  "phone": "string"
                },
                "contractingParties": {
                  "ukprn": 0,
                  "accountLegalEntityPublicHashedId": "string"
                },
                "title": "Apprenticeship in Advanced Baking",
                "description": "string",
                "standardLarsCode": "119",
                "alternativeEmployerName": "string",
                "shortDescription": "string",
                "numberOfPositions": 0,
                "outcomeDescription": "string",
                "closingDate": "string",
                "startDate": "string",
                "employerDescription": "string",
                "trainingDescription": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "addressLine3": "string",
                  "addressLine4": "string",
                  "postcode": "string"
                },
                "wage": {
                  "wageAdditionalInformation": "string",
                  "fixedWageYearlyAmount": 0,
                  "weeklyHours": 0,
                  "duration": 0,
                  "workingWeekDescription": "string",
                  "wageType": "FixedWage",
                  "durationUnit": "Month"
                },
                "skills": [
                  "string"
                ],
                "employerNameOption": "RegisteredName",
                "anonymousReason": "string",
                "qualifications": [
                  {
                    "qualificationType": "string",
                    "subject": "string",
                    "grade": "string",
                    "weighting": "Essential"
                  }
                ],
                "applicationInstructions": "string",
                "applicationUrl": "string",
                "applicationMethod": "ThroughFindAnApprenticeship",
                "disabilityConfident": "No",
                "thingsToConsider": "string",
                "employerWebsiteUrl": "string"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVacancyRequest"
              },
              "example": {
                "submitterContactDetails": {
                  "name": "string",
                  "email": "string",
                  "phone": "string"
                },
                "contractingParties": {
                  "ukprn": 0,
                  "accountLegalEntityPublicHashedId": "string"
                },
                "title": "Apprenticeship in Advanced Baking",
                "description": "string",
                "standardLarsCode": "119",
                "alternativeEmployerName": "string",
                "shortDescription": "string",
                "numberOfPositions": 0,
                "outcomeDescription": "string",
                "closingDate": "string",
                "startDate": "string",
                "employerDescription": "string",
                "trainingDescription": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "addressLine3": "string",
                  "addressLine4": "string",
                  "postcode": "string"
                },
                "wage": {
                  "wageAdditionalInformation": "string",
                  "fixedWageYearlyAmount": 0,
                  "weeklyHours": 0,
                  "duration": 0,
                  "workingWeekDescription": "string",
                  "wageType": "FixedWage",
                  "durationUnit": "Month"
                },
                "skills": [
                  "string"
                ],
                "employerNameOption": "RegisteredName",
                "anonymousReason": "string",
                "qualifications": [
                  {
                    "qualificationType": "string",
                    "subject": "string",
                    "grade": "string",
                    "weighting": "Essential"
                  }
                ],
                "applicationInstructions": "string",
                "applicationUrl": "string",
                "applicationMethod": "ThroughFindAnApprenticeship",
                "disabilityConfident": "No",
                "thingsToConsider": "string",
                "employerWebsiteUrl": "string"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVacancyRequest"
              },
              "example": {
                "submitterContactDetails": {
                  "name": "string",
                  "email": "string",
                  "phone": "string"
                },
                "contractingParties": {
                  "ukprn": 0,
                  "accountLegalEntityPublicHashedId": "string"
                },
                "title": "Apprenticeship in Advanced Baking",
                "description": "string",
                "standardLarsCode": "119",
                "alternativeEmployerName": "string",
                "shortDescription": "string",
                "numberOfPositions": 0,
                "outcomeDescription": "string",
                "closingDate": "string",
                "startDate": "string",
                "employerDescription": "string",
                "trainingDescription": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "addressLine3": "string",
                  "addressLine4": "string",
                  "postcode": "string"
                },
                "wage": {
                  "wageAdditionalInformation": "string",
                  "fixedWageYearlyAmount": 0,
                  "weeklyHours": 0,
                  "duration": 0,
                  "workingWeekDescription": "string",
                  "wageType": "FixedWage",
                  "durationUnit": "Month"
                },
                "skills": [
                  "string"
                ],
                "employerNameOption": "RegisteredName",
                "anonymousReason": "string",
                "qualifications": [
                  {
                    "qualificationType": "string",
                    "subject": "string",
                    "grade": "string",
                    "weighting": "Essential"
                  }
                ],
                "applicationInstructions": "string",
                "applicationUrl": "string",
                "applicationMethod": "ThroughFindAnApprenticeship",
                "disabilityConfident": "No",
                "thingsToConsider": "string",
                "employerWebsiteUrl": "string"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Success",
            "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": {
          "ukprn": {
            "type": "integer",
            "description": "The UKPRN of the training provider you will be working with for this apprenticeship.",
            "format": "int32"
          },
          "accountLegalEntityPublicHashedId": {
            "type": "string",
            "description": "The Account Legal Entity public hashed Id of the organisation that you wish to create the vacancy for. This can be obtained from `GET accountlegalentites`"
          }
        },
        "additionalProperties": false
      },
      "CreateVacancyAddress": {
        "required": [
          "addressLine1",
          "postcode"
        ],
        "type": "object",
        "properties": {
          "addressLine1": {
            "type": "string",
            "description": "Address line 1"
          },
          "addressLine2": {
            "type": "string",
            "description": "Address line 2",
            "nullable": true
          },
          "addressLine3": {
            "type": "string",
            "description": "Address line 3",
            "nullable": true
          },
          "addressLine4": {
            "type": "string",
            "description": "Address line 4",
            "nullable": true
          },
          "postcode": {
            "type": "string",
            "description": "Postcode"
          }
        },
        "additionalProperties": false,
        "description": "Address for the apprenticeship advert. Must contain address line 1 and a valid postcode."
      },
      "CreateVacancyApplicationMethod": {
        "enum": [
          "ThroughFindAnApprenticeship",
          "ThroughExternalApplicationSite"
        ],
        "type": "string"
      },
      "CreateVacancyDisabilityConfident": {
        "enum": [
          "No",
          "Yes"
        ],
        "type": "string"
      },
      "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.0"
          },
          "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.0"
          },
          "traceId": {
            "type": "string",
            "description": "",
            "nullable": true,
            "example": "|3f20b24dba787449b33e0d53e3d3ef9d.d6137015_"
          }
        },
        "additionalProperties": false
      },
      "CreateVacancyQualification": {
        "type": "object",
        "properties": {
          "qualificationType": {
            "type": "string",
            "description": "Qualification Type can be obtained from `GET referencedata/qualifications`",
            "nullable": true
          },
          "subject": {
            "type": "string",
            "description": "Add a subject you would like the applicant to have.",
            "nullable": true
          },
          "grade": {
            "type": "string",
            "description": "Enter the grade. GCSEs must be in number format 1-9",
            "nullable": true
          },
          "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": {
          "submitterContactDetails": {
            "$ref": "#/components/schemas/SubmitterContactDetails"
          },
          "contractingParties": {
            "$ref": "#/components/schemas/ContractingParties"
          },
          "title": {
            "type": "string",
            "description": "The name of the vacancy or job role being advertised. Must contain the word apprentice or apprenticeship and be less than 100 characters.",
            "example": "Apprenticeship in Advanced Baking"
          },
          "description": {
            "type": "string",
            "description": "What activities and duties will the apprentice be undertaking during the apprenticeship. Must not exceed 4000 characters"
          },
          "standardLarsCode": {
            "type": "string",
            "description": "The LARS code associated with the Standard you wish to create the advert for. This can be found from `GET referencedata/courses`",
            "example": "119"
          },
          "alternativeEmployerName": {
            "type": "string",
            "description": "If `EmployerNameOption` is set to `TradingName` then will be used and Trading name in the application updated. If it is set to `Anonymous` then will be used for the anonymous employer name. If it is set to `RegisteredName` then the Account Legal Entity name will be used. Must not exceed 100 characters",
            "nullable": true
          },
          "shortDescription": {
            "type": "string",
            "description": "A short description of the apprenticeship. Must not exceed 350 characters"
          },
          "numberOfPositions": {
            "type": "integer",
            "description": "The number of apprentices that will be recruited into the role. Add as a numerical value, must be at least 1.",
            "format": "int32"
          },
          "outcomeDescription": {
            "type": "string",
            "description": "What an apprentice can expect in terms of career progression after the apprenticeship ends. You may want to mention specific routes they could take once qualified. Must not exceed 4000 characters"
          },
          "closingDate": {
            "type": "string",
            "description": "The last date for receiving new applications. This must be before  the start date of the apprenticeship. Must be a valid date. Closing date for applications cannot be today or earlier.",
            "format": "date-time"
          },
          "startDate": {
            "type": "string",
            "description": "The planned start date of the apprenticeship. This must be after the closing date. Must be a valid date. Possible apprenticeship start date can't be today or earlier. We advise using a date more than two weeks from now.",
            "format": "date-time"
          },
          "employerDescription": {
            "type": "string",
            "description": "A brief description about the employer. Must not exceed 4000 characters"
          },
          "trainingDescription": {
            "type": "string",
            "description": "The training the apprentice will undertake and the qualification they will get at the end of the apprenticeship. Add any certifications and levels of qualifications. Must not exceed 4000 characters."
          },
          "address": {
            "$ref": "#/components/schemas/CreateVacancyAddress"
          },
          "wage": {
            "$ref": "#/components/schemas/CreateVacancyWage"
          },
          "skills": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Add the desired skills and personal qualities you’d like the applicant to have in order for you to consider them. There is a selection available from `GET referencedata/skills` or you can add your own. You must include at least one desired skill"
          },
          "employerNameOption": {
            "$ref": "#/components/schemas/EmployerNameOption"
          },
          "anonymousReason": {
            "type": "string",
            "description": "Provide the reason why the organisation would like to remain anonymous if chosen for SFA.DAS.Vacancies.Manage.Api.Models.CreateVacancyRequest.EmployerNameOption. The reason must not be more than 4000 characters",
            "nullable": true
          },
          "qualifications": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CreateVacancyQualification"
            },
            "description": "Qualifications obtained from `GET referendata/qualifications`. You must supply at least one qualification required."
          },
          "applicationInstructions": {
            "type": "string",
            "description": "Information for applicants about how their applications will be managed externally.",
            "nullable": true
          },
          "applicationUrl": {
            "type": "string",
            "description": "If they are being managed externally, add the web address of the employer/agency managing the applications.",
            "nullable": true
          },
          "applicationMethod": {
            "$ref": "#/components/schemas/CreateVacancyApplicationMethod"
          },
          "disabilityConfident": {
            "$ref": "#/components/schemas/CreateVacancyDisabilityConfident"
          },
          "thingsToConsider": {
            "type": "string",
            "description": "Any other information the applicant should be aware of. Must not exceed 4000 characters",
            "nullable": true
          },
          "employerWebsiteUrl": {
            "type": "string",
            "description": "You can choose to display website for your organisation. Website address must be a valid URL.",
            "nullable": true
          }
        },
        "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": {
          "wageAdditionalInformation": {
            "type": "string",
            "description": "Extra information about pay. 250 character limit",
            "nullable": true
          },
          "fixedWageYearlyAmount": {
            "type": "number",
            "description": "If `WageType.FixedWage` then enter the yearly amount.",
            "format": "double",
            "nullable": true
          },
          "weeklyHours": {
            "type": "number",
            "description": "The total number of hours per week. This must include the 20% of time the apprentice will spend training, which could be offsite. Needs to be greater than 16 and less than 48.",
            "format": "double"
          },
          "duration": {
            "type": "integer",
            "description": "Expected duration must be at least 12 months. The minimum duration of each apprenticeship is based on the apprentice working at least 30 hours a week, including any off-the-job training they undertake.\r\nExtend the minimum duration when the working week is fewer than 30 hours using the following formula:\r\n12 x 30/average weekly hours = new minimum duration in months; or 52 x 30/average weekly hours = new minimum duration in weeks",
            "format": "int32"
          },
          "workingWeekDescription": {
            "type": "string",
            "description": "A short description of the pattern of working hours over the week. Start time, end time and working days. You have up to 250 characters"
          },
          "wageType": {
            "$ref": "#/components/schemas/WageType"
          },
          "durationUnit": {
            "$ref": "#/components/schemas/DurationUnit"
          }
        },
        "additionalProperties": false
      },
      "DurationUnit": {
        "enum": [
          "Month",
          "Year"
        ],
        "type": "string",
        "description": "Used in combination with `Wage.Duration` to specify the length of the apprenticeship."
      },
      "EmployerNameOption": {
        "enum": [
          "RegisteredName",
          "TradingName",
          "Anonymous"
        ],
        "type": "string"
      },
      "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"
      },
      "SubmitterContactDetails": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the person creating the advert",
            "nullable": true
          },
          "email": {
            "type": "string",
            "description": "The email address of the person creating the advert",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "description": "The phone number of the person creating the advert",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "WageType": {
        "enum": [
          "FixedWage",
          "NationalMinimumWageForApprentices",
          "NationalMinimumWage"
        ],
        "type": "string",
        "description": "Choose from:\r\n`WageType.FixedWage` This must be more than the [National Minimum Wage for apprentices](https://www.gov.uk/national-minimum-wage-rates). From 1 April 2021, the National Minimum Wage for apprentices is £4.30 an hour. Based on 16 working hours a week, you'll need to pay a yearly wage of at least £3,577.60.\r\n`WageType.NationalMinimumWageForApprentices` From 1 April 2021, the National Minimum Wage for apprentices is £4.30 an hour. On the advert, this will be displayed as a yearly wage of £3,577.60.\r\n`WageType.NationalMinimumWage` From 1 April 2021, the National Minimum Wage is between £4.62 and £8.91 an hour, depending on the candidate's age. On the advert, this will be displayed as a yearly wage of £3,843.84 to £7,413.12."
      }
    },
    "securitySchemes": {
      "apiKeyHeader": {
        "type": "apiKey",
        "name": "Ocp-Apim-Subscription-Key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "apiKeyHeader": []
    }
  ]
}