swagger.json

{
  "swagger": "2.0",
  "info": {
    "title": "Node API",
    "description": "Template API project for Node.js",
    "version": "1.0.0"
  },
  "basePath": "/api/kursstatistik",
  "produces": ["application/json"],
  "paths": {
    "/_checkAPIkey": {
      "get": {
        "operationId": "checkAPIkey",
        "summary": "GET a test endpoint that is protected by api key to validate that consumer has a proper api key",
        "description": "",
        "parameters": [],
        "tags": ["system"],
        "responses": {
          "200": {
            "description": "An empty response"
          },
          "default": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [
          {
            "api_key": ["read"]
          }
        ]
      }
    },
    "/v1/courseRoundStaitics/{roundEndDate}": {
      "post": {
        "operationId": "requestRoundStatisticsByLadokId",
        "summary": "Requests round statistics by Ladok ID",
        "description": "",
        "parameters": [
          {
            "name": "roundEndDate",
            "in": "path",
            "description": "End date of the roun(s) to get the correct result, format yyyy-mm-dd",
            "required": true,
            "type": "string"
          },
          {
            "name": "Ladok roundId list",
            "in": "body",
            "description": "List of ladok round ids",
            "required": true,
            "type": "array",
            "items": { "type": "string" }
          }
        ],
        "tags": ["v1"],
        "responses": {
          "200": {
            "description": "The requested round statistics",
            "schema": {
              "$ref": "#/definitions/ReturnObject"
            }
          },
          "400": {
            "description": "Unexpected error",
            "schema": {
              "$ref": "#/definitions/Error"
            }
          }
        },
        "security": [
          {
            "api_key": ["write"]
          }
        ]
      }
    }
  },
  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "name": "api_key",
      "in": "header",
      "scopes": {
        "read": "Read access to data",
        "write": "Write access to data"
      }
    }
  },
  "definitions": {
    "ReturnObject": {
      "properties": {
        "registeredStudents": {
          "type": "string",
          "description": "Sum of first time registered students for round(s)"
        },
        "examinationGrade": {
          "type": "string",
          "description": "Percentage of registeredStudents and sutents that has finnish the course before course end date"
        }
      }
    },
    "Error": {
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        }
      }
    },
    "UserList": {
      "properties": {
        "code": {
          "type": "integer",
          "format": "int32"
        },
        "message": {
          "type": "string"
        },
        "fields": {
          "type": "string"
        }
      }
    }
  }
}