Web: RAP API - Students
Call (Development environment)
Run("https://simsid-partner-rapapi.azurewebsites.net/api/v1/Organisation/"+ arq.Organisation_ID+ "/students/"
, bt1
, arq.OCP_APIM_Key
, "RAP_Students,json"
, folder);
Where
- arq.Organisation_ID is the organisation id of the school.
- bt1 is the bearer token,
- arq.OCP_APIM_Key is the API Manager Key (Not used)
- "RAP_Students.json" is the file name to write the output to and
- folder is the location to create the file
You can find all the base class definitions here along with details of the scopes.
NB: The live URL will have a different 'stem'.
Will return:
[
{
"Id": "EFDB44C9-ECE3-4230-9CF6-09FC960C78FD",
"Title": null,
"FirstName": "Aaliyah",
"MiddleName": null,
"LastName": "Gibbs",
"EmailAddress": null,
"DateOfBirth": null,
"Gender": "",
"PupilPremiumStatus": false,
"YearGroup": {
"Id": null,
"Name": null,
"GroupType": null
},
"RegistrationGroup": {
"Id": "d27f184e-d11f-47d4-8676-19bc9db9192a",
"Name": "ELM",
"GroupType": "Registration Group"
},
"LastUpdated": "2018-12-14T09:46:01.927",
"StudentExtId": null
},
{
"Id": "0836D28D-CB3D-4375-98A6-24150E051479",
"Title": null,
"FirstName": "Aaliyah",
"MiddleName": null,
"LastName": "Goddard",
"EmailAddress": null,
"DateOfBirth": null,
"Gender": "",
"PupilPremiumStatus": false,
"YearGroup": {
"Id": "c34f0e6d-fdd3-4f96-ac14-d47b4dfa94b3",
"Name": "Year 12x",
"GroupType": "Year Group"
},
"RegistrationGroup": {
"Id": "a7d757eb-44e1-45e4-a29a-7fb47439895a",
"Name": "AM",
"GroupType": "Registration Group"
},
"LastUpdated": "2018-12-14T09:46:02.393",
"StudentExtId": null
},
{
"Id": "33461A43-4247-4AFC-A4BE-2B73C5885EF2",
"Title": null,
"FirstName": "Aaron",
"MiddleName": null,
"LastName": "Webb",
"EmailAddress": null,
"DateOfBirth": null,
"Gender": "",
"PupilPremiumStatus": false,
"YearGroup": {
"Id": "0ef1ff6f-4cd3-4aa2-8ed5-ea4b867a6635",
"Name": "4x",
"GroupType": "Year Group"
},
"RegistrationGroup": {
"Id": "9e5640bb-25b4-4f38-8b17-42099b3daf2a",
"Name": "4ES",
"GroupType": "Registration Group"
},
"LastUpdated": "2018-12-14T09:46:02.363",
"StudentExtId": null
},