Rank One Partner API Version 1.0
You are currently viewing 'Get Schedule By School ID ' page
Usage
GET /Schedule/:SchoolGUID
Content-Type
application/json
Description
Return a list of schedules using supplied School ID. Filter result by providing optional parameters as listed below. School year of the schedules will be based on current school year at the moment API call is made, or the year of StartDate parameter if it is provided.
Note
Put the access token generated from the Get Access Token endpoint (Auth/ValidateUser) in the request header field "Authorization" as "bearer ACCESS_TOKEN_HERE". StartDate and EndDate must be both provided or omitted.If not then bad request response will be returned.
Sample request URL with TeamGUID, StarteDate and EndDate:
/Schedule/123456-74ascas2csac5-sac741?TeamGUID=415241-dsc4ascasc226-as78247&StartDate=20161201&EndDate=20170501
Example
| Type | Name | Required | Note |
| URL | :SchoolID | YES | School ID partner has access to |
| Query String | SportID | NO | |
| Query String | TeamGUID | NO | |
| Query String | StartDate | NO | Must be formatted as yyyyMMdd |
| Query String | EndDate | NO | Must be formatted as yyyyMMdd |
| Query String | ModifiedDateStart | NO | Must be formatted as mm/dd/yyyy hh:mm:ss |
| Query String | ModifiedDateEnd | NO | Must be formatted as mm/dd/yyyy hh:mm:ss |
| Query String | GetPrivate | NO | Must be True or False only. If true, will also return private games. |
| Query String | Location | NO | Must be H or A only. H = Home and A = Away. |
Sample response:
[
{
"ID": "14253ssc-4dc1a25sa-1csc5s2sac3-74asc2",
"SchoolName": "School 1 High School",
"SportName": "Basketball (M)",
"LevelName": "Varsity",
"TeamName": "Varsity BB",
"StartDate": "2017-02-03T14:00:00",
"EndDate": "2017-02-03T16:00:00",
"DateModified": "2017-02-03T10:00:00",
"DateModifiedOffset": "2017-02-03T15:00:00",
"StartTBD": false,
"EndTBD": false,
"FacilityName": "School 1 HS Aux Gym",
"Address": "18400 Creekview",
"City": "Sanger",
"State": "TX",
"Zip": "76266",
"ScheduleDescription": "Varsity BB vs George Town (M)",
"OpponentTeamName": "George Town",
"TeamScore": "",
"OpponentScore": "",
"Location": "Home",
"SpecialNotes": "",
"GameSummary": "",
"GameType": "Tournament",
"BusArrivalTime": "",
"BusDepartureTime": "",
"StudentDismissalTime": "",
"GameNotes": "",
"Televised": false,
"Facility_ID": "11485",
"FacilityAway_ID": 0
},
...
]