OAI API Documentation

GET /info

Get API version and informations

Documentation

Get API version and informations

This action respond with a string with the following format : OAI API X.X with X.X replaced with the api's version.

You can use this action without any authentication to test if the API is online and reachable.

Return

Parameter	Type	Description
response	string	OAI API X.X

Status Codes

Example

URL:

https://oai.epitech.eu/api/info

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://oai.epitech.eu/api/info");

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

$.get("https://oai.epitech.eu/api/info").done(console.log);

var request = require("request");
request({url: "https://oai.epitech.eu/api/info"}, (e, r, b) => console.log(b));

import requests

response = requests.request("GET", "https://oai.epitech.eu/api/info")
print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/info")
http = Net::HTTP.new(url.host, url.port)
response = http.request(Net::HTTP::Get.new(url))
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/info").asString();

Response returned:

OAI API 0.6

GET /services

List API services

Documentation

List API services

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action respond with an array of all the action routes of the API.

Each key is formatted this way : [METHOD] route , value is the action's description

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Return

Parameter	Type	Description
action list	JSON Array	List of all action routes

Status Codes

Status Code	Description
200	Returned when successfull
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/services

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/services",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/services",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/services",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/services"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/services")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/services")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "[GET] /api/info": "Get API version and informations",
  "[GET] /api/services": "List API services",
  "[GET] /api/revoke": "OAI API Key Revoke",
  ...
}

GET /revoke

API Key Revoke

Documentation

OAI API Key Revoke

Parameters user and pass must be added to the Request header.

On success, the old API Key will be revoked and a new one will be returned.

Requirements

Name	Requirement	Type	Description
user	header	string	User's identifier
pass	header	string	User's password

Return

Parameter	Type	Description
data	JSON array	Info about the key : user, key itself, and it's creation date
msg	string	Key or error message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/revoke

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/revoke",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
   "user: test2",
   "pass: password" //test2's password
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/revoke",
  "method": "GET",
  "headers": {
    "user": "test2",
    "pass": "password" //test2's password
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'GET',
  url: "https://oai.epitech.eu/api/revoke",
  headers: 
   { user: 'test2',
     pass: 'password' } }; // test2's password

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/revoke"
    
headers = {
    'user': "test2",
    'pass': "password" #test2's password
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/revoke")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["user"] = 'test2'
request["pass"] = 'password' #test2's password

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/revoke")
.header("user", "test2")
.header("pass", "password") //test2's password
.asString();

Response returned:

{
  "data": {
    "user":"test2",
    "key":"gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
    "issued":"2016-03-01 13:10:12"
  },
  "msg": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
  "code": 200
}

GET /list

List available parameters for the find query

Documentation

List available parameters for the find query

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all possible parameters to use in filter to the find query.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Return

Parameter	Type	Description
data	JSON array	List of parameters
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/list

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/list",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/list",
  "method": "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'GET',
  url: "https://oai.epitech.eu/api/list",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/list"
    
headers = {
    'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
    }

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("http://oai.epitech.eu/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/list")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response return :

{
  "data": [
    "annee",
    "promos",
    "ville",
    "promotion",
    "ecole",
    "civilite",
    "statutADM",
    "statutPeda"
  ],
  "msg": "",
  "code": 200
}

GET /list/{param}

List possible values for the parameter specified, to use with the find query

Documentation

Get possible values for the parameter specified, to use with the find query

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all correct values for the specified parameter to use in filter of the find query.

Filters are optionnal:

If the filter ecole is omitted, it will be set according to the domain name.

Note:

If the parameter values depends on a school, only the values for the school is retrieved.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Values
param	string	true	Parameter to list values of	annee, promos, ville, promotion

Return

Parameter	Type	Description
data	JSON array	All values for parameter specified
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/list/promos

GET parameters:

promos

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/list/promos",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/list/promos",
  "method": "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'GET',
  url: "https://oai.epitech.eu/api/list/promos",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/list/promos"
    
headers = { 'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq" }

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/list/promos")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/list/promos")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
    "Epitech 1",
    "Epitech 2",
    "Epitech 3",
    "Epitech 3s",
    "Epitech 4",
    "Epitech 5",
    "PSO Section 1",
    "PSO Section 2",
    "Epitech 3/3s"
  ],
  "msg": "",
  "code": 200
}

GET /students

Get all students info

Documentation

Get all students info

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all informations, available for the owner of the APIKey, about students that match the filters provided.

Filters are optionnal:

if the filter annee is omitted, it will be set to the current academic year.

if the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

annee

Description	Academic year
Exemple	2015/2016

promos

Description	Student's section
Exemple	Epitech 2

villeEcole

Description	Student's city
Exemple	Paris

promotion

Description	Student's promotion
Exemple	2019

ecole

Description	Query specific school
Exemple	epitech

Return

Parameter	Type	Description
data	JSON array	All Results
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students

GET Filters :

annee: "2015/2016", promotion: "2019", ville: "Paris"

URL with query parameters :

https://oai.epitech.eu/api/students?annee=2015/2016&ville=Paris&promotion=2019

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
$GETfields = array(
    "annee" => "2015/2016",
    "promotion" => 2019,
    "ville" => "Paris"
);
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students?". http_build_query($GETfields),
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    "annee": "2015/2016",
    "promotion": "2019",
    "ville": "Paris"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/students",
  headers:
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } },
  qs:
    { annee: '2015/2016', promotion: '2019', ville: 'Paris' }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students"

querystring = {"annee":"2015/2016","promotion":"2019","ville":"Paris"}
headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students" + "?annee=2015/2016&promotion=2019&ville=Paris")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/students" + "?annee=2015/2016&promotion=2019&ville=Paris")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
    {
      "Login":"paccar_c",
      "Nom":"PACCARD",
      "Prenom":"Christopher",
      /* other available fields */,
      ...
    },
    { /* other students */, ... }
  ],
  "msg": "",
  "code": 200
}

GET /students/{login}

Get specific student info

Documentation

Get specific student info

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all informations, available for the owner of the APIKey, about the specified student.

You can substitute the student's ionis_id in place of the login.

If the filter annee is omitted, it will be set to the current academic year.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

annee

Description	Student's academic year
Exemple	2014/2015

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Student's login or ionis_id	christopher.paccard@epitech.eu

Return

Parameter	Type	Description
data	JSON array	Student info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/students/christopher.paccard@epitech.eu")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
    {
      "Login":"christopher.paccard@epitech.eu",
      "Nom":"PACCARD",
      "Prenom":"Christopher",
      /* other available fields */,
      ...
    }
  ],
  "msg": "",
  "code": 200
}

POST /students/push

Push student

Documentation

Push student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action push a new student on IBP with the fields provided.

If you choose not to use CBO standardization, you can set the field CBO to false.

CBO normally send a phone message to the created new user to provide the user's password, if the phone number isn't supported by CBO we will not be able to create the student.

To activate a fallback that will first try to send the password by phone message then, if it fails, will be sent by email then you must set the field CBOMailFallback to true.

Fields that can be filled depends on restrictions upon your account.

Required fields

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/push

Request Body:

{
  "Ecole": "Epitech",
  "ID_Ionis": "TEST123456",
  "Nom": "Doe",
  "Prenom": "John",
  "Promos": "Epitech 1"
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/push",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'Ecole':'Epitech','ID_Ionis':'TEST123456','Nom':'Doe','Prenom':'John','Promos':'Epitech 1'}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/push",
  "method": "POST",
  "headers": { "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq" },
  "data": {
    'Ecole':'Epitech',
    'ID_Ionis':'TEST123456',
    'Nom':'Doe',
    'Prenom':'John',
    'Promos':'Epitech 1',
    }
  }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'POST',
  url: "https://oai.epitech.eu/api/students/push",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' },
  form: 
   {
    'Ecole':'Epitech',
    'ID_Ionis':'TEST123456',
    'Nom':'Doe',
    'Prenom':'John',
    'Promos':'Epitech 1'
   }
  };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/push"

payload = "{'Ecole':'Epitech','ID_Ionis':'TEST123456','Nom':'Doe','Prenom':'John','Promos':'Epitech 1'}"
headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/push")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request.body = "{'Ecole':'Epitech','ID_Ionis':'TEST123456','Nom':'Doe','Prenom':'John','Promos':'Epitech 1'}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.post("https://oai.epitech.eu/api/students/push")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'Ecole':'Epitech','ID_Ionis':'TEST123456','Nom':'Doe','Prenom':'John','Promos':'Epitech 1'}")
.asString();

Response returned :

{
  "data": {
    "id": 35465,
    "login": "john.doe@kod.org"
  },
  "message":"Student created with login : john.doe@kod.org and pushed on IBP",
  "code": 201
}

POST /students/update/{login}

Update student info

Documentation

Update student info

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action updates the student's info on IBP with the fields provided.

You can substitute the student's ionis_id in place of the login.

Fields that can be updated depends on restrictions upon your account.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Student's login or ionis_id	christopher.paccard@epitech.eu

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/update/john.doe@epitech.eu

JSON Request Body:

{
  "Nom": "Doherty",
  "Prenom": "Johny"
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/update/john.doe@epitech.eu",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'Nom':'Doherty','Prenom':'Johny'}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/update/john.doe@epitech.eu",
  "method": "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    'Nom':'Doherty',
    'Prenom':'Johny'
  }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'POST',
  url: "https://oai.epitech.eu/api/students/update/john.doe@epitech.eu",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } },
  form: 
   {
    'Nom':'Doherty',
    'Prenom':'Johny'
  } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/update/john.doe@epitech.eu"
payload = "{'Nom':'Doherty', 'Prenom':'Johny'}"
headers = { 'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq" }
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/update/john.doe@epitech.eu")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request.body = "{'Nom':'Doherty', 'Prenom':'Johny'}"
response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.post("https://oai.epitech.eu/api/students/update/john.doe@epitech.eu")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'Nom':'Doherty', 'Prenom':'Johny'}")
.asString();

Response returned :

{
  "data": {
    "id": 35465,
    "login": "john.doe@kod.org"
  },
  "message":"Student john.doe@kod.org's info updated on IBP",
  "code": 200
}

GET /students/{login}/referents

Get referents info of specific student

Documentation

Get referents info of specific student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all informations, available for the owner of the APIKey, about the specified student's referents.

You can substitute the student's ionis_id in place of the login.

If the filter annee is omitted, it will be set to the current academic year.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

annee

Description	Student's academic year
Exemple	2014/2015

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Student's login or ionis_id	christopher.paccard@epitech.eu

Return

Parameter	Type	Description
data	JSON array	Referents info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/students/christopher.paccard@epitech.eu/referents")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
    "financier": {
      "Etudiant":"christopher.paccard@epitech.eu",
      "Nom":"paccard",
      "Prenom":"Christophe",
      /* other available fields */,
      ...
    },
    "mere": { ... },
    ...
  ],
  "msg": "",
  "code": 201
}

GET /students/{login}/referents/{type}

Get referents info of a specific type for a specific student

Documentation

Get referents info of a specific type for a specific student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

Referents type are : pere , mere , urgence , financier

This action retrieve all informations, available for the owner of the APIKey, about the specified student.

You can substitute the student's ionis_id in place of the login.

If the filter annee is omitted, it will be set to the current academic year.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

annee

Description	Student's academic year
Exemple	2014/2015

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Student's login or ionis_id	christopher.paccard@epitech.eu
type	string	true	Referent's type	pere

Return

Parameter	Type	Description
data	JSON array	Referent info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/pere

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/pere",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/pere",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/pere",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/pere"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/pere")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/students/christopher.paccard@epitech.eu/referents/pere")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": {
      "Etudiant":"christopher.paccard@epitech.eu",
      "Nom":"Paccard",
      "Prenom":"Christophe",
      /* other available fields */,
      ...
  },
  "msg": "",
  "code": 200
}

POST /students/{login}/referents/push

Push new referent info for specific student

Documentation

Push new referent info of specific student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action add a new referent for the specified student.

You can substitute the student's ionis_id in place of the login.

You must specify a referent type in the field Tuteur.

Values for the field Tuteur are : Père , Mère , À contacter en cas d'urgence , Responsable financier

Fields that can be filled depends on restrictions upon your account.

If the filter annee is omitted, it will be set to the current academic year.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

annee

Description	Student's academic year
Exemple	2014/2015

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Student's login or ionis_id	christopher.paccard@epitech.eu

Return

Parameter	Type	Description
data	JSON array/object	Error messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/push

Request Body:

{
    "Nom": "Paccard",
    "Prenom": "Suzanne",
    "Ville": "Paris",
    "Pays": "France",
    "Tuteur": "Mère"
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/push",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France','Tuteur':'Mère'}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/push",
  "method" : "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    'Nom':'Paccard',
    'Prenom':'Suzanne',
    'Ville':'Paris',
    'Pays':'France',
    'Tuteur':'Mère'
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'POST',
  url: "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/push",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } },
  form:
  {
    'Nom':'Paccard',
    'Prenom':'Suzanne',
    'Ville':'Paris',
    'Pays':'France',
    'Tuteur':'Mère'
  }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/push"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

payload = "{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France','Tuteur':'Mère'}"

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/push")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'
request.body = "{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France','Tuteur':'Mère'}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.post("https://oai.epitech.eu/students/christopher.paccard@epitech.eu/referents/push")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France','Tuteur':'Mère'}")
.asString();

Response returned :

{
  "data": [],
  "msg": "Referent added to student with login : christopher.paccard@epitech.eu",
  "code": 201
}

POST /students/{login}/referents/update/{type}

Update referent info of specified type for specific student

Documentation

Update referent info of specified type for specific student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action update referent info of the specified type for the specified student.

You can substitute the student's ionis_id in place of the login.

Referents type are : pere , mere , urgence , financier

Fields that can be filled depends on restrictions upon your account.

If the filter annee is omitted, it will be set to the current academic year.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

annee

Description	Student's academic year
Exemple	2014/2015

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Student's login or ionis_id	christopher.paccard@epitech.eu
type	string	true	Referent's type	mere

Return

Parameter	Type	Description
data	JSON array/object	Error messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/update/mere

Request Body:

{
    "Nom": "Paccard",
    "Prenom": "Suzanne",
    "Ville": "Paris",
    "Pays": "France"
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/update/mere",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France'}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/update/mere",
  "method" : "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    'Nom':'Paccard',
    'Prenom':'Suzanne',
    'Ville':'Paris',
    'Pays':'France'
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'POST',
  url: "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/update/mere",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } },
  form:
  {
    'Nom':'Paccard',
    'Prenom':'Suzanne',
    'Ville':'Paris',
    'Pays':'France'
  }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/update/mere"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

payload = "{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France'}"

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/christopher.paccard@epitech.eu/referents/update/mere")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'
request.body = "{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France'}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.post("https://oai.epitech.eu/students/christopher.paccard@epitech.eu/referents/update/mere")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'Nom':'Paccard','Prenom':'Suzanne','Ville':'Paris','Pays':'France'}")
.asString();

Response returned :

{
  "data": [],
  "msg": "Referent updated for student with login : christopher.paccard@epitech.eu",
  "code": 200
}

GET /students/{ionis_id}/finance

Get financial info of specific student

Documentation

Get financial info of a specific student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve financial informations, available for the owner of the APIKey, about the specified student.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
ionis_id	string	true	Student's ionis_id	TEPPC13060207580

Return

Parameter	Type	Description
data	JSON array	Financial info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/TEPPC13060207580/finance

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/TEPPC13060207580/finance",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/TEPPC13060207580/finance",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/students/TEPPC13060207580/finance",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/TEPPC13060207580/finance"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/TEPPC13060207580/finance")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/students/TEPPC13060207580/finance")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": {
      "Ionis_ID":"TEPPC13060207580",
      "Balance_Actuel": 0,
      "Balance_Total_Futur": 1,
      /* other available fields */,
      ...
  },
  "msg": "",
  "code": 200
}

POST /students/{ionis_id}/finance/push

Push financial info for specific student

Documentation

Push new referent info of specific student on IBP

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action add new financial informations for the specified student. The student, identified with his ionis_id must not already have financial info, otherwise consider the update action.

Fields that can be filled depends on restrictions upon your account.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
ionis_id	string	true	Student's ionis_id	TEPPC13060207580

Return

Parameter	Type	Description
data	JSON array/object	Error messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/TEPPC13060207580/finance/push

Request Body:

{
    "Balance_Actuel": 1,
    "Balance_Total_Futur": 1,
    "Balance_Actuel_Value": 1000,
    "Balance_Total_Futur_Value": 3000
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/push",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'Balance_Actuel':1,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000,'Balance_Total_Futur_Value':3000}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/push",
  "method" : "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    'Balance_Actuel':1,
    'Balance_Total_Futur':1,
    'Balance_Actuel_Value':1000,
    'Balance_Total_Futur_Value':3000
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'POST',
  url: "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/push",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } },
  form:
  {
    'Balance_Actuel':1,
    'Balance_Total_Futur':1,
    'Balance_Actuel_Value':1000,
    'Balance_Total_Futur_Value':3000
  }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/push"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

payload = "{'Balance_Actuel':1,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000,'Balance_Total_Futur_Value':3000}"

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/TEPPC13060207580/finance/push")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'
request.body = "{'Balance_Actuel':1,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000,'Balance_Total_Futur_Value':3000}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.post("https://oai.epitech.eu/students/TEPPC13060207580/finance/push")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'Balance_Actuel':1,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000,'Balance_Total_Futur_Value':3000}")
.asString();

Response returned :

{
  "data": [],
  "msg": "Financial info added to ionis_id : TEPPC13060207580",
  "code": 201
}

POST /students/{ionis_id}/finance/update

Update financial info for the specified student

Documentation

Update financial info of specified type for specific student

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action update financial info for the specified student. The student, identified with his ionis_id must already have financial info, otherwise consider using the push action.

Fields that can be filled depends on restrictions upon your account.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

ecole

Description	Query specific school
Exemple	epitech

Parameters

Parameter	Type	Required?	Description	Exemple
ionis_id	string	true	Student's ionis_id	TEPPC13060207580

Return

Parameter	Type	Description
data	JSON array/object	Error messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/students/TEPPC13060207580/finance/update

Request Body:

{
    "Balance_Actuel": 0,
    "Balance_Total_Futur": 1,
    "Balance_Total_Futur_Value": 3000
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/update",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'Balance_Actuel':0,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/update",
  "method" : "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    'Balance_Actuel':0,
    'Balance_Total_Futur':1,
    'Balance_Actuel_Value':1000
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'POST',
  url: "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/update",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } },
  form:
  {
    'Balance_Actuel':0,
    'Balance_Total_Futur':1,
    'Balance_Actuel_Value':1000,
  }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/students/TEPPC13060207580/finance/update"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

payload = "{'Balance_Actuel':0,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000}"

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/students/TEPPC13060207580/finance/update")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'
request.body = "{'Balance_Actuel':0,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.post("https://oai.epitech.eu/students/TEPPC13060207580/finance/update")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'Balance_Actuel':0,'Balance_Total_Futur':1,'Balance_Actuel_Value':1000}")
.asString();

Response returned :

{
  "data": [],
  "msg": "Financial info updated for ionis_id : TEPPC13060207580",
  "code": 200
}

GET /group

List all groups of employees

Documentation

List all groups of employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all groups to use in filter to the employees find query.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Return

Parameter	Type	Description
data	JSON array	List of groups
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/group

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/group",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/group",
  "method": "GET",
  "headers": { "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq" }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'GET',
  url: "https://oai.epitech.eu/api/group",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/group"
    
headers = { 'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq" }

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/group")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/group")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
    "admi",
    "prof"
  ],
  "msg": "",
  "code": 200
}

GET /employees/{login}

Get specific employee info

Documentation

Get specific employee info

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all informations, available for the owner of the APIKey, about the specified employee.

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu

Return

Parameter	Type	Description
data	JSON array	Employee info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/john.doe@epitech.eu

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/john.doe@epitech.eu",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/john.doe@epitech.eu",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/employees/john.doe@epitech.eu",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/john.doe@epitech.eu"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/john.doe@epitech.eu")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/john.doe@epitech.eu")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response return :

{
  "data": {
      "ionis_id": "",
      "login": "john.doe@epitech.eu",
      "email": "john.doe@epitech.eu",
      /* other available fields */,
      ...
    },
  "msg": "",
  "code": 200
}

GET /employees/group/{group}

Find all employees info of the specified group

Documentation

Find all employees info

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve all informations, available for the owner of the APIKey, about employees in the group specified.

Filters are optionnal:

if the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Return

Parameter	Type	Description
data	JSON array	All Results
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/group/prof

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/group/prof",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/group/prof",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/employees/group/prof",
  headers:
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/group/prof"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/group/prof")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/group/prof")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
    {
      "ionis_id":"",
      "login": "john.doe@epitech.eu",
      "email": "john.doe@epitech.eu",
      /* other available fields */,
      ...
    },
    { /* other employees */, ... }
  ],
  "msg": "",
  "code": 200
}

POST /employees/push

Push employee

Documentation

Push employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action push a new employee on IBP with the fields provided.

To activate a fallback that will first try to send the password by phone message then, if it fails, will be sent by email then you must set the field CBOMailFallback to true

When the fallback CBOMailFallback is set to true, the phone number can be omitted otherwise he is required.

Required fields :

firstname, lastname, school, group, city, [phone]

Optional fields :

email, ionis_id, active, password, email_perso

If the parameter school is not specified, it will be it will be set according to the domain name.

Parameters school and city willl be set as the first affiliated school of the employee.

This will require a JSON request body (be sure to set the Content-Type header to application/json).

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/push

POST fields:

{
    "firstname": "John",
    "lastname": "Doe",
    "school": "Epitech",
    "group": "prof",
    "city": "Paris",
    "phone": "+33612345678"
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/push",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'firstname':'John','lastname':'Doe',...}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
   "content-type: application/json"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/push",
  "method": "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
    "Content-Type": "application/json"
  },
  "data": {
    "firstname": "John",
    "lastname": "Doe",
    ...
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'POST',
  url: "https://oai.epitech.eu/api/employees/push",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq', Content-Type: "application/json" },
  form: 
   { firstname: 'John',
     lastname: 'Doe',
     ... } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/push"

payload = "{'firstname':'John','lastname':'Doe',...}"
headers = {
    'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
    'Content-Type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/push")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/json'
request.body = "{'firstname':'John','lastname':'Doe',...}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/push")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.header("content-type", "application/json")
.body("{'firstname':'John','lastname':'Doe',...}")
.asString();

Response returned :

{
  "data": {
    "id": 35465,
    "login": "john.doe@epitech.eu"
  },
  "message":"Employee john.doe@epitech.eu inserted with id : 35465",
  "code": 201
}

POST /employees/update/{login}

Update employee info

Documentation

Update employee info

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action updates the employee's info on IBP with the fields provided.

Possible fields:

login, email, firstname, lastname, school, group, ionis_id, active, phone, password, cities, affiliated

The parameters cities and affiliated are arrays of city names (each affiliated city must be present in the cities field).

This will require a JSON request body (be sure to set the Content-Type header to application/json).

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu

POST Fields:

{
    "firstname": "John",
    "lastname": "Doe",
    "email": "john.doe@epitech.eu",
    "school": "Epitech",
    "group": "prof",
    "cities": [
        "Paris",
        "Bordeaux"   
    ],
    "affiliated" : [
        "Paris"
    ]
}

Exemple code :

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'firstname':'John','lastname':'Doherty',...}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
   "content-type: application/json"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu",
  "method": "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq",
    "Content-Type": "application/json"
  },
  "data": {
    "firstname": "Johny",
    "lastname": "Doherty",
    ...
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'POST',
  url: "https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq', Content-Type: "application/json" } },
  form: 
   { firstname: 'Johny', lastname: 'Doherty', ... } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu"

payload = "{'firstname':'John','lastname':'Doherty',...}"
headers = { 'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq", 'Content-Type': "application/json" }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/json'
request.body = "{'firstname':'John','lastname':'Doherty',...}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/update/john.doe@epitech.eu")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.header("content-type", "application/json")
.body("{'firstname':'John','lastname':'Doherty',...}")
.asString();

Response returned :

{
  "data": {
      "id": 3958,
      "login": john.doe@epitech.eu
  },
  "message":"Employee john.doe@epitech.eu's info updated on IBP",
  "code": 200
}

GET /employees/{login}/cities

Get the cities of the specified employee

Documentation

Get the cities of the specified employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve a list of cities for the specified employee.

You can pass the key affiliated as filter to retrieve only affiliated cities (you can omit the value, only the presence of the filter is relevant).

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

affiliated

Description

Retrieve only affiliated cities

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu

Return

Parameter	Type	Description
data	JSON array	Employee info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
      "Epitech": [
          "Paris",
          "Lyon"
      ],
      "CodingAcademy": [
          "Lyon"
      ]
    ],
  "msg": "",
  "code": 200
}

GET /employees/{login}/cities/{school}

Get the cities of the specified school of the specified employee

Documentation

Get the cities of a school of the specified employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action retrieve a list of cities of the specified school for the specified employee.

You can pass the key affiliated as filter to retrieve only affiliated cities (you can omit the value, only the presence of the filter is relevant).

If the filter ecole is omitted, it will be set according to the domain name.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Filters

Name

Information

affiliated

Description

Retrieve only affiliated cities

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu
school	string	true	School name	Epitech

Return

Parameter	Type	Description
data	JSON array	Employee info
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
204	Return when successfull with no results
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy",
  "method" : "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
var options = {
  method: 'GET',
  url: "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy",
  headers: 
    { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } }
};

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request["content-type"] = 'application/x-www-form-urlencoded'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/CodingAcademy")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [
      "Lyon"
    ],
  "msg": "",
  "code": 200
}

POST /employees/{login}/cities/add/{school}/{city}

Add a city to the specified employee

Documentation

Add a city to the specified employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action add a city for the specified school to the specified employee.

You can pass a value to the affiliated field in the body of the request to set the new city as affiliated for the specified employee.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu
school	string	true	School to add to	CodingAcademy
city	string	true	City to add	Marseille

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille

POST fields:

{
    "affiliated": true
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'affiliated':true}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille",
  "method": "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    "affiliated": true
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'POST',
  url: "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' },
  form: 
   { affiliated: true } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille"

payload = "{'affiliated':true}"
headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request.body = "{'affiliated':true}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/add/CodingAcademy/Marseille")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'affiliated':true}")
.asString();

Response returned :

{
  "data": [],
  "message":"City added to the employee john.doe@epitech.eu",
  "code": 201
}

GET /employees/{login}/cities/remove/{school}/{city}

Remove a city from the specified employee

Documentation

Remove a city from the specified employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action remove a city for the specified school from the specified employee.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu
school	string	true	School of the city to remove	CodingAcademy
city	string	true	City to remove	Marseille

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "GET",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille",
  "method": "GET",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'GET',
  url: "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille"

headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/remove/CodingAcademy/Marseille")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.asString();

Response returned :

{
  "data": [],
  "message":"City removed from the employee john.doe@epitech.eu",
  "code": 200
}

POST /employees/{login}/cities/update/{school}/{city}

Update a city for the specified employee

Documentation

Update a city for the specified employee

A valid and authorized APIKey for a user with granted access must be added to the Request header.

This APIKey is retrieved from /revoke endpoint.

This action is restricted to to granted-access user only.

This action update the specified city of the specified school for the specified employee.

You can pass a value to the affiliated field in the body of the request to set the specified city as affiliated for the specified employee.

Requirements

Name	Requirement	Type	Description
APIKey	header	string	APIKey for authorization

Parameters

Parameter	Type	Required?	Description	Exemple
login	string	true	Employee's login	john.doe@epitech.eu
school	string	true	School of the city to update	CodingAcademy
city	string	true	City to update	Marseille

Return

Parameter	Type	Description
data	JSON array/object	Errors messages
msg	string	Message when failure
code	string	Status code

Status Codes

Status Code	Description
200	Returned when successfull
201	Returned when successfull with data recorded
503	Returned when OAI server is unreacheable
400	Return when incorrect request
401	Returned when authentication failed (Bad credentials maybe)
403	Returned when user is not granted for this action

Example

URL:

https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille

POST fields:

{
    "affiliated": true
}

Request exemple:

PHP JavaScript (jQuery) JavaScript (NodeJS) Python Ruby Java (Unirest)

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
 CURLOPT_URL => "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille",
 CURLOPT_RETURNTRANSFER => true,
 CURLOPT_CUSTOMREQUEST => "POST",
 CURLOPT_POSTFIELDS => "{'affiliated':true}",
 CURLOPT_HTTPHEADER => array(
   "APIKey: gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
 )));

$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);

if ($err)
  echo "cURL Error #:" . $err;
else
  echo $response;

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille",
  "method": "POST",
  "headers": {
    "APIKey": "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"
  },
  "data": {
    "affiliated": true
  }
 }
  
 $.ajax(settings).done(function (response) {
   console.log(response);
 });

var request = require("request");
 var options = { method: 'POST',
  url: "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille",
  headers: 
   { APIKey: 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq' },
  form: 
   { affiliated: true } };

request(options, function (error, response, body) {
  if (error)
      throw new Error(error);
  console.log(body);
});

import requests

url = "https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille"

payload = "{'affiliated':true}"
headers = {'APIKey': "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq"}

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["APIKey"] = 'gYm9kckhLnm6o8p3esssfFbr1A7sOGfq'
request.body = "{'affiliated':true}"

response = http.request(request)
puts response.read_body

HttpResponse response = Unirest.get("https://oai.epitech.eu/api/employees/john.doe@epitech.eu/cities/update/CodingAcademy/Marseille")
.header("APIKey", "gYm9kckhLnm6o8p3esssfFbr1A7sOGfq")
.body("{'affiliated':true}")
.asString();

Response returned :

{
  "data": [],
  "message":"City updated to the employee john.doe@epitech.eu",
  "code": 200
}

OAI API Documentation

[ BASE URL: /api , API VERSION: 0.7 ]

/ : API Informations

GET /info

Documentation

Return

Status Codes

Example

GET /services

Documentation

Requirements

Return

Status Codes

Example

/revoke : OAI API Key Revoke

GET /revoke

Documentation

Requirements

Return

Status Codes

Example

/students : Students actions

GET /list

Documentation

Requirements

Return

Status Codes

Example

GET /list/{param}

Documentation

Requirements

Filters

Parameters

Return

Status Codes

Example

GET /students

Documentation

Requirements

Filters

Return

Status Codes

Example

GET /students/{login}

Documentation

Requirements

Filters

Parameters

Return

Status Codes

Example

POST /students/push

Documentation

Required fields

Requirements

Return

Status Codes

Example

POST /students/update/{login}

Documentation

Requirements

Parameters

Return

Status Codes

Example

GET /students/{login}/referents

Documentation

Requirements

Filters

Parameters

Return

Status Codes

Example

GET /students/{login}/referents/{type}

Documentation

Requirements

Filters

Parameters

Return

Status Codes