ESSDeX: OneRoster - Users

Call (Development environment)

Run("https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/Users/"
      , bt1
      , arq.OCP_APIM_Key
      , "Users.json"
      , folder);

Where

• bt1 is the bearer token,
• arq.OCP_APIM_Key is the API Manager Key (Not used)
• "Users.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:

{
    "users": [
        {
            "sourcedId": "0000176e-fae8-481b-a131-c2b020fbe11d",
            "status": "active",
            "dateLastModified": "2018-09-20T14:49:27.473Z",
            "metadata": {},
            "username": "0000176E-FAE8-481B-A131-C2B020FBE11D",
            "userIds": [],
            "enabledUser": "true",
            "givenName": "Cerys",
            "familyName": "Rowe",
            "middleName": null,
            "role": "student",
            "identifier": null,
            "email": null,
            "sms": null,
            "phone": null,
            "agents": [],
            "orgs": [
                {
                    "href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/schools/1F75608A-9006-4FC8-96E7-3E537C904B84",
                    "sourcedId": "1f75608a-9006-4fc8-96e7-3e537c904b84",
                    "type": "org"
                }
            ],
            "grades": [],
            "password": ""
        },
        {
            "sourcedId": "00750c7c-a3d0-4d16-b9f8-2d917755b23b",
            "status": "active",
            "dateLastModified": "2018-09-18T12:10:24.840Z",
            "metadata": {},
            "username": "00750C7C-A3D0-4D16-B9F8-2D917755B23B",
            "userIds": [],
            "enabledUser": "true",
            "givenName": "Nathan",
            "familyName": "Quinn",
            "middleName": null,
            "role": "student",
            "identifier": null,
            "email": null,
            "sms": null,
            "phone": null,
            "agents": [],
            "orgs": [
                {
                    "href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/schools/1F75608A-9006-4FC8-96E7-3E537C904B84",
                    "sourcedId": "1f75608a-9006-4fc8-96e7-3e537c904b84",
                    "type": "org"
                }
            ],
            "grades": [],
            "password": ""
        },
        {
            "sourcedId": "0119ff2d-72fc-41d1-b1f7-a21bef17aa4c",
            "status": "active",
            "dateLastModified": "2018-08-03T09:14:41.600Z",
            "metadata": {},
            "username": "0119FF2D-72FC-41D1-B1F7-A21BEF17AA4C",
            "userIds": [],
            "enabledUser": "true",
            "givenName": "Elliot",
            "familyName": "Peters",
            "middleName": null,
            "role": "student",
            "identifier": null,
            "email": null,
            "sms": null,
            "phone": null,
            "agents": [],
            "orgs": [
                {
                    "href": "https://simsid-partner-oneroster.azurewebsites.net/ims/oneroster/v1p1/schools/1F75608A-9006-4FC8-96E7-3E537C904B84",
                    "sourcedId": "1f75608a-9006-4fc8-96e7-3e537c904b84",
                    "type": "org"
                }
            ],
            "grades": [],
            "password": ""
        },