Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note
titleDRAFT DOCUMENTATION

Please note that this documentation is in draft and is not finalised.

We would encourage you provide any comments, questions, or suggestions for changes by use in-line commenting on this page. To do so simply highlight a section of text and then click on the "Comment" option that appears.


Info
The Match MatchUp is a key part of the Tennis Open Data Standards - allowing users to record the details of the match MatchUp format, the progression of the match MatchUp and the result.

1. What is a

...

MatchUp?

A Match MatchUp entity hold the details of a tennis match MatchUp between two players or pairs. It can provide details about how the match MatchUp will be played, when the match MatchUp will be played, who will play the match MatchUp as well as information about what happens during a match MatchUp and the final result.

2.

...

MatchUp Schema

To see a graphical representation of the data model (schema) for the Match MatchUp entity please expand the link below:

Expand
titleView Match Schema Diagram

Image RemovedImage Added

3. Creating a Match

The mandatory information required to create a Match entity MatchUpentity is a MatchIdMatchUpId. However we strongly recommend that MatchType MatchUpType and MatchStatus MatchUpStatus are also included. If available MatchFormat MatchUpFormat should also be included.

You can create a Match MatchUp as soon as the Draw (or Tie) that it is part of has been created. It is perfectly normal to create the Match MatchUp entities before the players are known. Or for Matches MatchUps to have only one side listed - for example when only one semi-final has been played so only one of the finalists is known.

Code Block
languagexml
themeConfluence
titleXML
linenumberstrue
collapsetrue
<Match><MatchUp>
  <MatchId>70290C29<MatchUpId>70290C29-A867-4756-8B25-54B32BF011CF</MatchId>MatchUpId>
  <MatchType>SINGLES<<MatchUpType>SINGLES</MatchType>MatchUpType>
  <Sides>
    <Side>
      <Number>1</Number>
      <Players>
        <Player>
          <Number>1</Number>
          <Participant>
            <ParticipantID>RND1234567</ParticipantID>
          </Participant>
        </Player>
      </Players>
    </Side>
  </Sides>
</Match>

...

Code Block
themeConfluence
titleJson
linenumberstrue
collapsetrue
{
	"MatchMatchUp": {
		"MatchIdMatchUpId": "70290C29-A867-4756-8B25-54B32BF011CF",
		"MatchTypeMatchUpType": "SINGLES",
		"Sides": {
			"Side": [
				{
				"Number": "1",
				"Players": {
					"Player": [
					    {
						"Number": "1",
						"Participant": {
							"ParticipantID": "RND1234567"
						}
					}
					]
				}
			}
			]
		}
	}
}

4.

...

MatchUpId

In MatchId MatchUpId you must supply your unique identifier for the MatchMatchUp. The value must be unique within the tournament. You can use any value but a unique identifier can easily be created by concatenating the DrawId with information about the draw.

Info
When you’re exchanging information with a client or supplier it is possible that you both have an ID for the MatchMatchUp. To make exchange easier TODS allows for any number of additional IDs to be included with MatchMatchUp. See ‘How to include multiple identifiers’ for more information.

5.

...

MatchUpFormat

The MatchFormat MatchUpFormat is defined by a string that can be decoded my humans and computers to understand how to interpret the result. The coding scheme has been designed to allow for an almost unlimited number of different formats. Some of the more common formats are listed in the MatchFormat MatchUp Format and Score Quick Reference. If none of the available codes are suitable for your Match MatchUp then you can create the correct code using the information available in Creating a valid MatchFormat code.

6. Adding Sides

As each side in the match MatchUp becomes known it can be added to the MatchMatchUp. A side can be a player or a pair (for doubles).

...

Code Block
themeConfluence
titleJson
collapsetrue
{
	"Sides": {
		"Side": [
			{
				"Number": "1",
				"Score": "4-6;1-6",
				"Participant": {
					"ParticipantID": "RND1234567-RND4567123",
					"Members": {
						"Member": [
							{
								"ParticipantID": "RND1234567"
							},
							{
								"ParticipantID": "RND4567123"
							}
						]
					}
				},
				"Players": {
					"Player": [
						{
							"Number": "1",
							"Participant": {
								"ParticipantID": "RND1234567"
							}
						},
						{
							"Number": "2",
							"Participant": {
								"ParticipantID": "RND4567123"
							}
						}
					]
				}
			},
			{
				"Number": "2",
				"Score": "6-4;6-1",
				"Participant": {
					"ParticipantID": "RND7654321-RND1237654",
					"Members": {
						"Member": [
							{
								"ParticipantID": "RND7654321"
							},
							{
								"ParticipantID": "RND1237654"
							}
						]
					}
				},
				"Players": {
					"Player": [
						{
							"Number": "1",
							"Participant": {
								"ParticipantID": "RND7654321"
							}
						},
						{
							"Number": "2",
							"Participant": {
								"ParticipantID": "RND1237654"
							}
						}
					]
				}
			}
		]
	}
}

7.

...

MatchUp Result

Once the match MatchUp is over the Score value can be provided. This is a string, written from the winner’s perspective, that follows the MatchFormat MatchUpFormat. The Score is designed to be human readable but also machine readable so clients of TODS messages can use the information to make calculations and do analysis.

MatchFormat MatchUp Format and Score Quick Reference shows how the write scores for different MatchFormat MatchUpFormat.

Users can choose to provide more detailed breakdown of the progression of the Match MatchUp using Set elements but it is not mandatory to do so. If Sets are used Score must still be provided.

...

Info
TODS defines a set of standard attributes that are widely used within tennis. If you need to supply some extra information that doesn’t fit one of the standard attributes you can use an extension.
See ‘Extensions’ for more information.


Related Information


Go back to Tennis Open Data Standards home page.

...