Rank One Partner API Version 1.0
You are currently viewing 'Get Schedule By School ID with Paging ' page
Usage
GET /Schedules/:SchoolGUID
Content-Type
application/json
Description
Return a list of schedules using supplied School ID with paging. 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:
/Schedules/123456-74ascas2csac5-sac741?TeamGUID=415241-dsc4ascasc226-as78247&StartDate=20161201&EndDate=20170501
Example
| Type | Name | Required | Note |
| URL | :SchoolID | YES | School ID that you have 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 | PageSize | NO | |
| Query String | PageNo | NO |
Sample response:
{
"Data": [
{
"ID": "4893aac9-be58-4462-9ebb-ae712b38e631",,
"TeamID": "28b2b8b5-aebe-4f0e-97a1-0c7f62204e4a",
"SchoolID": "a510303d-b986-4f5c-b492-6d84e33c622d",
"SchoolName": "Demo 1 HS",
"SportName": "Basketball (M)",
"SportGender": "M",
"LevelName": "Junior Varsity",
"TeamName": " Demonstrators",
"StartDate": "2022-03-28T16:30:00",
"StartDateOffset": "2022-03-28T21:30:00+00:00",
"StartTime": null,
"EndDate": "2022-03-28T18:30:00",
"EndDateOffset": "2022-03-28T23:30:00+00:00",
"DateModified": "2021-06-01T13:44:51.993",
"DateModifiedOffset": "2021-06-01T18:44:51.993+00:00",
"StartTBD": false,
"EndTBD": false,
"FacilityName": "Arlington Heights",
"Address": "4501 West Freeway",
"City": "Fort Worth",
"State": "TX",
"Zip": "76107",
"ScheduleDescription": null,
"OpponentTeamName": "Strikers",
"TeamScore": null,
"OpponentScore": null,
"CombinedScore": "",
"Location": "Away",
"LocationSymbol": "@",
"SpecialNotes": null,
"GameSummary": null,
"GameType": "Tournament",
"BusArrivalTime": null,
"BusDepartureTime": null,
"StudentDismissalTime": null,
"GameNotes": null,
"Televised": false,
"MapAddress": https://maps.google.com/?q=4501 West Freeway, TX, Fort Worth, 76107,
"GameAttachmentId": null,
"FileName": null,
"Facility_ID": 0,
"FacilityAway_ID": 0,
"GameStatus": "Scheduled",
"StreamURL": "",
"StreamStartDate": null,
}
],
"PagingInfo": {
"FirstPage": https://api.rankone.com/PartnerAPI/Schedules/A510303D-B986-4F5C-B492-6D84E33C622D?pageSize=100&pageNo=1,
"LastPage":https://api.rankone.com/PartnerAPI/Schedules/A510303D-B986-4F5C-B492-6D84E33C622D?pageSize=100&pageNo=1,
"NextPage": null,
"PreviousPage": https://api.rankone.com/PartnerAPI/Schedules/A510303D-B986-4F5C-B492-6D84E33C622D?pageSize=100&pageNo=1,
"PageNo": 1,
"PageCount": 1,
"PageSize": 100,
"TotalCount": 1,
}
}