Skip to content

GET api v1 students

Developer From Jokela edited this page Aug 14, 2020 · 1 revision

This request gets all students registered in Wilma from every school.

NOTE: This API doesn't work for every user type. This error means that your user type doesn't have access:

{
   "error":{
      "id":"common-32",
      "message":"Väärä käyttäjätyyppi",
      "description":"Tämä toiminto on käytössä vain tietyillä käyttäjätyypeillä.",
      "whatnext":"",
      "statuscode":403
   }
}

URL: https://<your_wilma_server>/api/v1/students/

{
   "Students":[
      {
         "Id":1401,
         "Caption":"Aamuinen Aava",
         "FirstName":"Aava",
         "LastName":"Aamuinen",
         "School":{
            "Id":12,
            "Caption":"Esimerkkilän peruskoulu (0-9)"
         },
         "Class":{
            "Id":193,
            "Caption":"8B"
         },
         "AllowProfile":true,
         "AllowMessage":true,
         "AllowMessageGuardian":true,
         "AllowEditTray":true
      },
      {
         "Id":3423,
         "Caption":"Aapro Aino",
         "FirstName":"Aino",
         "LastName":"Aapro",
         "School":{
            "Id":12,
            "Caption":"Esimerkkilän peruskoulu (0-9)"
         },
         "Class":{
            "Id":272,
            "Caption":"(6) suunnitteluoppilaat"
         },
         "AllowProfile":true,
         "AllowMessage":true,
         "AllowMessageGuardian":true,
         "AllowEditTray":true
      },
      {
         "Id":1307,
         "Caption":"Ahistus Adele",
         "FirstName":"Adele",
         "LastName":"Ahistus",
         "School":{
            "Id":12,
            "Caption":"Esimerkkilän peruskoulu (0-9)"
         },
         "Class":{
            "Id":204,
            "Caption":"8C"
         },
         "AllowProfile":true,
         "AllowMessage":true,
         "AllowMessageGuardian":true,
         "AllowEditTray":true
      }
   ]
}

Clone this wiki locally