INDEX
This version is deprecated. All clients should migrate to version 4

Regattas Schema

This service will return the schema of the Regattas structure.

URL: https://api.regattacentral.com/v3.0/regatta/schema

Returns

Text
A representation of the Regattas JSON schema.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/schema',
    headers: {"Accept": "text/plain"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

List Authorized Regattas

This service will return an array of regattas which you are authorized to access on RegattaCentral.

URL: https://api.regattacentral.com/v3.0/regatta/authorized

Secure This is a secure API and requires OAuth2 authentication.

Returns

JSON XML
A Regattas structure, including an array of one or more regattas which the user is authorized to access.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/authorized',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Entire Regatta

This service will return all information about the specified regatta

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/bulk

Secure This is a secure API and requires OAuth2 authentication.

Parameters

RegattaId
The RegattaCentral ID of the regatta that you wish to download.

Returns

JSON XML
A Regattas structure, including the requested regatta.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/bulk',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Organization Search

This service will return all organizations with a name that contains the search term

URL: https://api.regattacentral.com/v3.0/search/organization/{Term}

Secure This is a secure API and requires OAuth2 authentication.

Parameters

Term
The search term that will be used

Returns

JSON XML
An Organizations structure, including an array of one or more organizations whose names include the requested term.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/search/organization/columbus',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data:

Results: JSON

Participant Search

This service will return all athletes whose first or last name contains the search term and whose birthday matches the supplied birthdate

URL: https://api.regattacentral.com/v3.0/search/participant/{Term}/{Birthday}

Secure This is a secure API and requires OAuth2 authentication.

Parameters

Term
The search term that will be used

Birthday
The participant's birthday in the format YYYY-MM-DD

Returns

JSON XML
A Participants structure, including an array of one or more participants whose name includes the search term and whose birthday matches the input birthdate.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/search/participant/smith/1965-06-24',
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data:

Results: JSON

Countries with Regattas

This service will return a list of countries where regattas are being held that are registered with RegattaCentral

URL: https://api.regattacentral.com/v3.0/regattas/countries

Returns

JSON XML
A Regattas structure with a separate Regatta structure for each country. The venue structure contains the country information.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/countries',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Upcoming Regattas this year

This service will return a list of upcoming regattas this year

URL: https://api.regattacentral.com/v3.0/regattas/{Country}/upcoming

Parameters

Country
The 2 letter country code to filter the request

Returns

JSON XML
A Regattas structure with all future regattas in the specified country in the current year.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/US/upcoming',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Upcoming Regattas future years

This service will return a list of future regattas in the specified year

URL: https://api.regattacentral.com/v3.0/regattas/{Country}/upcoming/{Year}

Parameters

Country
The 2 letter country code to filter the request

Year
The year in the future to filter the request

Returns

JSON XML
A Regattas structure with all regattas in the specified country in the specified year.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/US/upcoming/2016',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Today's Regattas

This service will return a list of regattas occuring today.

URL: https://api.regattacentral.com/v3.0/regattas/{Country}/today

Parameters

Country
The 2 letter country code to filter the request

Returns

JSON XML
A Regattas structure listing the Regatta structures for today's regattas.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/US/today',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Previous Regattas this year

This service will return a list of regattas which have already occurred this year

URL: https://api.regattacentral.com/v3.0/regattas/{Country}/previous

Parameters

Country
The 2 letter country code to filter the request

Returns

JSON XML
A Regattas structure with all regattas in the specified country in the current year.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/US/previous',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Previous Regattas past years

This service will return the regattas which have occurred in previous years.

URL: https://api.regattacentral.com/v3.0/regattas/{Country}/previous/{Year}

Parameters

Country
The 2 letter country code to filter the request

Year
The previous year to filter the request

Returns

JSON XML
A Regattas structure with all regattas in the specified country in the specified year.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/US/previous/2012',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Search Regattas by distance from location

This service will return a list of regattas within the specified distance from a location. The results can be narrowed by including the /today, /upcoming or /previous qualifier.

URL: https://api.regattacentral.com/v3.0/regattas/nearby/{Latitude}/{Longitude}/{Distance}/{Units}

URL: https://api.regattacentral.com/v3.0/regattas/nearby/{Latitude}/{Longitude}/{Distance}/{Units}/today

URL: https://api.regattacentral.com/v3.0/regattas/nearby/{Latitude}/{Longitude}/{Distance}/{Units}/upcoming

URL: https://api.regattacentral.com/v3.0/regattas/nearby/{Latitude}/{Longitude}/{Distance}/{Units}/previous

Parameters

Latitude
The latitude of the location

Longitude
The longitude of the location

Distance
The distance, in miles, to search

Units
The distance units. Valid strings are km, kilometers, m, meter and miles

Returns

JSON XML
A Regattas structure of all of the regattas within the specified distance of the location. A maximum of 100 regattas will be returned in the order of the closest regatta first.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regattas/nearby/43.1594/-79.2427/250/miles/previous',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Regatta Details

This service will return basic information about the specified regatta.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

Returns

JSON XML
A Regattas structure with a Regatta structure containing the regatta information.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/job',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Regatta Races in Progress

This service will return a list of events and races for races that are "In Progress".

It is important to note that the regatta must be using a timing system that reports results to RegattaCentral *and* that the timing system notifies RegattaCentral of races that have started.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/inProgress

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

Returns

JSON XML
A list of events for the regatta. Each Event will have one or more races with a status of "In Progress".

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/inProgress',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Regatta Offline Results

If the regatta does not report individual results to RegattaCentral, they may provide one or more URLs to their results. This endpoint returns those URLs to the caller.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/offlineResults

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

Returns

JSON XML
A Regattas structure with a separate Regatta structure for each country. The venue structure contains the country information.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/2924/offlineResults',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Regatta Events

This service will return a list of events for the specified regatta.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/events

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

Returns

JSON XML
A list of events which have been configured for this regatta.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/events',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Event's Entries

This service will return basic information with RegattaCentral

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/entries

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

EventId
The RegattaCentral ID of the specific event for which the data is being requested.

Returns

JSON XML
A List of Entry structures containing the information about each entry.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/event/11/entries',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Event Entry's Lineup

This service will return the lineup for the specified entry

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/entry/{EntryId}/lineup

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

EventId
The RegattaCentral ID of the specific event for which the data is being requested.

EntryId
The RegattaCentral ID of the specific entry for which the data is being requested.

Returns

JSON XML
A list of the participants in the specified entry.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/event/11/entry/1642/lineup',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Event Organizations

This service will return a list of organizations participating in the specified event.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/clubs

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

EventId
The RegattaCentral ID of the specific event for which the data is being requested.

Returns

JSON XML
A list of Organizations participating in the specified event.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/event/11/clubs',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Event Draw

This service will return the lane draw (bow numbers) for the specified event.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/draw

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

EventId
The RegattaCentral ID of the specific event for which the data is being requested.

Returns

JSON XML
A list of Lane structures defining the lane draw/bow numbers for the event.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/event/11/draw',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Event's Races

This service will return a list of races that are associated with an event.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/races

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

EventId
The RegattaCentral ID of the specific event for which the data is being requested.

Returns

JSON XML
A list of Races structures for all racesw associated with the specified event.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/event/11/races',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Event's Results

This service will return all of the results associated with the specific event.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/results

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

EventId
The RegattaCentral ID of the specific event for which the data is being requested.

Returns

JSON XML
A complete structure of Races, Lanes, and Results for a specified event.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/event/11/results',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Regatta Organizations

This service will return all of the organizations participating in the regatta.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/clubs

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

Returns

JSON XML
A list of Organizations that are participating in the regatta.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/clubs',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Organization's Events

This service will return a list of events in which the specified organization is participating.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/club/{ClubId}/events

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

ClubId
The RegattaCentral ID of the specific organization for which the data is being requested.

Returns

JSON XML
A list of Events in which the specified organization is participating in.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/club/3061/events',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Organization's Draw

This service will return the lane draw (bow numbers) for the specified organization.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/club/{ClubId}/draw

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

ClubId
The RegattaCentral ID of the specific organization for which the data is being requested.

Returns

JSON XML
A list of Lanes which have been assigned to the entries of the specified organization.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/club/3061/draw',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Organization's Races

This service will return a list of races in which this organization is participating.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/club/{ClubId}/races

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

ClubId
The RegattaCentral ID of the specific organization for which the data is being requested.

Returns

JSON XML
A list of Races in which the specified organization is participating in.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/club/3061/races',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Organization's Results

This service will return all of the result for the specified organization.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/club/{ClubId}/results

Parameters

RegattaId
The RegattaCentral ID of the specific regatta for which the data is being requested.

ClubId
The RegattaCentral ID of the specific organization for which the data is being requested.

Returns

JSON XML
A list of Results for the specified organization.

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v3.0/regatta/3644/club/3061/results',
    headers: {"Accept": "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Results: JSON

Upload an Event

This service allows the user to update or create an event

The status of an event is dynamic and is affected by other actions. In particular, deadlines which have been defined for the regatta may change the status of an event. However, if you create or change the event after a deadline then you may enable teams to add more entries to the event. Thus it is very important that you set the correct event status when you create or change an event. The status is optional and may be left off of the API upload call and it will be left in its previous state.

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/updateEvents

Secure This is a secure API and requires OAuth2 authentication.

Parameters

RegattaId
The RegattaCentral ID of the regatta that you are uploading data to

EventId
The event ID of the event that you are uploading data to. It may be zero if you are creating a new event

Data

JSON XML
A structure of type Events. May contain more than one event.

Returns

JSON XML
An Events structure, including updated data - specifically the event_id

Code: JavaScript + jQuery

$.ajax({
    type: "POST",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/updateEvents',
    data : json-data,
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json",
              "Content-Type" : "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data: JSON   XML

Results: JSON

Upload or Create a Race

This service allows the user to update or create a race

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/event/{EventId}/race/{RaceId}

Secure This is a secure API and requires OAuth2 authentication.

Parameters

RegattaId
The RegattaCentral ID of the regatta that you are uploading data to

EventId
The Event ID of the event that this race is a part of

RaceId
The Race ID of the race that you are uploading data to. This may be 0 if you are creating a new race

Data

JSON XML
A structure of type Events. May contain more than one event.

Returns

JSON XML
An Events structure, including updated data - specifically the event_id

Code: JavaScript + jQuery

$.ajax({
    type: "POST",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/event/1/race/123',
    data : json-data,
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json",
              "Content-Type" : "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data: JSON   XML

Results: JSON

Upload an Entry

This service allows the user to update or create an entry

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/upload

Secure This is a secure API and requires OAuth2 authentication.

Parameters

RegattaId
The RegattaCentral ID of the regatta that you are uploading data to

Data

JSON XML
A structure of type Regattas. May contain more than one regatta.

Returns

JSON XML
A UploadStatus structure, including an array of one or more messages.

Code: JavaScript + jQuery

$.ajax({
    type: "POST",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/upload',
    data : json-data,
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json",
              "Content-Type" : "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data: JSON   XML

Results: JSON

Upload results from a race

This service allows the user to upload result data

URL: https://api.regattacentral.com/v3.0/regatta/{RegattaId}/upload

Secure This is a secure API and requires OAuth2 authentication.

Parameters

RegattaId
The RegattaCentral ID of the regatta that you are uploading data to

Data

JSON XML
A structure of type Regattas, including the Events, Races, Lanes, and Results to be reported

Returns

JSON XML
A UploadStatus structure, including an array of one or more messages.

Code: JavaScript + jQuery

$.ajax({
    type: "POST",
    url: 'https://api.regattacentral.com/v3.0/regatta/3939/upload',
    data : json-data,
    headers: {"Authorization": "hex-authorization-code-goes-here",
              "Accept": "application/json",
              "Content-Type" : "application/json"},
    success: function (data) {
        // Process and Display Data
    },
    error: function () {
        alert('Error processing request.');
    }
});

Data: JSON   XML

Results: JSON

RegattaCentral © 2024 | Support | Privacy