Giter VIP home page Giter VIP logo

wcif's Introduction

WCIF

The official specification of the WCA Competition Interchange Format.

Implementation notes

Currently the WCA website implements most of the specification. The WCIF data for the given competition can be obtained via the following endpoints:

Public endpoint

https://worldcubeassociation.org/api/v0/competitions/:competition_id/wcif/public

Publicly available (with the confidential attributes stripped out). Note: the data may be cached up to 5 minutes.

Authorized endpoint

https://worldcubeassociation.org/api/v0/competitions/:competition_id/wcif

Restricted to competition managers. Additionally, a PATCH request allows for saving the data (currently a significant subset of it).

Note on WCA Live

In order to get up-to-date live results in the WCIF data, make sure you Synchronize on WCA Live. This action makes WCA Live save the data back to the WCA website, making it available for you when requesting one of the WCIF endpoints.

Limitations

  • Currently the WCA website returns Person#registrantId of null for people without a registration (e.g. non-participating organizer).
  • Currently the WCA website does not implement the following attributes: Event#competitorLimit, Round#scrambleSets, Activity#scrambleSetId

Examples

There are many applications using the WCIF format already, those include:

wcif's People

Contributors

jonatanklosko avatar timreyn avatar coder13 avatar danielegdal avatar gregorbg avatar kr-matthews avatar suphair avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.