The CompetitionSuite Developer Hub

Welcome to the CompetitionSuite developer hub. You'll find comprehensive guides and documentation to help you start working with CompetitionSuite as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    
Suggest Edits

List Competitions

 
gethttps://api.competitionsuite.com/2018-03/competitions

Query Params

o
string
required

Unique identifier for the organization

year
int32

Year of competitions you'd like to fetch. Lack of a year will fetch all competitions

includePractice
boolean

Determines whether practice events should be included in the response

 
using System;
using System.Net;

using (WebClient wc = new WebClient())
{
    wc.Headers.Add("Accepts", "application/json");
    string data = wc.DownloadString("http://api.competitionsuite.com/2018-03/Competitions/?o=<organization identifier>&year=<year>&includePractice=<includePractice>");

    Console.WriteLine(data);
}
A binary file was returned

You couldn't be authenticated

[
  {
    "EventGuid": "",
    "EventName": "",
    "Location": "",
    "Date": "",
    "CompetitionGuid": "",
    "CompetitionName": "",
    "ChiefJudge": "",
    "RecapUrl": "",
    "CategoryRecapUrl": "",
    "PerformancesUrl": "",
    "ScoresReleased": true,
    "CategoryRecapReleased": true,
    "RecapReleased": true,
    "OrgCompetitionID": "",
    "GroupTypeID": 0,
    "SeasonGuid": "",
    "SeasonName": "",
    "IsCurrentSeason": true,
    "RegistrationUrl": ""
  }
]
 
Suggest Edits

List Performances

 
gethttps://api.competitionsuite.com/2018-03/performances

Query Params

c
string
required

CompetitionGuid

 
using System;
using System.Net;

using (WebClient wc = new WebClient()) {
    wc.Headers.Add("Accepts", "application/json");
    string data = wc.DownloadString("https://api.competitionsuite.com/2018-03/performances/?c=<CompetitionGuid>");

    Console.WriteLine(data);
}
A binary file was returned

You couldn't be authenticated

[  
   {
      "DivisionName":"Mic Test",
      "DivisionInitials":"MT",
      "Round":"1",
      "RoundName":"Round 1",
      "GroupName":"Crazy Canucks",
      "OrgGroupIdentifier":"",
      "TotalScore":"0.000",
      "Rank":1,
      "SubtotalScore":"0.000",
      "SubtotalRank":1,
      "Performed":true,
      "NoScoreReason":"",
      "Categories":[  
         {  
            "Name":"General Effect",
            "Score":"0.00",
            "Rank":1,
            "Captions":[  
               {  
                  "JudgeFirstName":"Michael",
                  "JudgeLastName":"Gray",
                  "Name":"General Effect 1",
                  "Initials":"GE 1",
                  "Score":"0.00",
                  "Rank":1,
                  "Subcaptions":[  
                     {  
                        "Name":"Repertoire",
                        "Initials":"Rep",
                        "Score":"0",
                        "Rank":1
                     },
                     {  
                        "Name":"Performance",
                        "Initials":"Perf",
                        "Score":"0",
                        "Rank":1
                     }
                  ]
               },
               {  
                  "JudgeFirstName":"Mark",
                  "JudgeLastName":"McGahey",
                  "Name":"General Effect 1",
                  "Initials":"GE 1",
                  "Score":"0.00",
                  "Rank":1,
                  "Subcaptions":[  
                     {  
                        "Name":"Repertoire",
                        "Initials":"Rep",
                        "Score":"0",
                        "Rank":1
                     },
                     {  
                        "Name":"Performance",
                        "Initials":"Perf",
                        "Score":"0",
                        "Rank":1
                     }
                  ]
               }
            ]
         },
         {  
            "Name":"Visual",
            "Score":"0.00",
            "Rank":1,
            "Captions":[  
               {  
                  "JudgeFirstName":"Michael",
                  "JudgeLastName":"Turner",
                  "Name":"Visual Proficiency",
                  "Initials":"VP",
                  "Score":"0.00",
                  "Rank":1,
                  "Subcaptions":[  
                     {  
                        "Name":"Content",
                        "Initials":"Cont",
                        "Score":"0",
                        "Rank":1
                     },
                     {  
                        "Name":"Achievement",
                        "Initials":"Achv",
                        "Score":"0",
                        "Rank":1
                     }
                  ]
               }
            ]
         }
      ]
   }
]
 
Suggest Edits

Registration

 
 
 
Suggest Edits

Registrant Object

 
Field
Type
Description

DivisionName

String

Name of the Group's Division (or class)

DivisionInitials

String

Initials of the Group's Division (or class)

GroupName

String

Name of the Group

OrgGroupIdentifier

String

Identifier used to map a group in CompetitionSuite with a group in the organization's system

Waitlisted

Boolean

Indicator of whether the group is on the waitlist of the event or not

Priority

Integer

The position "in line" of the group for registration in the event

RegistrationDate

DateTime

Date and Time of when the group registered for the event (in UTC)

 
Suggest Edits

List Registered Groups

 
gethttps://api.competitionsuite.com/2018-03/registration

Query Params

e
string
required

Unique identifier of the event

 
using System;
using System.Net;

using (WebClient wc = new WebClient()) {
    wc.Headers.Add("Accepts", "application/json");
    string data = wc.DownloadString("https://api.competitionsuite.com/2018-03/registration/?e=<event identifier>");

    Console.WriteLine(data);
}
A binary file was returned

You couldn't be authenticated

[
  {
    "DivisionName": "Percussion Scholastic Open",
    "DivisionInitials": "PSO",
    "GroupName": "Indiana Pacers",
    "OrgGroupIdentifier": null,
    "Waitlisted": false,
    "Priority": 1,
    "RegistrationDate": "2016-11-01 11:02:00"
  }
]