> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paulsjob.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Add candidate university

> ### Create Company Candidate University

This endpoint allows the creation of a new university record for a candidate within a company.

#### Request Body

- `user_slug` (string): The unique identifier of the user.
    
- `start_date` (string, required): The start date of the university record.
    
- `end_date` (string, optional): The end date of the university record.
    
- `university_name` (string): The name of the university.
    
- `study_name` (string): The name of the study program.
    
- `university_degrees_id` (integer): The ID representing the university degree.
    
- `description` (string, optional): A brief description of the university record.
    
- `grade` (integer): The grade obtained.
    
- `grading_systems_id` (integer): The ID representing the grading system used.
    

#### Response

The response is in JSON format with the following schema:

``` json
{
    "message": "Candidate job input successfully",
    "status": 201
}

 ```

- `message` (string): A message related to the request.
    
- `status` (integer): The status of the request.
    

Example:

``` json
{
    "user_slug": "39c12359-7eaf-407d-9be7-97f522...",
    "start_date": "01-02-2024",
    "end_date": "01-02-2024",
    "university_name": "Kampus Merdeka",
    "study_name": "Tourismusmanagement",
    "university_degrees_id": 2,
    "description": "",
    "grade": 1,
    "grading_systems_id": 52
}

 ```



## OpenAPI

````yaml post /gin/v1/company/candidate/university
openapi: 3.0.0
info:
  title: Pauls Job Public Endpoints
  description: >-
    #### **Description:**


    This API provides a comprehensive suite of endpoints for managing user
    authentication, session control, and other key functionalities within the
    application for Pauls Job. The endpoints are designed to ensure secure and
    efficient communication between clients and the server, offering robust
    access control mechanisms through token-based authentication.


    #### **Key Features:**


    - **Authentication:** Allows users to securely log in using their
    credentials and receive a token for accessing protected resources.
        
    - **Session Management:** Provides a logout mechanism to securely end user
    sessions and invalidate tokens.
        
    - **Error Handling:** Clear and descriptive error messages ensure that
    issues such as invalid credentials, expired tokens, or missing parameters
    are easily identifiable.
        

    This API is built with a focus on security and ease of use, making it
    essential for integrating user authentication and session management into
    applications while maintaining a high standard of data protection.
  version: 1.0.0
servers:
  - url: https://api.hyrd.de
security: []
tags:
  - name: Users
    description: >-
      #### **Description:**


      The folder contains the foundational information and essential API
      endpoints for starting with the authentication and session management of
      the application. This includes the critical login and logout
      functionalities, which are necessary for users to authenticate and manage
      their sessions securely.


      #### **APIs Included:**


      1. **Login API**: Allows users to log in by providing their credentials
      and receive an authentication token.
          
      2. **Logout API**: Enables users to log out by invalidating the token and
      ending their session.
          

      These endpoints are designed to facilitate secure access control and
      session handling, making them an essential starting point for any
      interaction with the platform's protected resources.
  - name: General
  - name: Company
  - name: Company > Candidate
  - name: Company > Api Integrations
paths:
  /gin/v1/company/candidate/university:
    post:
      tags:
        - Company > Candidate
      summary: Add candidate university
      description: >-
        ### Create Company Candidate University


        This endpoint allows the creation of a new university record for a
        candidate within a company.


        #### Request Body


        - `user_slug` (string): The unique identifier of the user.
            
        - `start_date` (string, required): The start date of the university
        record.
            
        - `end_date` (string, optional): The end date of the university record.
            
        - `university_name` (string): The name of the university.
            
        - `study_name` (string): The name of the study program.
            
        - `university_degrees_id` (integer): The ID representing the university
        degree.
            
        - `description` (string, optional): A brief description of the
        university record.
            
        - `grade` (integer): The grade obtained.
            
        - `grading_systems_id` (integer): The ID representing the grading system
        used.
            

        #### Response


        The response is in JSON format with the following schema:


        ``` json

        {
            "message": "Candidate job input successfully",
            "status": 201
        }

         ```

        - `message` (string): A message related to the request.
            
        - `status` (integer): The status of the request.
            

        Example:


        ``` json

        {
            "user_slug": "39c12359-7eaf-407d-9be7-97f522...",
            "start_date": "01-02-2024",
            "end_date": "01-02-2024",
            "university_name": "Kampus Merdeka",
            "study_name": "Tourismusmanagement",
            "university_degrees_id": 2,
            "description": "",
            "grade": 1,
            "grading_systems_id": 52
        }

         ```
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
          example: '{{company-api-key}}'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                user_slug: 39c12359-7eaf-407d-9be7-97f522a1e7f2
                start_date: 01-02-2024
                end_date: 01-02-2024
                university_name: Kampus Merdeka
                study_name: Tourismusmanagement
                university_degrees_id: 2
                description: ''
                grade: 1
                grading_systems_id: 52
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}

````