Internships manager

Internships manager

  • Docs
  • API
  • Tuto
  • Help
  • GitHub

›REST API

Introduction

  • Internships manager API

REST API

  • Businesses
  • Campaigns
  • Files
  • Internships
  • InternshipTypes
  • Mentors
  • Mentoring propositions
  • Statistics
  • Students

Services API

  • Emails
  • Statistics

Statistics

Details of routes to handle statistics

Global statistics

GET /api/v1/statistics

200 - Global statistics

{
  "campaign": 1,
  "internships": {
    "attributed": 0,
    "availables": 0,
    "total": 0,
  },
  "mentors": 0,
  "propositions": 0,
  "students": 0,
}

Campaign statistics

GET /api/v1/campaigns/:id/statistics

200 - Campaign's statistics

{
  "internships": {
    "archived": 0,
    "attributed": 0,
    "availables": 0,
    "suggested": 0,
    "total": 0,
    "validated": 0,
    "waiting": 0,
  },
  "mentors": 0,
  "propositions": 0,
  "students": 0,
}

204 - No content

This campaign hasn't been found, we return a status 204 - No content

400 - Bad request

API return Bad Request status with 400 code when request validation fail.

{
  "code": 11103,
  "status": 400,
  "errors": [
    {
      "msg": "Identifier must be an integer",
      "param": "city",
      "location": "body"
    },
    {
      "msg": "Identifier must be defined",
      "param": "city",
      "location": "body"
    }
  ],
  "name": "BAD REQUEST"
}
← Mentoring propositionsStudents →
  • Global statistics
    • 200 - Global statistics
  • Campaign statistics
    • 200 - Campaign's statistics
    • 204 - No content
    • 400 - Bad request
Copyright © 2019 ENIB