📢 The Ask AI can now translate any part of the docs to your preferred language!
Read the guide
sportradar.comSportradar Support Portal

Match Teams

A match involves a number of teams. The teams assigned to a match are controlled by these calls.

Get a list of teams in the match

get
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities

Return a list of teams for a match

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
200

Successful operation

application/json
get
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities

Add or Update a team in a match

post
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities

Depending on primary keys, Add a team or update an existing entitiy in a match

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
entityIdstring · uuidOptional

The unique identifier of the team

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
conferenceIdstring · uuid | nullableOptional

The unique identifier of the conference

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
divisionIdstring · uuid | nullableOptional

The unique identifier of the division

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
includeInConferenceStatisticsbooleanOptional

Include the statistics for this competitors in the conference statistics?

Example: true
isHomebooleanOptional

Is competitor the home team ?

Example: true
drawbooleanOptional

Result for this competitor was a draw ?

Example: true
resultStatusstring · enum · max: 100Required

Result status

  • CONFIRMED Confirmed
  • DID_NOT_FINISH Did Not Finish
  • DID_NOT_START Did Not Start
  • DISQUALIFIED Disqualified
  • FORFEITED Forfeited
  • IN_PROGRESS In Progress
  • SCHEDULED Scheduled
  • WITHDRAWN Withdrawn
  • WON_BY_FORFEIT Won By Forfeit
Example: CONFIRMEDPossible values:
resultPlaceinteger · int32 | nullableOptional

Result placing (1=Won, 2=Lost)

Example: 1
resultSecondaryScorePlaceinteger · int32 | nullableOptional

Result placing (1=Won, 2=Lost) of the Shoot Out

Example: 1
startingNumberinteger · int32 | nullableOptional

Starting number

Example: 1
scorestring | nullableOptional

Score for competitor in match

Example: 98
secondaryScorestring | nullableOptional

Secondary score (used for shoot-outs)

Example: 3v3
shootOutAttemptsstring | nullableOptional

Result of shoot-out attempts (1 or 0 per attempt).

Example: 11011
isNeutralVenuebooleanOptional

Competitor is playing at a neutral venue ?

Example: true
includeInRepresentationbooleanOptional

Include this match in represented statistics?

Default: trueExample: true
rosterStatusstring · enum · max: 100Optional

The status of the TEAM match teams

  • APPROVED Approved
  • PENDING Pending
  • REJECTED Rejected
  • SUBMITTED Submitted
  • UNKNOWN Unknown
Default: UNKNOWNExample: APPROVEDPossible values:
uniformIdstring · uuid | nullableOptional

The unique identifier of the uniform

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
Responses
200

Successful operation

application/json
post
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities

Get a team in a match

get
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities/{entityId}

Return the detail of a specific team in a match

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
get
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities/{entityId}

Delete a team from a match

delete
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities/{entityId}

Delete a specific team from a match

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/beachvolleyball/o/{organizationId}/fixtures/{fixtureId}/entities/{entityId}
PreviousMatch ProgressionsNextMatch Persons

Last updated

Was this helpful?