Difference between revisions of "API"

From PC2wiki
Jump to: navigation, search
m (Status: added feature list)
m (removed "in development" added feature list)
Line 6: Line 6:
  
 
A developer will be able to create a Java class that can login and
 
A developer will be able to create a Java class that can login and
then retrieve information about the contest.  The API in development allows
+
then retrieve information about the contest.  The API provides
 
a developer to get information about team's, runs, problems, languages and
 
a developer to get information about team's, runs, problems, languages and
the standings when using a Judge or Board login.
+
the standings.  Complete standings can be retrieved when using a Judge or Board login.
 +
 
 +
==Documentation==
 +
 
 +
API Java was added into the distribution in version 9.1.3 build 1899.
 +
 
 +
The main Java doc page is each distribution at doc/api/index.html.
 +
 
 +
The API provides code snippets for a number of activities including:
 +
# Connect and login to a PC2 server
 +
# Print data from all runs in the contest
 +
# Print the name, site, and group of each team in the contest
 +
# Print the names of all the currently defined contest languages
 +
# Print the names of all the currently defined contest problems
 +
# Print the names of all currently defined (allowable) judgements (that is, judgements which a Judge may choose to assign to a given submitted run)
  
 
==Status==
 
==Status==
Line 24: Line 38:
  
 
The access to data and features is restricted by login account.
 
The access to data and features is restricted by login account.
 
==Documentation==
 
 
API Java was added into the distribution in version 9.1.3 build 1899.
 
 
The main Java doc page is each distribution at doc/api/index.html.
 
  
 
==See Also==
 
==See Also==
 
* [[Version 9]]
 
* [[Version 9]]

Revision as of 10:47, 15 January 2013

The PC² API (Application Programming Interface) is a set of Java interfaces and classes that provide a view into the contest data.

The API's goals are to allow developers to extend PC² while keeping complete integrity and security for the contest.

A developer will be able to create a Java class that can login and then retrieve information about the contest. The API provides a developer to get information about team's, runs, problems, languages and the standings. Complete standings can be retrieved when using a Judge or Board login.

Documentation

API Java was added into the distribution in version 9.1.3 build 1899.

The main Java doc page is each distribution at doc/api/index.html.

The API provides code snippets for a number of activities including:

  1. Connect and login to a PC2 server
  2. Print data from all runs in the contest
  3. Print the name, site, and group of each team in the contest
  4. Print the names of all the currently defined contest languages
  5. Print the names of all the currently defined contest problems
  6. Print the names of all currently defined (allowable) judgements (that is, judgements which a Judge may choose to assign to a given submitted run)

Status

The API provides developers the ability to access and extend pc2. The API supports the following features:

  1. Login/Logoff
  2. submit a run
  3. add listeners to respond to events (run submitted, judged, etc.) as they occur
  4. Get contest information
  5. Get run info (judgements, status, etc)
  6. Get clarification info (answers, status, etc).
  7. Get scoring information

The access to data and features is restricted by login account.

See Also