API Index

View as XML
View as JSON

Please continue to:

• /api/1/competition for a list of all competitions
  Use query parameter to filter by:
  • from [DateTime] : list competitions since and including this date (YYYY/MM/DD)
  • to [DateTime] : list competitions after and including this date (YYYY/MM/DD)
  • modifiedsince [Date] : list competitions that have been modified since this date (YYYY/MM/DDThh:mm:ss)
  • worldranking [bool] : true to list competitions that are included in the world ranking list
  • division [string] : General/Professional
  • status: The status of the competition. Valid values are:PreRegistration, Registering, RegistrationClosed, Processing, Closed, Canceled
  • location: The city name where the competition takes/took place.
• /api/1/person for a list of all active persons (athletes/adjudicators/chairman)
  Use query parameter to filter by:
  • name [string] : list all persons having a name starting with this filter's value. Separate name und surname with a comma(,). The order is not relevant.
  • phonetic [bool/optional/default=false] : when true, the name filter is used phonetical instead of litteral.
  • min [int] : list person with this MIN (1xxxxxxx can be omitted)
  • nameOrMin [string] : list persons having a name or MIN starting with this filter's value
  • ageGroup [string] : list persons of an age group (Adult, Senior I, Senior II, Youth, ...)
  • division [string] : General/Professional
  • type [string,string,...] : list persons of a certain type (Athlete, Adjudicator, Chairman)
  • status [string] : list of the person's license status (Active, Retired, Expired, Suspended, Revoked).
• /api/1/couple for a list of all active couples
  Use query parameter to filter by:
  • name [string] : list only couples where any member's name starts with this filter's value
  • phonetic [bool/optional/default=false] : when true, the name filter is used phonetical instead of litteral.
  • min [list of int] :
    min,min,min.. : list all couples where the members have any of the MIN given
    min+min : list all couples where all members have the MIN given (make sure the + is URL encoded!)
  • nameOrMin [string] : list couple having a name or MIN starting with this filter's value
  • ageGroup [string] : list couples of an age group (Adult, Senior I, Senior II, Youth, ...)
  • division [string] : General/Professional
  • status [string] : The couple's status, if not given only active couples will be shown. "Any" will show all.
  • country [string] : The couple's country. Separate each country name by a pipe (|).
• /api/1/team for a list of all active teams
  Use query parameter to filter by:
  • name [string] : list only couples where any member's name starts with this filter's value
  • phonetic [bool/optional/default=false] : when true, the name filter is used phonetical instead of litteral.
• /api/1/ranking for the world ranking list
  Use query paramter to filter by:
  • ageGroup [string] : the age group (Adult, Senior I, Senior II, Youth, ...)
  • discipline [string] : the discipline (Latin, Standard, Ten Dance)
  • division [string] : the division (General, Professional)
  • form [string] : the dance form (not used yet)
  • gender [string] : the gender (Male, Female)
  • date [Date/optional] : The date of the ranking list (YYYY/MM/DD)
  • limit [int/optional] : Provide only the top x entries
• /api/1/country for a list of allowed country names
• /api/1/age for a list of age restrictions
• /api/1/age/checkforcompetition/[min],[min]/[competitionid],[competitionid],.. age group check.
  Check if a couple defined by their MIN is allowed to take part in competitions by their age group. This also works for competitions in years other than the current.

Limits

All requests with a web browser are limited to the first 100 results.

Access

Access to most API services requires basic authentication.