Rank One Partner API Version 1.0
You are currently viewing ' Get Users By School Or Sport ' page
Usage
GET /Auth/Users/:DistrictGUID
Content-Type
application/json
Description
Return list of users associated with school and sport.
Note
Put the access token generated from the /Auth/ValidateLogin endpoint in the request header field "Authorization" as "bearer ACCESS_TOKEN_HERE".Sample request URLs:
/Auth/Users/6844b811-4bf8-40c8-a6fa-8fb645457def /Auth/Users/6844b811-4bf8-40c8-a6fa-8fb645457def?SportID=3 /Auth/Users/6844b811-4bf8-40c8-a6fa-8fb645457def?SchoolID=41253-asv4fajb-82vsdv08-4&SportID=3
Example
| Type | Name | Required | Note |
|---|---|---|---|
| URL | DistrictGUID | Yes | DistrictGUID partner has access to |
| Query String | SchoolID | No | Sport ID partner has access to |
| Query String | SportID | No | School ID partner has access to |
Sample response:
[
[
{
"districtID": "a0a4767a-8fa3-4b52-abd5-1124af60581a",
"firstName": "Test",
"lastName": "Demo",
"address": "",
"city": "",
"state": "",
"officePhone": "",
"officeExt": "",
"cellPhone": "9724679975",
"homePhone": "",
"userName": "bassem.wadie@rankone.com",
"accessLevel": 3,
"schools": [
{
"schoolID": "a541e788-f947-405e-ba37-9146c376b16d",
"schoolName": "School 1 Middle School",
"schoolType": "Middle School",
"sports": [
{
"ID": 3,
"name": "Football",
"gender": "M"
}
]
}
]
},
...
]