Web: OneRoster - Enrollments
Call (Development environment)
Run("https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/enrollments/"
, bt1
, arq.OCP_APIM_Key
, "enrollments.json"
, folder);
Where
- bt1 is the bearer token,
- arq.OCP_APIM_Key is the API Manager Key (Not used)
- "enrollments.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:
{
"enrollments": [
{
"sourcedId": "55f6d0c5-f2cc-4d7f-abfb-e0c90ee7597d",
"status": "active",
"dateLastModified": "0001-01-01T00:00:00.000Z",
"metadata": {},
"user": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/students/22E4FEBC-A6EE-4DDC-8883-62455C6E0D71",
"sourcedId": "22e4febc-a6ee-4ddc-8883-62455c6e0d71",
"type": "student"
},
"class": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/classes/4821FF60-4D20-4267-8C36-1A01D5FED1DD",
"sourcedId": "4821ff60-4d20-4267-8c36-1a01d5fed1dd",
"type": "class"
},
"school": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/schools/1F75608A-9006-4FC8-96E7-3E537C904B84",
"sourcedId": "1f75608a-9006-4fc8-96e7-3e537c904b84",
"type": "org"
},
"role": "Student",
"primary": "",
"startDate": null,
"endDate": null
},
{
"sourcedId": "b43b3da1-6f93-4268-97c7-968f7cbb8b93",
"status": "active",
"dateLastModified": "0001-01-01T00:00:00.000Z",
"metadata": {},
"user": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/students/8D4E33A8-C3A8-4595-AA33-03A95B989214",
"sourcedId": "8d4e33a8-c3a8-4595-aa33-03a95b989214",
"type": "student"
},
"class": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/classes/4821FF60-4D20-4267-8C36-1A01D5FED1DD",
"sourcedId": "4821ff60-4d20-4267-8c36-1a01d5fed1dd",
"type": "class"
},
"school": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/schools/1F75608A-9006-4FC8-96E7-3E537C904B84",
"sourcedId": "1f75608a-9006-4fc8-96e7-3e537c904b84",
"type": "org"
},
"role": "Student",
"primary": "",
"startDate": null,
"endDate": null
},
{
"sourcedId": "dae94444-148f-471d-9288-e7cfbc76e943",
"status": "active",
"dateLastModified": "0001-01-01T00:00:00.000Z",
"metadata": {},
"user": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/students/5F0746FF-F963-4DD7-BCDE-1F13C125C227",
"sourcedId": "5f0746ff-f963-4dd7-bcde-1f13c125c227",
"type": "student"
},
"class": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/classes/4821FF60-4D20-4267-8C36-1A01D5FED1DD",
"sourcedId": "4821ff60-4d20-4267-8c36-1a01d5fed1dd",
"type": "class"
},
"school": {
"href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/schools/1F75608A-9006-4FC8-96E7-3E537C904B84",
"sourcedId": "1f75608a-9006-4fc8-96e7-3e537c904b84",
"type": "org"
},
"role": "Student",
"primary": "",
"startDate": null,
"endDate": null
}
]
}