Report-Specific API Parameters

The report data fetched by using COMET DATA API queries can be additionally filtered after the API KEY is generated, on each endpoint call.

This is done by appending key-value pairs as URL params, the key being the Column Key (which you can find in the JSON response, you can find an example below).

For example, let’s say that the following endpoint returns all player registrations:

https://comet.faw.cymru/data-backend/api/public/areports/run/0/25/?API_KEY=XXXX

then the following endpoint will return only the player registrations of Person with COMET ID=12345

https://comet.faw.cymru/data-backend/api/public/areports/run/0/25/?API_KEY=XXXX&personID=12345

and the following endpoint will return only the confirmed player registrations of Person with COMET ID=12345

https://comet.faw.cymru/data-backend/api/public/areports/run/0/25/?API_KEY=XXXX&personID=12345&registrationStatus=*confirmed

Special Cases with Examples

Date and timestamp fields cannot be searched by the value returned by json object. They can be searched only if date value is sent as ‘yyyy-MM-dd’ and if timestamp value is sent as ‘yyyy-MM-dd HH:mm:ss.SSS’.

All fields with labels cannot be searched by the value returned by json object. They can only be searched by the label key.

Filtering with parameters is case sensitive.

Country

You can filter by country (e.g. country of birth or nationality) by entering value=Name of the Country

countryOfBirth=Ukraine

Fields translated with labels

All fields translated with labels (such as gender, registration type, status, etc) can be searched by label key

gender=label.gender.F

gender=label.gender.M

registrationCategory=label.referee

registrationCategory=label.refereeObserver

registrationType=label.president

registrationStatus=label.confirmed

Date

Date can be searched in format ‘yyyy-MM-dd'

dateOfBirth=1972-04-01

Timestamp

Timestamp can be searched in format ‘yyyy-MM-dd HH:mm:ss.SSS’

inStatusSince=2017-07-07%2017:04:54.69