openapi: 3.0.3
info:
  title: 'GreenIT API Documentation'
  description: 'GreenIT 2025 Feedback API'
  version: 1.0.0
servers:
  -
    url: 'https://api.green-it.nl'
tags:
  -
    name: Endpoints
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by trying out the <b>GET api/docs/token</b> route below.'
security:
  -
    default: []
paths:
  /api/docs/token:
    post:
      summary: ''
      operationId: postApiDocsToken
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                api_secret:
                  type: required
                  description: 'string Secret string to ensure only frontend can access these routes.'
                  example: '12345'
                  nullable: false
      security: []
  /api/docs/response/hash:
    post:
      summary: ''
      operationId: postApiDocsResponseHash
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                responseId:
                  type: required
                  description: 'string The responseID of the participant in Qualtrics (to retrieve or also create the TestReportData in the test table).'
                  example: R_8OkTUcNei8V6fYb
                  nullable: false
      security: []
  /api/docs/response/data:
    post:
      summary: ''
      operationId: postApiDocsResponseData
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                hash:
                  type: required
                  description: "string The hash of the participant's responseId."
                  example: itsjustabigrandomstring
                  nullable: false
      security: []
  /api/docs/email:
    post:
      summary: ''
      operationId: postApiDocsEmail
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: required
                  description: "string The participant's email."
                  example: youremailadress
                  nullable: false
                hash:
                  type: required
                  description: "string The hash of the participant's responseId."
                  example: itsjustabigrandomstring
                  nullable: false
                preview:
                  type: required
                  description: 'boolean Shows email as json if true (1). If set to 0, tries to actually send email to given address. This field is omitted from the production route.'
                  example: '1'
                  nullable: false
      security: []
  /api/docs/response/remove:
    post:
      summary: ''
      operationId: postApiDocsResponseRemove
      description: ''
      parameters: []
      responses: {  }
      tags:
        - Endpoints
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                responseId:
                  type: required
                  description: 'string The responseID of the participant in Qualtrics (to remove this record from the table).'
                  example: R_8OkTUcNei8V6fYb
                  nullable: false
      security: []