School

This API is used to provide access to school information such as users, academics, admissions, athletics, content, lists, and general school info.

POST

Athletics game create

Creates a new athletic game for the specified team_id.
Requires at least one of the following roles in the Education Management system:

  • Athletic Group Manager
  • Team Schedule Manager
  • Schedule Manager
  • Coach
  • Pending Coach

Try it

Request URL

Request parameters

Parameter Required Type Description
team_id Property is required integer

ID of the team for the game to be created

Request headers

Header Required Type Description
Content-Type string Media type of the body sent to the API.
Bb-Api-Subscription-Key Property is required string Subscription key which provides access to this API. Found in your Profile.
Authorization Property is required string OAuth 2.0 access token obtained from Blackbaud OAuth 2.0 Service. Supported grant types: Authorization code.

Request body

Information about the game to be created

{
  "schedule_type": 0,
  "title": "Game Title",
  "game_date": "2021-10-05T17:30:00Z",
  "game_date_end": "2021-10-05T19:30:00Z",
  "home_away_type": 1,
  "location_id": 5489,
  "dismissal_time": "2023-05-30",
  "departure_time": "2023-05-30",
  "departure_note": "We are departing at lunch",
  "pickup_time": "2023-05-30",
  "pickup_note": "We will return at end of school",
  "league_ind": true,
  "scrimmage_ind": false,
  "tournament_ind": false,
  "invitational_ind": true,
  "playoff_ind": false,
  "additional_notes": "Please read this.",
  "send_notifications": true,
  "skip_validation": false,
  "transportation": [
    {
      "transportation_id": 54095,
      "full_day": false,
      "begin_use": "2021-10-05T16:00:00Z",
      "end_use": "2021-10-05T20:15:00Z"
    }
  ],
  "opponents": [
    {
      "opponent_id": 94508
    }
  ]
}
{
  "required": [
    "game_date"
  ],
  "type": "object",
  "properties": {
    "schedule_type": {
      "type": "integer",
      "description": "The Type of the event",
      "format": "int32",
      "nullable": true
    },
    "title": {
      "type": "string",
      "description": "Title of the game",
      "nullable": true
    },
    "game_date": {
      "type": "string",
      "description": "Date and time of the game <br />\r\nUses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> format: <code>2022-01-20T16:30:00-05:00</code>",
      "format": "date-time"
    },
    "game_date_end": {
      "type": "string",
      "description": "Date and time the game is set to end <br />\r\nUses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> format: <code>2022-01-20T16:30:00-05:00</code>",
      "format": "date-time",
      "nullable": true
    },
    "cancel_type": {
      "type": "integer",
      "description": "Defaults to 0 for a new game",
      "format": "int32",
      "nullable": true
    },
    "home_away_type": {
      "type": "integer",
      "description": "Set to 0 for Home <br />\r\nSet to 1 for Away <br />\r\nSet to 2 for Neutral <br />\r\nSet to 3 for TBD",
      "format": "int32",
      "nullable": true
    },
    "location_id": {
      "type": "integer",
      "description": "ID of the location/venue for the game",
      "format": "int32",
      "nullable": true
    },
    "location_ind": {
      "type": "integer",
      "description": "Set to 0 when using a venue for <code>location_id</code><br />\r\nSet to 1 when using a location for <code>location_id</code>",
      "format": "int32",
      "nullable": true
    },
    "dismissal_time": {
      "type": "string",
      "description": "Time for dismissal using 24-hour format: <code>HH:mm</code>",
      "nullable": true
    },
    "departure_time": {
      "type": "string",
      "description": "Time for departure using 24-hour format: <code>HH:mm</code>",
      "nullable": true
    },
    "departure_note": {
      "type": "string",
      "description": "Notes related to departure",
      "nullable": true
    },
    "pickup_time": {
      "type": "string",
      "description": "Time for pickup using 24-hour format: <code>HH:mm</code>",
      "nullable": true
    },
    "pickup_note": {
      "type": "string",
      "description": "Notes related to pickup",
      "nullable": true
    },
    "league_ind": {
      "type": "boolean",
      "description": "Set to true to indicate a league event",
      "nullable": true
    },
    "scrimmage_ind": {
      "type": "boolean",
      "description": "Set to true to indicate a scrimmage event",
      "nullable": true
    },
    "tournament_ind": {
      "type": "boolean",
      "description": "Set to true to indicate a tournament event",
      "nullable": true
    },
    "invitational_ind": {
      "type": "boolean",
      "description": "Set to true to indicate an invitational event",
      "nullable": true
    },
    "playoff_ind": {
      "type": "boolean",
      "description": "Set to true to indicate a playoff event",
      "nullable": true
    },
    "additional_notes": {
      "type": "string",
      "description": "Additional notes for the event",
      "nullable": true
    },
    "news_id": {
      "type": "integer",
      "description": "News ID",
      "format": "int32",
      "nullable": true
    },
    "send_notifications": {
      "type": "boolean",
      "description": "Toggles 'Send Notification' option",
      "nullable": true
    },
    "clear_reschedule": {
      "type": "boolean",
      "description": "Set to true to remove the original scheduled game",
      "nullable": true
    },
    "skip_validation": {
      "type": "boolean",
      "description": "Set to true to skip validation of this event",
      "nullable": true
    },
    "transportation": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "transportation_id": {
            "type": "integer",
            "description": "ID of the transportation item to be used",
            "format": "int32"
          },
          "full_day": {
            "type": "boolean",
            "description": "Toggle if transportation should be booked for the full day",
            "nullable": true
          },
          "begin_use": {
            "type": "string",
            "description": "Start date/time for transportation use <br />\r\nUses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> format: <code>2022-01-20T16:30:00-05:00</code>",
            "format": "date-time",
            "nullable": true
          },
          "end_use": {
            "type": "string",
            "description": "End date/time for transportation use <br />\r\nUses <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\">ISO-8601</a> format: <code>2022-01-20T16:30:00-05:00</code>",
            "format": "date-time",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": ""
      },
      "description": "List of the transportation to be used for this game",
      "nullable": true
    },
    "opponents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "opponent_id": {
            "type": "integer",
            "description": "the opponent id",
            "format": "int32"
          }
        },
        "additionalProperties": false,
        "description": "A game opponent"
      },
      "description": "List of Opponent ID's involved in this game",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": ""
}

Response 200 OK

Success

0
{
  "type": "integer",
  "format": "int32",
  "x-apim-inline": true
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule"
-H "Content-Type: application/json"
-H "Bb-Api-Subscription-Key: {subscription key}"
-H "Authorization: Bearer {access token}"
--data-ascii "{body}"

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }

        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Bb-Api-Subscription-Key", "{subscription key}");
            client.DefaultRequestHeaders.Add("Authorization", "Bearer {access token}");

            var uri = "https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule?" + queryString;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               var response = await client.PostAsync(uri, content);
            }

        }
    }
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Bb-Api-Subscription-Key", "{subscription key}");
            request.setHeader("Authorization", "Bearer {access token}");

            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity)); 
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };

        $.ajax({
            url: "https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Bb-Api-Subscription-Key","{subscription key}");
                xhrObj.setRequestHeader("Authorization","Bearer {access token}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

    NSString* path = @"https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];

    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Bb-Api-Subscription-Key"];
    [_request setValue:@"Bearer {access token}" forHTTPHeaderField:@"Authorization"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];

    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);

        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }

        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }

        NSLog(@"%@", json);
        _connectionData = nil;
    }

    [pool drain];

    return 0;
}

<?php
// This sample uses the PEAR HTTP client from http://pear.php.net/package/HTTP_Request2
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule');
$url = $request->getUrl();

$headers = array(
    // Request headers
   'Content-Type' => 'application/json',
   'Bb-Api-Subscription-Key' => '{subscription key}',
   'Authorization' => 'Bearer {access token}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/school/v1/athletics/teams/{team_id}/schedule?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Bb-Api-Subscription-Key': '{subscription key}',
    'Authorization': 'Bearer {access token}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.sky.blackbaud.com')
    conn.request("POST", "/school/v1/athletics/teams/{team_id}/schedule?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.sky.blackbaud.com/school/v1/athletics/teams/{team_id}/schedule')

request = Net::HTTP::Post.new(uri.request_uri)

# Request headers
request['Content-Type'] = 'application/json'
request['Bb-Api-Subscription-Key'] = '{subscription key}'
request['Authorization'] = 'Bearer {access token}'

# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body

Comments

Have a question? See a problem with our docs? Want to engage with the SKY Developer team? Please visit us on the SKY Developer Community!