orienteering-oss/eventor-api-openapi-spec

OpenAPI spec / Swagger for the Eventor API

eventor-api-openapi-spec

OpenAPI spec / Swagger for the Eventor API: openapi.yml.

You can browse the Swagger UI for this spec, but it will not work because of CORS. You can use it to browse and create cURL commands that you can execute in your own terminal. Or you could import the OpenAPI spec into Postman and make your calls from there.

What is Eventor? Eventor is the event system for orienteering races in different countries, so if you want to arrange an orienteering event, you will probably register it in your local Eventor system to make other people see it and for them to register to your event (and where you can upload results after the event is done).

Usage of the Eventor API

To use the Eventor API, you need an API key.

The different Eventor websites are:

• Norwegian Eventor
• Swedish Eventor
• Australian Eventor
• International Eventor

Add /api/documentation to either of the URLs to get the documentation for that particular Eventor website (the documentation is also included in the OpenAPI specification).

See also

• All data returned from the API is specified in IOF XSD v3, see this and JSON version of the same spec in orienteering-oss/iof-orienteering-data-schemas
• Java helper library for converting XML from Eventor to JSON objects (and back): orienteering-oss/iof-xml
• WIP: JavaScript helper library for converting XML from Eventor to JSON objects: mikaello/eventor-api-json-types
• GraphQL version of the Eventor API: mikaello/eventor-graphql-api

eventor-api-openapi-spec's Issues

Document XML input and return types

See: https://swagger.io/docs/specification/data-models/representing-xml/