> ## Documentation Index > Fetch the complete documentation index at: https://docs.ctrl-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Award a qualification > Create a new award for a qualification. ## OpenAPI ````yaml /api-reference/openapi.yaml post /v3/qualification-awards openapi: 3.1.0 info: contact: email: support@ctrl-hub.com name: Ctrl Hub url: https://www.ctrl-hub.com description: > Ctrl Hub is the all-in-one platform for high-risk industries like utilities, construction, infrastructure, and renewables. We help teams manage everything from risk assessments and HAVS exposure to vehicle and equipment checks, with a guaranteed minimum of 200% ROI. license: name: MIT License url: https://opensource.org/licenses/MIT summary: An API for managing your compliance and risk posture termsOfService: https://www.ctrl-hub.com/terms-conditions title: Ctrl Hub version: 1.0.0 servers: - description: Production url: https://api.ctrl-hub.com - description: Staging url: https://api.ctrl-hub.dev - description: Development url: https://api.ctrl-hub.run security: [] tags: - description: | Audit events are the events that are logged by the system. name: Audit Events - description: | View the platform's health and availability. name: Status - description: > User-owned dashboards composed of cards on a fixed-slot bento layout. Cards come from a per-domain registry; the API stores their config as opaque JSON. name: Dashboards - description: | Manage appointments for work to be carried out with your customers name: Customer Appointments - description: | Manage interactions you have with your customers name: Customer Interactions - description: | Manage accounts for your customers name: Customer Accounts and Contacts - description: | Qualifications are the skills and knowledge that an organisation requires. name: Qualifications - description: | Workflows allow you to automate your processes. name: Workflows - description: | Manage documents name: Documents - description: | Manage documents name: Folders - description: | Manage documents name: Document Reviews - description: | Manage feature configurations for an organisation. name: Feature Configurations - description: | Equipment are the physical assets that an organisation manages. name: Equipment - description: | Manage your forms and their schemas name: Forms, Schemas and Categories - description: | Create and view form submissions name: Submissions - description: | View the roles available in the system. name: IAM Roles - description: > IAM role groups can be assigned to principals to manage authorisation centrally. name: IAM Role Groups - description: | Manage service accounts which can access the API programmatically. name: Service Accounts - description: | Manage bridges between organisations. name: Bridges - description: | Manage settings for an organisation. name: Settings - description: | Manage teams within an organisation. name: Teams - description: | Manage job roles within an organisation. name: Job Roles - description: | Manage users and accounts. name: Users - description: | Invite and manage invitations to organisations. name: Invitations - description: > IAM grants are the asignment of roles or permissions to principals to manage resource access. name: IAM Grants - description: | View the permissions available in the system. name: IAM Permissions - description: | SSO providers are the identity providers for an organisation. name: SSO Providers - description: | Whoami returns information about the currently authenticated principal. name: Whoami - description: | Manage your images name: Images - description: > Organisations are the center point for most resources in the platform. Most other endpoints are subresources of an organisation. name: Organisations - description: | Permits managements, integrated with street manager. name: Permits - description: | Projects manage your work and governance. name: Projects - description: > Import templates allow users to save and reuse their CSV importer configuration as named templates. name: Import Templates - description: | Properties are the physical locations. name: Properties - description: | Search across schemes, work orders, and operations. name: Search - description: | Provides the API specification in JSON and YAML formats name: Specifications - description: | Streets are the physical roads. name: Streets - description: | Integration with street manager name: Street Manager - description: | Vehicles are the physical vehicles that an organisation manages. name: Vehicles - description: > Scheme contracts (also known as regions) group schemes allocated from the network to a contractor. name: Scheme Contracts - description: > Scheme shares allow you to share your schemes with other organisations across bridges. name: Scheme Shares - description: | Schemes are large programmes of work name: Schemes - description: | Work orders the component parts of a scheme. name: Work Orders - description: | Operations are the work to be carried out within work orders. name: Operations externalDocs: description: More documentation and resources url: https://docs.ctrl-hub.com paths: /v3/qualification-awards: post: tags: - Qualifications summary: Create a new award for a qualification description: Create a new award for a qualification. operationId: CreateQualificationAward requestBody: $ref: '#/components/requestBodies/CreateQualificationAward' responses: '201': $ref: '#/components/responses/GetQualificationAward' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorised' '409': $ref: '#/components/responses/Conflict' '500': $ref: '#/components/responses/InternalServerError' security: - Session: [] - OAuth2: [] - Cookie: [] components: requestBodies: CreateQualificationAward: required: true description: The qualification award to create. content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string const: qualification-awards attributes: type: object oneOf: - type: object description: Assigned qualification award required: - status properties: status: type: string const: assigned description: The status of the qualification award due: type: string format: date-time description: The date and time when the qualification is due additionalProperties: false - type: object description: Awarded qualification award required: - status - awarded_at properties: status: type: string const: awarded description: The status of the qualification award awarded_at: type: string format: date-time description: >- The date and time when the qualification was awarded due: type: string format: date-time description: The date and time when the qualification is due additionalProperties: false relationships: required: - organisation - qualification - user properties: organisation: type: object required: - data properties: data: type: object required: - type - id properties: type: type: string const: organisations id: type: string format: uuid description: The ID of the organisation. qualification: type: object required: - data properties: data: type: object required: - type - id properties: type: type: string const: qualifications id: type: string format: uuid description: The ID of the qualification. user: type: object required: - data properties: data: type: object required: - type - id properties: type: type: string const: users id: type: string format: uuid description: The ID of the user. responses: GetQualificationAward: description: Get a Qualification award headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: allOf: - type: object required: - data properties: data: $ref: '#/components/schemas/QualificationAward' included: $ref: '#/components/schemas/QualificationAwardIncludes' - $ref: '#/components/schemas/JSONAPI' BadRequest: description: > There was an error with the request - this could be due to an invalid body, query parameters, or headers that were sent to the API. headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 98ca4a78-b66f-4234-9719-aaf832ee6669 status: '400' title: A validation error was encountered source: parameter: include meta: resource: wrong_value Unauthorised: description: Authentication failed headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 05fc9c8d-73b9-4697-9337-57f7a567a48f status: '401' title: You are not authorised to access this resource detail: In order to access this resource, you need the 'admin' role. code: AUTH.001 Conflict: description: The request conflicts with the current state of the resource headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: 8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g status: '409' title: Conflict detail: The request conflicts with the current state of the resource. code: CONFLICT.001 InternalServerError: description: There was a problem handling the request on the server side headers: Content-Type: $ref: '#/components/headers/content-type' Content-Length: $ref: '#/components/headers/content-length' X-Request-ID: $ref: '#/components/headers/x-request-id' content: application/vnd.api+json: schema: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: id: fe9d9a69-f0a7-4fdc-bb2c-176027f316c5 status: '500' title: Internal Server Error detail: An unexpected error occurred on the server. headers: content-type: description: The content type of the response schema: type: string example: application/vnd.api+json content-length: description: The length of the response body in bytes schema: type: integer format: int32 example: 1234 x-request-id: description: >- An ID that can be provided when reporting bugs to help identify the issue schema: type: string example: 8470f56af4cf25e22be08e72c70dbbdc schemas: QualificationAward: type: object description: A qualification award required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the qualification award. type: type: string const: qualification-awards attributes: $ref: '#/components/schemas/QualificationAwardAttributes' meta: $ref: '#/components/schemas/QualificationAwardMeta' relationships: $ref: '#/components/schemas/QualificationAwardRelationships' QualificationAwardIncludes: type: array description: >- Related resources that can be included when a qualification award is returned items: discriminator: propertyName: type mapping: organisations: $ref: '#/components/schemas/Organisation' qualification-awards: $ref: '#/components/schemas/QualificationAward' qualifications: $ref: '#/components/schemas/Qualification' users: $ref: '#/components/schemas/User' oneOf: - $ref: '#/components/schemas/Organisation' - $ref: '#/components/schemas/Qualification' - $ref: '#/components/schemas/QualificationAward' - $ref: '#/components/schemas/User' JSONAPI: type: object description: JSON API response object required: - jsonapi properties: jsonapi: type: object required: - version properties: version: type: string description: The version of the JSON API specification examples: - '1.0' Error: type: object description: An error response properties: id: description: >- A unique identifier for this particular occurrence of the problem. If you encounter this, please provide us with the error ID and we can investigate it on our side. type: string format: uuid examples: - 05fc9c8d-73b9-4697-9337-57f7a567a48f status: description: >- The status code for the error. This might not match the HTTP status code if there are more that one errors to return with different status codes. type: string examples: - '401' - '500' title: description: A human readable title for the error. type: string examples: - You are not authorised to access this resource detail: description: >- Where there is more detail that we can provide outside of the title, we will provide it here. type: string examples: - In order to access this resource, you need the 'admin' role. code: description: >- A unique code for the error that may help us to diagnose the issue. Not all errors have codes, so this is usually empty. type: string examples: - AUTH.001 source: description: A JSON object containing additional information about the error. type: object properties: pointer: description: >- A JSON Pointer to the value in the request that caused the error. type: string examples: - /data/attributes/email parameter: description: >- A string indicating which query parameter in the request caused the error. type: string examples: - include required: - id - status - title QualificationAwardAttributes: type: object description: Attributes for a qualification award required: - status properties: status: type: string description: The status of the qualification award enum: - assigned - awarded due: type: string format: date-time description: The date and time when the qualification is due awarded_at: type: string format: date-time description: The date and time when the qualification was awarded QualificationAwardMeta: type: object description: Metadata for a qualification award required: - created_at - risks properties: is_valid: type: boolean description: >- Indicates whether there has been an assessment for this award which passed. is_latest: type: boolean description: >- Indicates whether this is the latest award for a user and qualification. If false, there is a more recent award. created_at: type: string format: date-time description: The date and time when the award was created updated_at: type: string format: date-time description: The date and time when the award was last updated modified_at: type: string format: date-time description: The date and time when the award was last modified expires_at: type: string format: date-time description: >- The date and time when the award expires. If the qualification does not need renewal, this will not be set. risks: type: object description: Risk information for this award required: - current - thresholds properties: current: type: string description: The current risk level enum: - none - low - medium - high - critical next_check: type: string format: date-time description: >- The date and time when the next risk check is scheduled based on the current risk level and thresholds thresholds: type: object description: Risk threshold dates required: - none - low - medium - high - critical properties: none: type: string format: date-time description: Date when no risk period started low: type: string format: date-time description: Date when low risk starts medium: type: string format: date-time description: Date when medium risk starts high: type: string format: date-time description: Date when high risk starts critical: type: string format: date-time description: Date when critical risk starts (expiry date) QualificationAwardRelationships: type: object description: Relationships for a qualification award required: - user - author - qualification properties: assessments: type: array description: The assessments associated with this award items: $ref: '#/components/schemas/QualificationAwardAssessmentRelationship' user: type: object description: The user who received this award properties: data: $ref: '#/components/schemas/UserRelationship' author: type: object description: The user who granted this award properties: data: $ref: '#/components/schemas/UserRelationship' qualification: type: object description: The qualification that was awarded properties: data: $ref: '#/components/schemas/QualificationRelationship' renewed_by: type: object description: The award that renewed this one, if any properties: data: $ref: '#/components/schemas/QualificationAwardRelationship' renews: type: object description: The award that this one renews, if any properties: data: $ref: '#/components/schemas/QualificationAwardRelationship' folder: type: object description: The folder that contains this award properties: data: $ref: '#/components/schemas/FolderRelationship' Organisation: type: object description: An organisation required: - id - type - attributes - meta properties: id: type: string format: uuid description: The unique identifier of the organisation. type: type: string const: organisations attributes: $ref: '#/components/schemas/OrganisationAttributes' meta: $ref: '#/components/schemas/OrganisationMeta' relationships: $ref: '#/components/schemas/OrganisationRelationships' Qualification: type: object description: A qualification required: - id - type - attributes - meta - relationships properties: id: type: string format: uuid description: The unique identifier of the qualification. type: type: string const: qualifications attributes: $ref: '#/components/schemas/QualificationAttributes' meta: $ref: '#/components/schemas/QualificationMeta' relationships: $ref: '#/components/schemas/QualificationRelationships' User: type: object description: A user required: - id - type - attributes properties: id: type: string format: uuid description: The unique identifier of the user. examples: - 123e4567-e89b-12d3-a456-426614174000 type: type: string const: users attributes: $ref: '#/components/schemas/UserAttributes' meta: $ref: '#/components/schemas/UserMeta' relationships: $ref: '#/components/schemas/UserRelationships' QualificationAwardAssessmentRelationship: type: object description: Represents a relationship to a qualification award assessment required: - id - type properties: id: type: string format: uuid description: The unique identifier of the qualification award assessment type: type: string const: qualification-award-assessments UserRelationship: type: object description: Represents a relationship to a user required: - id - type properties: id: type: string format: uuid description: The unique identifier of the user type: type: string const: users QualificationRelationship: type: object description: Represents a relationship to a qualification required: - id - type properties: id: type: string format: uuid description: The unique identifier of the qualification type: type: string const: qualifications QualificationAwardRelationship: type: object description: Represents a relationship to a qualification award required: - id - type properties: id: type: string format: uuid description: The unique identifier of the qualification award type: type: string const: qualification-awards FolderRelationship: type: object description: Represents a relationship to a folder required: - id - type properties: id: type: string format: uuid description: The unique identifier of the folder type: type: string const: folders OrganisationAttributes: type: object description: Attributes for an organisation required: - name - slug - sandbox properties: name: type: string description: The name of the organisation. examples: - Acme Construction Ltd slug: type: string description: The URL-friendly identifier for the organisation. examples: - acme-construction description: type: string description: A short description of the organisation. examples: - >- Leading construction company specializing in infrastructure projects sandbox: type: boolean description: Whether the organisation is a sandbox (i.e. a test organisation) examples: - false settings: type: object OrganisationMeta: type: object description: Meta information for an organisation required: - v3 - status properties: created_at: type: string format: date-time description: The creation time of the organisation. examples: - '2023-01-15T10:30:00.000Z' updated_at: type: string format: date-time description: The last update time of the organisation. examples: - '2023-02-20T14:45:00.000Z' v3: type: boolean description: Whether the organisation is using version 3 exclusively. examples: - true status: type: string enum: - active - inactive default: active description: The current status of the organisation. examples: - active features: type: array description: Available features and their limits for the organisation. items: type: object properties: name: type: string description: The name of the feature. examples: - advanced_reporting enabled: type: boolean description: Whether the feature is enabled. examples: - true limit: type: integer description: The usage limit for this feature (if applicable). examples: - 1000 OrganisationRelationships: type: object description: Relationships for an organisation properties: users: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserRelationship' service_accounts: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/ServiceAccountRelationship' groups: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/UserGroupRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' nomenclature: type: object required: - data properties: data: oneOf: - $ref: '#/components/schemas/NomenclatureRelationship' - type: 'null' QualificationAttributes: type: object description: Attributes for a qualification required: - qualification_number - title - status - provenance properties: qualification_number: type: string description: >- The qualification number (e.g. "500/1514/X"). The canonical identifier for the qualification. title: type: string description: The full title of the qualification. level: type: string description: The level of the qualification (e.g. "Level 3"). sub_level: type: string description: The sub-level of the qualification, if applicable. type: type: string description: >- The type of qualification (e.g. "QCF", "NVQ", "Award", "Certificate", "Diploma"). total_credits: type: - integer - 'null' description: The total credit value of the qualification. Null if not applicable. guided_learning_hours: type: - integer - 'null' description: >- The guided learning hours for the qualification. Null if not specified. total_qualification_time: type: - integer - 'null' description: The total qualification time in hours. Null if not specified. ssa: type: string description: The Sector Subject Area (e.g. "04.1 Engineering"). operational_start_date: type: - string - 'null' format: date-time description: The date the qualification became available. Null if not specified. operational_end_date: type: - string - 'null' format: date-time description: >- The date the qualification ceased to be available. Null if still active. regulation_status: type: string description: >- The regulatory status of the qualification (e.g. "Available to learners", "No longer awarded", "Withdrawn"). awarding_body_rn: type: string description: The recognition number of the owning awarding body (e.g. "RN5133"). awarding_body_name: type: string description: The name of the owning awarding body (denormalised). status: type: string description: The lifecycle status of the qualification. enum: - ingested - published - archived high_risk_duration: type: - integer - 'null' minimum: 1 description: >- Days before expiry at which high risk begins. Null if not configured. medium_risk_duration: type: - integer - 'null' minimum: 1 description: >- Days before expiry at which medium risk begins. Requires high_risk_duration to be set and must be greater than or equal to high_risk_duration. low_risk_duration: type: - integer - 'null' minimum: 1 description: >- Days before expiry at which low risk begins. Requires medium_risk_duration to be set and must be greater than or equal to medium_risk_duration. provenance: type: string description: How this record entered the system. enum: - ofqual - manual QualificationMeta: type: object description: Metadata for a qualification required: - created_at - updated_at properties: created_at: type: string format: date-time description: The date and time when the qualification was created updated_at: type: string format: date-time description: The date and time when the qualification was last updated QualificationRelationships: type: object description: Relationships for a qualification required: - awarding_body properties: awarding_body: type: object description: The awarding body that owns this qualification required: - data properties: data: $ref: '#/components/schemas/AwardingBodyRelationship' UserAttributes: type: object description: Attributes for a user properties: email: type: string format: email description: The email address of the user. examples: - john.doe@example.com status: type: string enum: - active - inactive - pending - unknown description: > The membership status of this user in the organisation in the request URL. Only populated on org-scoped member endpoints; absent on global user endpoints. examples: - active identities: type: array items: type: object properties: id: type: string format: uuid description: The unique identifier for the identity. examples: - 39ce13b8-1116-416a-ad5f-3c5edfd44f53 platform: type: string description: The platform of the identity. examples: - multi_tenant meta: type: - object - 'null' additionalProperties: true description: Additional metadata for the identity. profile: type: object properties: work: type: object properties: occupation: type: string description: The occupation of the user. examples: - Site Manager cscs: type: string description: The CSCS card number of the user. examples: - CSC123456 eusr: type: string description: The EUSR card number of the user. examples: - EUR789123 start_date: type: string format: date description: The start date of the user's employment. examples: - '2020-03-01T00:00:00.000Z' personal: type: object properties: first_name: type: string description: The first name of the user. examples: - John last_name: type: string description: The last name of the user. examples: - Doe dob: type: string format: date description: The date of birth of the user. examples: - '1985-06-15T00:00:00.000Z' username: type: string description: The username of the user. examples: - johndoe contact: type: object properties: mobile: type: string description: The mobile number of the user. examples: - +44 7700 900123 landline: type: string description: The landline of the user. examples: - +44 20 7946 0958 address: type: object properties: number: type: string description: The house number of the user's address. default: '' examples: - '42' street: type: string description: The street of the user's address. examples: - High Street area: type: string description: The area of the user's address. examples: - Westminster town: type: string description: The town of the user's address. examples: - London county: type: string description: The county of the user's address. examples: - Greater London postcode: type: string description: The postcode of the user's address. examples: - SW1A 1AA country_code: type: string description: The country code of the user's address. examples: - GB what3words: type: string description: The what3words location of the user's address. examples: - filled.count.soap settings: type: object properties: preferred_language: type: string description: The preferred language of the user. default: en-GB examples: - en-GB timezone: type: string description: The timezone of the user. examples: - Europe/London UserMeta: type: object description: Metadata for a user properties: grants: type: array items: type: string description: >- This data is only returned on the whoami endpoint - it contains all of the user's granted permissions. UserRelationships: type: object description: Relationships for a user properties: organisations: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/OrganisationRelationship' teams: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/TeamRelationship' managing_organisation: type: object required: - data properties: data: $ref: '#/components/schemas/OrganisationRelationship' ServiceAccountRelationship: type: object description: Represents a relationship to a service account required: - id - type properties: id: type: string format: uuid description: The unique identifier of the service account type: type: string const: service-accounts UserGroupRelationship: type: object description: Represents a relationship to a group required: - id - type properties: id: type: string format: uuid description: The unique identifier of the group type: type: string const: groups TeamRelationship: type: object description: Represents a relationship to a team required: - id - type properties: id: type: string format: uuid description: The unique identifier of the team type: type: string const: teams NomenclatureRelationship: type: object description: Represents a relationship to a nomenclature resource required: - id - type properties: id: type: string format: uuid description: The unique identifier of the nomenclature resource type: type: string const: nomenclature AwardingBodyRelationship: type: object description: Represents a relationship to an awarding body required: - id - type properties: id: type: string format: uuid description: The unique identifier of the awarding body type: type: string const: awarding-bodies OrganisationRelationship: type: object description: Represents a relationship to an organisation required: - id - type properties: id: type: string format: uuid description: The unique identifier of the organisation type: type: string const: organisations securitySchemes: Session: description: | Session token for authentication. in: header name: X-Session-Token type: apiKey OAuth2: description: | OAuth2 token for authentication. flows: clientCredentials: scopes: {} tokenUrl: https://auth.ctrl-hub.com/oauth2/token type: oauth2 Cookie: description: | Cookie token for authentication. in: cookie name: ctrl_hub_session type: apiKey ````