• Introduction
• Using HTTPS
• Sources and contributors
• Formatting
• • INI
  • JSON
  • XML
  • PHP
• Do some checking...
• • Check authentification
  • Check if a login exists
  • Check Password
• Get informations!
• • Get login from uid
  • Get Uid
  • Get Name
  • Get Group
  • Get School
  • Get Promo
  • Get City
  • Get Report Url
  • Get Photo Url
  • Get .Plan
  • Get Phone
  • Get all informations
• Search for users
• • Search for users by their logins or names
  • Search for users by their promo, city and/or school
• Get global informations
• • Get schools
  • Get Cities
  • Get Promos
• Casts
• • Introducing Casts
  • Get Casts
  • Get Casts tree
  • Get Cast members
  • Get Casts of login
  • Is Cast?
  • Add Cast
  • Delete Cast
  • Add Cast member
  • Delete Cast member
• Errors
• Examples
• • PHP
  • sh
  • OCaml

Introduction

If you want to code your own tool that would need information and want it to be always up to date, you can use the web service from any language. It can provide many different data formats and is easily usable.

Informations about students are confidential, so you can get them only if you have a login and a PPP password registered in a Ionis School.

Using HTTPS

You can use HTTPS (Secure) for your requests.
Just replace http://ws.paysdu42.fr/ by https://return.epitech.eu/ws/

Sources and contributors

• Sources of this Website and this Web Service are available on GitHub.
• The Web Service is using the PHP Class, also available on GitHub.

Feel free to contribute by forking these projects on GitHub and make pull requests.
You can also help us by creating issues for features requests and bugs reports, on GitHub too.

Contributors:

• db0 (pretty much everything),
• Korfuri (search function),
• Lotfi Bentouati (intranet functions, gpa calculator),
• Toruk (members in casts, bug fix).

Formatting

This service is available in 4 formats :

• INI
  

  [action]
  action=get_school
  
  [error]
  error=none
  
  [result]
  login=noel_p
  school=epitech

• JSON
  

  {
    "action"="get_school",
    "error"="none",
    "result"=
    {
      "login":"noel_p",
      "school":"epitech"
    }
  }

• XML
  

  <action>get_school</action>
  <error>none</error>
  <result>
    <login>noel_p</login>
    <school>epitech</school>
  </result>

• PHP
  

  Array
  (
      [action] => get_school
      [error] => none
      [result] => Array
          (
              [login] => noel_p
              [school] => epitech
          )
  
  )

Just replace "format" by the format you prefer in your requests.
For example, to get the XML format, replace this : GET http://ws.paysdu42.fr/format/?action=get_school&auth_login=exampl_e&auth_password=2q4xfcc3&login=noel_p by this : GET http://ws.paysdu42.fr/XML/?action=get_school&auth_login=exampl_e&auth_password=2q4xfcc3&login=noel_p

The following examples are using INI format because it's shorter and human-readable. The "action" and the "error" parts are skipped.

Do some checking...

Warning Your login and your password MUST be provided, or you will get errors for all your request.

Check authentification

Simply check authentification.

Request parameters

• action : "login"
• auth_login : your ionis login
• auth_password : your PPP password

Answer

• error : See error table

Example

[error]
error=none

[result]

Check if a login exists

This action check if a login exists.

Request parameters

• action : "is_login"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the ionis login

Answer

• login : the login
• state : "OK" | "KO"
• error : See error table

Example

[result]
login=noel_p
state=OK

Check Password

This action check if the login and the password match.

Request parameters

• action : "check_password"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the ionis login
• password : the PPP password

Answer

• login : the login
• state : "OK" | "KO"
• error : See error table

Example

[result]
login=noel_p
state=OK

Get informations!

Warning Your login and your password MUST be provided, or you will get errors for all your request.

Get login from uid

Request parameters

• action : "get_login_from_uid"
• auth_login : your ionis login
• auth_password : your PPP password
• uid : the uid

Answer

• uid : the uid
• login : the login
• error : See error table

Example

[result]
uid=74695
login=lepage_b

Get Uid

Request parameters

• action : "get_uid"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• uid : the uid
• error : See error table

Example

[result]
login=noel_p
uid=7055

Get Name

Request parameters

• action : "get_name"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• name : first name and last name
• error : See error table

Example

[result]
login=lepage_b
name=Barbara Lepage

Get Group

Request parameters

• action : "get_group"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• group : the group
• error : See error table

Example

[result]
login=lepage_b
group=epitech_2014

Get School

Request parameters

• action : "get_school"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• school : the school
• error : See error table

Example

[result]
login=lepage_b
school=epitech

Get Promo

Request parameters

• action : "get_promo"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• promo : the promo
• error : See error table

Example

[result]
login=lepage_b
promo=2014

Get City

Request parameters

• action : "get_city"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• city : the city
• error : See error table

Example

[result]
login=lepage_b
city=Paris

Get Report Url

Request parameters

• action : "get_report_url"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• report_url : the report url on the epitech intranet
• error : See error table

Example

[result]
login=lepage_b
report_url=http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=lepage_b

Get Photo Url

Request parameters

• action : "get_photo_url"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login
• (optional) https: Must be 1 if you want a secure url (https). Default = 0.

Answer

• login : the login
• photo_url : the photo url on the epitech intranet
• error : See error table

Example

[result]
login=lepage_b
photo_url=http://www.epitech.eu/intra/photos/lepage_b.jpg

Get .Plan

Request parameters

• action : "get_plan"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• plan : the .plan file in the AFS on public folder
• error : See error table

Example

[result]
login=corfa_u
plan=..General

	  Nom:Uriel Corfa
	  Login:corfa_u
	  Pseudo:Korfuri
	  Promo:Epitech 2011
	  Ville:Paris
	  UID:71070

..Activites

	  Assistant/Labs:Astek, Koala, ESL
	  Lieu de travail usuel:Koalab, ESL

..Contact

	  Netsoul:Je ne recois pas les messages ns
	  Tel:06.28.33.53.29

Get Phone

Request parameters

• action : "get_phone"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• phone : the phone number in the .plan file
• error : See error table

Example

[result]
login=corfa_u
phone=06.28.33.53.29

Get all informations

Request parameters

• action : "get_infos"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login

Answer

• login : the login
• uid : the uid
• name : first name and last name
• group : the group
• school : the school
• promo : the promo
• city : the city
• report_url : the report url on the epitech intranet
• photo_url : the photo url on the epitech intranet
• plan : the .plan file in the AFS on public folder
• phone : the phone number in the .plan file
• error : See error table

Example

[result]
login=lepage_b
uid=74695
name=Barbara Lepage
group=epitech_2014
school=Epitech
promo=2014
city=Paris
report_url=http://www.epitech.eu/intra/index.php?section=etudiant&page=rapport&login=lepage_b
photo_url=http://www.epitech.eu/intra/photos/lepage_b.jpg
plan=06 . 28 . 47 . 13 . 44

Search for users

Warning Please take into account that these two requests allow you to get the entire list of logins and it's a huge cost for our server so use it sparingly.

Search for users by their logins or names

Request parameters

• action : "search"
• auth_login : your ionis login
• auth_password : your PPP password
• query : all or part of a login or name

Answer

• A list of logins matching the given criteria
• error : See error table

Example

[result]
1=corfa_a
2=corfa_u
3=corfa_z

Search for users by their promo, city and/or school

Request parameters

• action : "get_logins"
• auth_login : your ionis login
• auth_password : your PPP password
• (optional) school : the requested school
• (optional) promo : the requested promo
• (optional) city : the requested city

Answer

• The list of logins in the requested school, promo and/or city
• error : See error table

Example

[result]
1=exampl_e
2=carame_l
3=nyanca_t

Get global informations

Get schools

Request parameters

• action : "get_schools"
• auth_login : your ionis login
• auth_password : your PPP password
• (optional) from_database: Must be 0 (default), if you want to be sure that these schools exists and are real, 1 if you want to get them from the database (generated automatically so can be a fake school like "tmp", "old", "guest", "prof-adm"...)

Answer

• The list of schools
• error : See error table

Example

[result]
0="isbp"
1="epitech"
2="epita"
3="ionis"
4="etna"
5="ipsa"
6="eart"
7="supinternet"
8="web"

Get Cities

Request parameters

• action : "get_cities"
• auth_login : your ionis login
• auth_password : your PPP password
• (optional) school: optional parameter to select only cities where the given school is and return value is

Answer

• The list of cities
• error : See error table

Example

[result]
0="Paris"
1="Lyon"
2="Nantes"
3="Bordeaux"
4="Lille"

Get Promos

Request parameters

• action : "get_promos"
• auth_login : your ionis login
• auth_password : your PPP password
• (optional) school: current promos for the given school (epitech by default)
• (optional) from_database: Must be 1 if you want to get all promos in the database (the school parameter is ignored). Default = 0.

Answer

• The list of promos
• error : See error table

Example

[result]
0="2013"
1="2014"
2="2015"

Casts

Introducing casts

People in Ionis, or at leat at Epitech, often have a role. They can be a teacher, director, assistant, member of an association, permanent of a laboratory and many more!

These groups are called "Casts".

Casts are represented as a tree with four main nodes: General, Pedago, Labo and Asso.

Being a member of a cast can provide benefits, including managing casts and members thereof.

Our Web-Service allows you to retrieve casts, but also add, delete, and manage members.
You must be in the right cast to be able to do it.
However, no specific right is required for a simple recovery.

If you think you should have the right to do something, but you don't, please contact us.

Our database is so far the safest and most up to date in the campus, at least for Epitech, since we have a moral contract with directors, laboratories and associations.

Get Casts

Request parameters

• action : "get_casts"
• auth_login : your ionis login
• auth_password : your PPP password
• (optional) root: the root node of casts you want. / by default.

Answer

• A simple list of all casts. A flatten version of the casts tree.
• error : See error table

Example

[result]
0="Koala_pedago"
1="Koala_Cpp"
2="Koala_Csharp"
3="Koala_CSI-UML"
4="Koala_Java"
5="Koala_KOOC"
6="Koala_OCaml"

Get Casts tree

Warning This function is not compatible with the INI format. It will call the action get_casts.

Request parameters

• action : "get_casts_tree"
• auth_login : your ionis login
• auth_password : your PPP password
• (optional) root: the root node of casts you want. / by default.

Answer

• A tree representation of casts.
• error : See error table

Example (XML)

  <result>
    <Koala>
      <Koala_chef />
      <Koala_permanents />
    </Koala>
  </result>

Get Cast members

Request parameters

• action : "get_casts_members"
• auth_login : your ionis login
• auth_password : your PPP password
• cast : the name of the cast of which you want to get the members

Answer

• The list of cast members
• error : See error table

Example

[result]
0="benram_s"
1="delaho_g"
2="galby_j"

Get Casts of login

Request parameters

• action : "get_casts_of_login"
• auth_login : your ionis login
• auth_password : your PPP password
• login : the login for which you want to know the casts it belongs to

Answer

• The list of casts
• error : See error table

Example

[result]
0="Delegues"
1="Delegues_Paris"
2="Delegues_2014"
3="Koala_OCaml"
4="ReturnToLife_Admin"
5="Lateb_Ancien_Bureau"
6="ESL_Pedago"
7="DontPanic_Bureau"

Is Cast?

Request parameters

• action : "is_cast"
• auth_login : your ionis login
• auth_password : your PPP password
• cast : the name of the cast

Answer

• state : "OK" | "KO"
• error : See error table

Example

[result]
state="OK"

Add Cast

Request parameters

• action : "add_cast"
• auth_login : your ionis login
• auth_password : your PPP password
• name : the name of the new cast
• parent : the name of the parent cast of the new cast

Answer

• state : "OK" | "KO"
• error : See error table

Example

[result]
state="OK"

Delete Cast

Warning Delete a cast will also delete its sub-casts, members, rights and all other information. This action is irreversible.

Request parameters

• action : "delete_cast"
• auth_login : your ionis login
• auth_password : your PPP password
• cast : the name of the cast you want to delete

Answer

• state : "OK" | "KO"
• error : See error table

Example

[result]
state="OK"

Add Cast member

Request parameters

• action : "add_cast_member"
• auth_login : your ionis login
• auth_password : your PPP password
• cast : the name of the cast
• login : the login you want to be member of the cast

Answer

• state : "OK" | "KO"
• error : See error table

Example

[result]
state="OK"

Delete Cast member

Request parameters

• action : "delete_cast_member"
• auth_login : your ionis login
• auth_password : your PPP password
• cast : the name of the cast
• login : the login you want to delete from the cast

Answer

• state : "OK" | "KO"
• error : See error table

Example

[result]
state="OK"

Errors

none

missing_parameters

unknown_action

auth_fail

Examples

Here are some examples of usage of this web service in various languages. If you use a language that is not on this list and want to have an example or provide your own example, please contact us.