Regatta Details

This service will return basic information about the specified regatta.

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

Returns

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

Code: JavaScript + jQuery

$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3644',
    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

Regatta Details with Events and Entries

This service will return all information about the specified regatta

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/bulk

Security This endpoint requires a valid Oauth2 token for authentication and staff access to the regatta.

GET This is a GET request.

Parameters

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

Returns

JSON XML
A Regattas structure, including the requested regatta.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/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

Active Regatta Races (aka in Progress)

This service will return a list of events and races for races that have a status of "Racing", "Active" or "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/v4.0​/regattas/{RegattaId}/races?active

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

Returns

JSON
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/v4.0​/regattas/3644/races?active',
    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

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/v4.0​/regattas/{RegattaId}/offlineResults

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

Returns

JSON
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/v4.0​/regattas/2924/offlineResults',
    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

Regatta Events

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/events

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

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/v4.0​/regattas/3939/events',
    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

Event's Entries

This service will return basic information with RegattaCentral

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/events/{EventId}/entries

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

EventId
The RegattaCentral ID of the event in which the entries are being created..

Returns

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

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3939/events/15/entries',
    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

Entry's Details

This service will return the lineup and other details for the specified entry

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/entries/{EntryId}

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

EventId
The RegattaCentral ID of the event in which the entries are being created..

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

Returns

JSON XML
The details of the specified entry.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3939/entries/85',
    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

Event's Lane Draw

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/events/{EventId}/lanes

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

EventId
The RegattaCentral ID of the event in which the entries are being created..

Returns

JSON
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/v4.0​/regattas/3939/events/15/lanes',
    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

Event's Races

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/events/{EventId}/races

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

EventId
The RegattaCentral ID of the event in which the entries are being created..

Returns

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

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3939/events/15/races',
    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

Event's Results

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/events/{EventId}/results

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

EventId
The RegattaCentral ID of the event in which the entries are being created..

Returns

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

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3939/events/15/results',
    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

Participating Organizations

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/organizations

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

Returns

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

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3939/organizations',
    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's Events

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/organizations/{ClubId}/events

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

ClubId
The RegattaCentral ID of the club whos' guaranteed entry is being updated.

Returns

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

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3644/organizations/3061/events',
    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's Draw

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/organizations/{ClubId}/lanes

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

ClubId
The RegattaCentral ID of the club whos' guaranteed entry is being updated.

Returns

JSON
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/v4.0​/regattas/3644/organizations/3061/lanes',
    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's Races

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/organizations/{ClubId}/races

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

ClubId
The RegattaCentral ID of the club whos' guaranteed entry is being updated.

Returns

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

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3644/organizations/3061/races',
    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's Results

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

URL: https://api.regattacentral.com/v4.0​/regattas/{RegattaId}/organizations/{ClubId}/results

Security This endpoint requires an API-Key or valid OAuth2 token for authentication.

GET This is a GET request.

Parameters

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

ClubId
The RegattaCentral ID of the club whos' guaranteed entry is being updated.

Returns

JSON
A list of Results for the specified organization.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/regattas/3644/organizations/3061/results',
    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

All Guaranteed Entries for the Regatta

This service will return all of the Guaranteed Entries for the Regatta

URL: https://api.regattacentral.com/v4.0​/guaranteedEntries/{RegattaId}

Security This endpoint requires a valid Oauth2 token for authentication and staff access to the regatta.

GET This is a GET request.

Parameters

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

Returns

JSON
A list of the guaranteed entries for the entire regatta.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/guaranteedEntries/3939',
    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

Entry Guaranteed Entry Codes

This service will return all of the Entry based Guaranteed Entry Codes.

URL: https://api.regattacentral.com/v4.0​/guaranteedEntries/{RegattaId}/entries

Security This endpoint requires a valid Oauth2 token for authentication and staff access to the regatta.

GET This is a GET request.

Parameters

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

Returns

JSON
A list of Entry based Guaranteed Entry Codes.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/guaranteedEntries/3939/entries',
    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

Organizational Guaranteed Entries

This service will return all of the organizational Guaranteed Entry Codes.

URL: https://api.regattacentral.com/v4.0​/guaranteedEntries/{RegattaId}/organizations/

Security This endpoint requires a valid Oauth2 token for authentication and staff access to the regatta.

GET This is a GET request.

Parameters

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

Returns

JSON
A list of all organization Guaranteed Entry Codes.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/guaranteedEntries/3939/organizations',
    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's Guaranteed Entries

This service will return all of the Guaranteed Entries for the specified organization.

URL: https://api.regattacentral.com/v4.0​/guaranteedEntries/{RegattaId}/organizations/{ClubId}/

Security This endpoint requires a valid Oauth2 token for authentication and staff access to the regatta.

GET This is a GET request.

Parameters

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

ClubId
The RegattaCentral ID of the club whos' guaranteed entry is being updated.

Returns

JSON
A list of Guaranteed Entries for the specified organization.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/guaranteedEntries/3939/organizations/2810',
    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

Guaranteed Entry Code

This service will return information about the specific Guaranteed Entry Code.

URL: https://api.regattacentral.com/v4.0​/guaranteedEntries/{RegattaId}/entryCodes/{GEC}

Security This endpoint requires a valid Oauth2 token for authentication and staff access to the regatta.

GET This is a GET request.

Parameters

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

Code
The existing Guaranteed Entry Code which will be updated.

Returns

JSON
A list of Results for the specified organization.

Code: JavaScript + jQuery

										$.ajax({
    type: "GET",
    url: 'https://api.regattacentral.com/v4.0​/guaranteedEntries/3939/entryCodes/345-ABC',
    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

RegattaCentral © 2018 | Support | Privacy