Search code, repositories, users, issues, pull requests...

application/vnd.worlddancesport.competition

This media type contains a single competition.

Name	Type	Description	Writable	Createable
id	integer	The competition Id	no	no
discipline	string	The discipline	no	no
age	string	The age group	no	no
coefficient	decimal	The competition coefficient	no	no
date	date	The date of the competition	no	no
division	string	The division ([list of divisions](http://services.worlddancesport.org/files/schema/1.0/wds-commonTypes.xsd))	no	no
country	string	the country name of where the competition is located at ([list of countries](http://services.worlddancesport.org/files/schema/1.0/wds-commonTypes.xsd))	no	no
location	string	The place the competition is located at (city name)	no	no
type	string	The type of competition	no	no
lastmodifiedDate	dateTime	The last time this competition was updated	no	no
status	string	The status of the competition. Valid statuses are: PreRegistration = The competition is not open for registrations yet Registering = The competition is accepting registrations RegistrationClosed = The competition has finished registration InProgress = The competition is in progress Processing = The competition results are available but not confirmed Closed = The competition is finished and the results are confirmed Canceled = The competition was cancelled Once the status changes to "RegistrationClosed" or higher, the competition coefficient is calculated. Once the status changes to "Closed" the WRL points are calculated.	yes	no

Links

XML write example

application/vnd.worlddancesport.participants

This media type contains a list of participants.

Name	Type	Description	Writable	Creatable
id	int	The Id of the participant	no	no
name	string	The name of the couple/team/single	no	no
country	string	The country of the couple/team/single	no	no
number	int	The start number of the couple/team/single	no	no

Links

application/vnd.worlddancesport.participant.[couple|team|single]

This media type contains a single participant.

An overview of the participant model can also be seen in this PDF document.

Name	Type	Description	Writable	Creatable
id	int	The id of the participant	no	no
number	int	The start number of the participant	yes	yes
status	string	The status of the participant Valid statuses are: Registered (the participant is registered but is not confirmed yet) Present (the participant has arrived at the venue and is taking part in the competition) Noshow (the participant has not arrived at the venue and has not* informed* anybody about this) Excused (the participant has not arrived at the venue and has informed the organizer about this) Disqualified (the participant has broken a rule and was disqualified from the competition) Withdrawn (the participant voluntarily withdraw frpom the compeititon due to injury, etc.)	yes	yes
basepoints	int	The base points for the WRL acquired at this competitions.	no	no
rank	int	The rank of the participant. Should multiple participants share the same rank provide the best common rank. So for ranks 15-19 provide 15. Setting this to 0 will clear the rank. Leaving it empty will not update the rank.	yes	yes
name	string	The name of the participant	no	no
country	string	The country of the participant	no	no
competitionId	int	The competition id of the participant (not readable)	no	yes
coupleId	string	The couple Id for this participant (not readable) Only for application/vnd.worlddancesport.participant.couple	no	yes
teamId	string	The team id for this participant (not readable) Only for application/vnd.worlddancesport.participant.team	no	yes
personId	string	The person id (MIN) for this participant (not readable) Only for application/vnd.worlddancesport.participant.single	no	yes
rounds	list of round	the results for this participant	yes	yes

The results of a participant are represented by nested lists of round, dance and score types. To update a participant's results always include all results of all rounds and all dances.

The "round" type has the following properties:

Name	Type	Description	Writable	Creatable
name	string	The name of the round. In Standard/Latin valid values are : 1,R,2,3,4,5,6,7,8,9 and F For Breaking, please see Trivium, Threefold, WDSF Breaking and BreakingSeed types	yes	yes
maxDeviation	decimal	Sets the maximum deviation adjudicators are allowed from the median of the other's scores.	yes	yes
recalls	integer	Indicates how many participants are recalled for the next round. Only applies to OnScaleSkating scores.	yes	yes
dances	list of dance	The dances of this round	yes	yes

The "dance" type has the following properties:

Name	Type	Description	Writable	Creatable
name	string	The name of this dance. Valid names are listed in the [XML schema](https://services.worlddancesport.org/files/schema/1.0/wds-commonTypes.xsd)	yes	yes
isGroupDance	bool	True if this dance was a group dance, false if it was a solo dance. This attribute only applies when OnScale3/OnScaleSkating scores are used and is false/ignored with any other scoring method.	yes	yes
scores	list of scores	The scores of this dance	yes	yes

The score type depends on the judging system used for this round. See below all suported types:

Marks score

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this mark .	yes	yes
set	bool (default=false)	A mark is set (true) in any case the couple was not required to dance a round. Round 1 or 2 (the star rule) Redance	yes	yes

To understand the concept of IsSet please see the XML examples below.

If a couple "is set" for a round it is necessary that the couples receives a mark from every adjudicator for every dance in that round.

Final score

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this rank.	yes	yes
rank	int	the rank for this dance	yes	yes

On-Scale score

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score. In case of a reduction it is the official id of the chairman.	yes	yes
pb	decimal	The score for Posture, Balance and Coordination	yes	yes
qm	decimal	The score for Quality of Movement	yes	yes
mm	decimal	The score for Movement to music	yes	yes
ps	decimal	The score for Partnering	yes	yes
cp	decimal	The score for Choreography and Presentation	yes	yes
reduction	decimal	The reduction imposed by the chairman	yes	yes

On-Scale IDO score

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score. In case of a reduction it is the official id of the chairman.	yes	yes
t	decimal	The score for Technique	yes	yes
c	decimal	The score for Composition	yes	yes
i	decimal	The score for Image	yes	yes
s	decimal	The score for Show (only in show dance)	yes	yes
reduction	decimal	The reduction imposed by the chairman	yes	yes

On-Scale score (Version 2.0/2.1/3.0/Skating)

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score. In case of a reduction it is the official id of the chairman.	yes	yes
tq	decimal	The score for Technical Quality or the combined score for Technical Quality and Partnering Skill in group dances	yes	yes
mm	decimal	The score for Movement to music or the combined score for Movement to music and Choreography and Presentation in group dances	yes	yes
ps	decimal	The score for Partnering	yes	yes
cp	decimal	The score for Choreography and Presentation	yes	yes
reduction	decimal	The reduction imposed by the chairman	yes	yes

On-Scale Disco score

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
t	decimal	The score for Technique	yes	yes
c	decimal	The score for Choreography	yes	yes
p	decimal	The score for Performance	yes	yes

Disco Tie Break score

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
rank	int	The rank	yes	yes

On-Scale Disco 3 score

Same as OnScaleDisco but with AJS calculation

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
t	decimal	The score for Technique	yes	yes
c	decimal	The score for Choreography	yes	yes
p	decimal	The score for Performance	yes	yes

On-Scale MTC score

Score with 3 components usign AJS. Used in Hip-Hop.

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
t	decimal	The score for Technique	yes	yes
c	decimal	The score for Creativity	yes	yes
m	decimal	The score for Musicality	yes	yes

On-Scale TCPS score

Score with 3 or 4 components usign AJS. Used in Stage Dances.

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
t	decimal	The score for Technique	yes	yes
c	decimal	The score for Choreography and Music(Composition)	yes	yes
p	decimal	The score for Performance	yes	yes
s	decimal	The score for Show (set to zero if not ShowDance Stage dance)	yes	yes

Trivium score

The fader values must always be zero or greater. This means that a positive fader value belongs to participant 2 (red) and negative values belog to participant 1 (blue) and must be multiplied by -1.

The "name" property on the "round" element (see above) indicates:

in TopX mode: on what level of the bracket these scores have been given.
in RoundRobin mode: what group this score has been given in.
in Preliminary mode: on what level of the bracket these scores have been given.

Valid round names are either numeric or:

PreQ1, PreQ2, PreQ3, PreQ4: For preliminary rounds
A, B, C, D: For RoundRobin rounds

See this illustration how Round/Branch/SubRound tie together the scores of Round Robin scores.

See this illustration how Round/Branch/SubRound tie together the scores of TopX scores.

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
mode	string	Allowed are Preliminary, RoundRobin, TopX	yes	yes
branch	decimal	In TopX mode: Which branch in the final bracket these scores have been given. In RoundRobin mode: In which place in the group have these scores been given In Preliminary mode: In which battle these scores have been given	yes	yes
subround	int	Which round	yes	yes
isred	boolean	Is this athlete red or blue (true for red)	yes	yes
technique	int	Technique - Fader 1	yes	yes
variety	int	Variety- Fader 2	yes	yes
performativity	int	Performativity- Fader 3	yes	yes
musicality	int	Musicality- Fader 4	yes	yes
creativity	int	Creativity- Fader 5	yes	yes
personality	int	Personality- Fader 6	yes	yes
crash1	int	Slip	yes	yes
crash2	int	Crash	yes	yes
crash3	int	Whipeout	yes	yes
misbehaviour	int	Misbehaviour	yes	yes
repeat	int	Repeat	yes	yes
bite	int	Bite	yes	yes
spontaneity	int	Spontaneity	yes	yes
confidence	int	Confidence	yes	yes
execution	int	Execution	yes	yes
form	int	Form	yes	yes

WDSF Breaking score

Percent values are converted to decimal, where 100% is 100; The "name" property on the "round" element (see above) indicates:

in TopX mode: on what level of the bracket these scores have been given.
in RoundRobin mode: what group this score has been given in.
in Preliminary mode: on what level of the bracket these scores have been given.

Valid round names are either numeric or:

PreQ1, PreQ2, PreQ3, PreQ4: For preliminary rounds
A, B, C, D: For RoundRobin rounds

See this illustration how Round/Branch/SubRound tie together the scores of Round Robin scores.

See this illustration how Round/Branch/SubRound tie together the scores of TopX scores.

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
mode	string	Allowed are Preliminary, RoundRobin, TopX	yes	yes
branch	decimal	In TopX mode: Which branch in the final bracket these scores have been given. In RoundRobin mode: In which place in the group have these scores been given In Preliminary mode: In which battle have these scores been given	yes	yes
subround	int	Which round	yes	yes
isred	boolean	Is this athlete red or blue (true for red)	yes	yes
technique	int	Technique	yes	yes
vocabulary	decimal	Vocabulary	yes	yes
originality	decimal	Originality	yes	yes
execution	decimal	Execution	yes	yes
musicality	decimal	Musicality	yes	yes
misbehaviour	int	Misbehaviour	yes	yes
routine	int	Routine 0 = (no change) 1 = A (+20%) 2 = B (+10%) 3 = C (+5%) 4 = D (-5%) 5 = E (-10%) 6 = F (-20%)	yes	yes

Threefold score

Percent values are converted to integer, where 100% is 100; The "name" property on the "round" element (see above) indicates:

in TopX mode: on what level of the bracket these scores have been given.
in RoundRobin mode: what group this score has been given in.
in Preliminary mode: on what level of the bracket these scores have been given.

Valid round names are either numeric or:

PreQ1, PreQ2, PreQ3, PreQ4: For preliminary rounds
A, B, C, D: For RoundRobin rounds

See this illustration how Round/Branch/SubRound tie together the scores of Round Robin scores.

See this illustration how Round/Branch/SubRound tie together the scores of TopX scores.

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
mode	string	Allowed are Preliminary, RoundRobin, TopX	yes	yes
branch	decimal	In TopX mode: Which branch in the final bracket these scores have been given. In RoundRobin mode: In which place in the group have these scores been given In Preliminary mode: In which battle have these scores been given	yes	yes
subround	int	Which round	yes	yes
isred	boolean	Is this athlete red or blue (true for red)	yes	yes
physical	decimal	Physical	yes	yes
interpretation	decimal	Interpretation (show as Performativity on website)	yes	yes
artistic	decimal	Artistic	yes	yes

BreakingSeed score

Valid round names are either numeric or:

PreSeed

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
rank	int	The rank given by the judge	yes	yes

BreakingSeedByScore score

Valid round names are either numeric or:

PreSeed

Name	Type	Description	Writable	Creatable
adjudicator	int	The competition official id of the adjudicator who has given this score.	yes	yes
rank	decimal	The score given by the judge	yes	yes
isIgnored	boolean	This score is ignored for the calculation	yes	yes

Links

XML read example with results

XML read example without results

XML write example for registration

XML write example for results (star rule for round 1 and 2, normal marks for round 3 to 6, final rankings)

XML write example for results (marks for couple that has completed round 1 only)

XML write example for results (on scale) (star rule for round 1 and redance, normal marks for round 2 to 5, on scale results for final)

application/vnd.worlddancesport.result

With this media type a set of results for existing participants of a competition can be uploaded in one request. This media type can only be written.

If the results have been updated successfully an OK status reponse will be returned. In any other case a Conflict status response will be returned where each line in the message will indicate the status of each participant's result update. This means that a Conflict status message may contain successful and failed updates.

Name	Type	Description	Writable	Createable
id	integer	The participant Id.	yes	no
rank	string	The rank of the participant	yes	no
rounds	list of rounds	The results for this participant (same as in application/vnd.worlddancesport.participant.[couple\|team\|single])	yes	no

Links

JSON example

application/vnd.worlddancesport.couples

This media type contains a list of couples.

Name	Type	Description	Writable	Createable
id	integer	The couple Id. The couple id has a prefix: rls- for RLS registered couples wdsf- for non RLS registered couples	no	no
name	string	The full name of the couple	no	no
country	string	The last country of the couple	no	no

Links

application/vnd.worlddancesport.couples.export

This media type contains a list of all active couples. It is designed to use the couple list in locations without access to the WDSF API.

Name	Type	Description	Writable	Createable
id	integer	The couple Id. The couple id has a prefix rls- for RLS registered couples wdsf- for non RLS registered couples	no	no
displayName	string	The full name of the couple	no	no
manName	string	The name of the man	no	no
manSurname	string	The surname of the man	no	no
manNationality	string	The nationality of the man	no	no
womanName	string	The name of the woman	no	no
womanSurname	string	The surname of the woman	no	no
womanNationality	string	The nationality of the woman	no	no
country	string	The country of the couple	no	no
age	string	The age group of the couple	no	no
division	string	The division of the couple (General/Professional)	no	no
manMin	integer	the MIN of the man	no	no
womanMin	integer	the MIN of the woman	no	no

XML Schema](http://services.worlddancesport.org/files/schema/1.0/wds-couple.xsd)

application/vnd.worlddancesport.couple

This media type contains a couple.

Name	Type	Description	Writable	Createable
id	integer	The couple Id. The couple id has a prefix rls- for RLS registered couples wdsf- for non RLS registered couples	no	no
name	string	The full name of the couple	no	no
country	string	The country of the couple	no	yes
age	string	The age group of the couple	no	yes
division	string	The division of the couple (General/Professional)	no	yes
status	string	The status of the couple	no	yes
nationalReference	string	The national reference	yes)	yes
retireOn	date	The date where the couple retires or has retired	yes)	no
wrlBLockedUntil	date	The date until the couple is blocked from participating in World Ranking competitions due to transfer regulations	no	no
cupOrChampionshipBlockedUntil	date	The date until the couple is blocked from participating in cup or championship competitions due to transfer regulations	no	no
man	integer	the MIN of the man	no	yes
woman	integer	the MIN of the woman	no	yes
customManName	string	the name of the man where the man is not registered at the RLS	no	yes
customWomanName	string	then name of the woman where the woman is not registered at the RLS	no	yes

CustomManName and customWomanName are provided to register couples to non WDSF competitions (example: for national competitions being part of an event that is hosting a WDSF competition). Couples registered with these custom fields instead of MINs will not be able to receive any world ranking list points. Migration from a custom couple to an RLS couple is currently not possible. Separate the name and surname by a comma (,). Titles like Mr., Dr., etc. are allowed.

Links

XML example write

application/vnd.worlddancesport.teams

This media type contains a list of teams.

Name	Type	Description	Writable	Createable
id	integer	The team Id.	no	no
name	string	The full name of the team	no	no
country	string	The country of the team	no	no

Links

XML example read

application/vnd.worlddancesport.team

This media type contains a team.

Name	Type	Description	Writable	Createable
id	integer	The team Id.	no	no
name	string	The full name of the team	yes (NMB only)	yes
country	string	The country of the team	no	yes
status	string	The status of the team	yes (NMB only)	yes
division	string	The division of the team	no	yes (NMB only)
members	teamMembers	The members in this team	yes (NMB only)	yes

Links

XML schema

XML example read

application/vnd.worlddancesport.teamMember

This media type contains a team member.

Name	Type	Description	Writable	Createable
id	integer	The person's MIN.	no	yes
name	string	The full name of the person	no	no
nationality	string	The nationality of the person	no	no
status	string	The status of the person	no	no
expiresOn	date	When the person;s license expires	no	no

Links

XML schema

XML example read

application/vnd.worlddancesport.officials

This media type contains a list of officials.

Name	Type	Description	Writeable	Creatable
id	int	The Id of the official	no	no
name	string	The name and task of the official	no	no
country	string	The country of the official	no	no

Links

application/vnd.worlddancesport.official

This media type contains an official.

Name	Type	Description	Writable	Creatable
id	int	The Id of the official	no	no
name	string	The name and surname of the official	no	no
country	string	The country of the official	no	no
task	string	The task of the official (Adjudicator/Chairman/Scrutiny/Invigilator/HeadJudge/DJ)	no	yes
letter	string	The letter used to identify the adjudicator, it is not required for chairman	no	yes
min	int	The member Id number of the official	no	yes
competitionId	int	The id of the competition this official takes part at	no	yes

Links

XML write example

application/vnd.worlddancesport.persons

This media type contains a list of persons.

Name	Type	Description	Writable	Creatable
id	int	The Id of the person (MIN)	no	no
name	string	The full name of the person	no	no
country	string	The country of the person	no	no
sex	string	The sex of the person	no	no
ageGroup	string	The age group of the person	no	no
activePartner	string	The full name of the current active partner	no	no
activeCoupleId	string	The Id of the couple this person is currently active in	no	no
activeCoupleAgeGroup	string	The age group of the couple this person is currently active in	no	no

Links

application/vnd.worlddancesport.persons.export

This media type contains a list of all active persons. It is designed to use the persons list in locations without access to the WDSF API.

Name	Type	Description	Writable	Createable
min	integer	The MIN of the person	no	no
name	string	The name of the person	no	no
surname	string	The surname of the person	no	no
nicknam	string	The nickname of the person (if available)	no	no
country	string	The country of the person	no	no
age	string	The age group of the person	no	no
sex	integer	the sex of the person	no	no

application/vnd.worlddancesport.person

This media type contains a list of persons.

Name	Type	Description	Writable	Creatable
id	int	The Id of the person (MIN)	no	no
name	string	The name of the person	no	no
surname	string	The surname of the person	no	no
title	string	The title of the person	no	no
sex	string	The sex of the person (Male,Female or empty)	no	no
country	string	The country this person is competing for	no	no
nationality	string	The nationality of this person	no	no
ageGroup	string	The age group this person is part of	no	no
nationalReference	string	The national reference	yes	no
licenses	license	The licenses of this person.	no	no

Links

License

Name	Type	Description	Writable	Creatable
type	string	The type of license	no	no
status	string	The status of the license	no	no
division	string	The division of the license	no	no
expiresOn	date	The date this license expires or has expired	no	no
wrlBLockedUntil	date	The date until the person is blocked from participating in World Ranking competitions due to transfer regulations	no	no
cupOrChampionshipBlockedUntil	date	The date until the person is blocked from participating in Cup or Championship competitions due to transfer regulations	no	no

application/vnd.worlddancesport.ranking

This media type contains the world ranking list.

Name	Type	Description	Writable	Creatable
name	string	The full name of the couple	no	no
country	string	The country of the couple	no	no
rank	int	The rank	no	no
points	int	points	no	no
manMin	int	MIN of man	no	no
womanMin	int	MIN of man	no	no
coupleId	string	RLS-Id of couple	no	no

Links

application/vnd.worlddancesport.ranking.teams

This media type contains the world ranking list.

Name	Type	Description	Writable	Creatable
name	string	The full name of the team	no	no
country	string	The country of the team	no	no
rank	int	The rank	no	no
points	int	points	no	no
id	int	ID of the team	no	no

application/vnd.worlddancesport.ranking.singles

This media type contains the world ranking list for singles.

Name	Type	Description	Writable	Creatable
name	string	The full name of the person	no	no
country	string	The country of the team	no	no
rank	int	The rank	no	no
points	int	points	no	no
id	int	MIN of the person	no	no

application/vnd.worlddancesport.schedule

Competition schedule (v2 only)

Name	Type	Description	Writable	Createable
id	guid	The id	no	no
groupId	int	The id of the competition group this schedule belongs to	no	yes
competitionid (optional)	int	the id of the competition	no	yes
time	datetime	the full date and time of the schedule entry	yes	yes
expectedMinutes	int	duration of this scheduel entry	yes	yes
text	string (255)	description of the entry	yes	yes
round (optional)	string (100)	rounds danced during this entry	yes	yes
dances (optional)	string (100)	dances danced during this entry	yes	yes
heats (optional)	int	description of the entry	yes	yes
participants (optional)	string (100)	startnumbers of participants dancing during this entry	yes	yes
participantIds (optional)	int array	participant Ids dancing during this entry	yes	yes

application/vnd.worlddancesport.status

This media type contains information about an executed REST request.

Name	Type	Description	Writable	Createable
code	int	The HTTP status code	no	no
message	string	Detail about the success of failure	no	no
id	int or string	the id of a newly created resource	no	no
messageid (v2 only)	int	the id of the message (can be used for l12n)	no	no
error (v2 only)	string	additional error message	no	no

Links