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

Awards

A person can be assigned an award inside an organization, team, club, season, competition or match. The routes allow awards to be returned that are linked to matches, seasons or not.

Get a list of non-match awards

get
/ice3/o/{organizationId}/awards

Return a list of awards not linked to matches

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
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
awardstring · enum · max: 100Optional

Award

  • 6th_MAN Sixth Man
  • ALL_TEAM All first team
  • COACH Coach Award
  • DEFENSIVE Defensive Player
  • DEFENSIVE_TEAM Defensive team
  • HALL Hall of Fame
  • HONOUR Honoured
  • MIP Most Improved Player
  • MVP Most Valuable Player
  • OTHER Other
  • ROOKIE Rookie
Example: MVPPossible values:
dateFromEndstring · dateOptional

Where dateFrom <= this value

Example: 2018-08-16
dateFromStartstring · dateOptional

Where dateFrom >= this value

Example: 2018-08-16
dateToEndstring · dateOptional

Where dateTo <= this value

Example: 2018-08-16
dateToStartstring · dateOptional

Where dateTo >= this value

Example: 2018-08-16
entityIdstring · uuidOptional

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
personIdstring · uuidOptional

The unique identifier of the person

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
updatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
Responses
get
/ice3/o/{organizationId}/awards

Create an award

post
/ice3/o/{organizationId}/awards

Add a new award

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
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
awardIdstring · uuidOptional

The unique identifier of the award

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

The person that this award is for

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

The club that this award is linked to

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

The team that this award is linked to

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

The competition that this award is linked to

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

The season that this award is linked to

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

The match that this award is linked to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
votesinteger · int32 | nullableOptional

Number of votes

Example: 1
dateFromstring · date | nullableOptional

Date the award is from

Example: 1978-08-24
dateTostring · date | nullableOptional

Date the award is until

Example: 1978-08-24
awardstring · enum · max: 100Required

Award

  • 6th_MAN Sixth Man
  • ALL_TEAM All first team
  • COACH Coach Award
  • DEFENSIVE Defensive Player
  • DEFENSIVE_TEAM Defensive team
  • HALL Hall of Fame
  • HONOUR Honoured
  • MIP Most Improved Player
  • MVP Most Valuable Player
  • OTHER Other
  • ROOKIE Rookie
Example: MVPPossible values:
awardSubTypestring | nullableOptional

Award sub type

Example: 1st Team
notesstring | nullableOptional

Award Notes

externalIdstring | nullableOptional

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
Responses
post
/ice3/o/{organizationId}/awards

Get a list of season awards

get
/ice3/o/{organizationId}/awards/in/seasons

Return a list of awards for the organization (linked to seasons)

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
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
awardstring · enum · max: 100Optional

Award

  • 6th_MAN Sixth Man
  • ALL_TEAM All first team
  • COACH Coach Award
  • DEFENSIVE Defensive Player
  • DEFENSIVE_TEAM Defensive team
  • HALL Hall of Fame
  • HONOUR Honoured
  • MIP Most Improved Player
  • MVP Most Valuable Player
  • OTHER Other
  • ROOKIE Rookie
Example: MVPPossible values:
dateFromEndstring · dateOptional

Where dateFrom <= this value

Example: 2018-08-16
dateFromStartstring · dateOptional

Where dateFrom >= this value

Example: 2018-08-16
dateToEndstring · dateOptional

Where dateTo <= this value

Example: 2018-08-16
dateToStartstring · dateOptional

Where dateTo >= this value

Example: 2018-08-16
entityIdstring · uuidOptional

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
personIdstring · uuidOptional

The unique identifier of the person

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

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
updatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
Responses
get
/ice3/o/{organizationId}/awards/in/seasons

Get a list of match awards

get
/ice3/o/{organizationId}/awards/in/fixtures

Return a list of awards for the organization (linked to matches)

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
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
awardstring · enum · max: 100Optional

Award

  • 6th_MAN Sixth Man
  • ALL_TEAM All first team
  • COACH Coach Award
  • DEFENSIVE Defensive Player
  • DEFENSIVE_TEAM Defensive team
  • HALL Hall of Fame
  • HONOUR Honoured
  • MIP Most Improved Player
  • MVP Most Valuable Player
  • OTHER Other
  • ROOKIE Rookie
Example: MVPPossible values:
dateFromEndstring · dateOptional

Where dateFrom <= this value

Example: 2018-08-16
dateFromStartstring · dateOptional

Where dateFrom >= this value

Example: 2018-08-16
dateToEndstring · dateOptional

Where dateTo <= this value

Example: 2018-08-16
dateToStartstring · dateOptional

Where dateTo >= this value

Example: 2018-08-16
entityIdstring · uuidOptional

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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)]
fixtureIdstring · uuidOptional

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
personIdstring · uuidOptional

The unique identifier of the person

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

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
updatedstring · date-timeOptional

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

Example: 2018-08-16T02:11:48
Responses
get
/ice3/o/{organizationId}/awards/in/fixtures

Get an award

get
/ice3/o/{organizationId}/awards/{awardId}

Return detailed information about a specific award

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
awardIdstring · uuidRequired

The unique identifier of the award

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
get
/ice3/o/{organizationId}/awards/{awardId}

Update an award

put
/ice3/o/{organizationId}/awards/{awardId}

Change the information of a specific award

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
awardIdstring · uuidRequired

The unique identifier of the award

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
personIdstring · uuidOptional

The person that this award is for

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

The club that this award is linked to

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

The team that this award is linked to

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

The competition that this award is linked to

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

The season that this award is linked to

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

The match that this award is linked to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
votesinteger · int32 | nullableOptional

Number of votes

Example: 1
dateFromstring · date | nullableOptional

Date the award is from

Example: 1978-08-24
dateTostring · date | nullableOptional

Date the award is until

Example: 1978-08-24
awardstring · enum · max: 100Optional

Award

  • 6th_MAN Sixth Man
  • ALL_TEAM All first team
  • COACH Coach Award
  • DEFENSIVE Defensive Player
  • DEFENSIVE_TEAM Defensive team
  • HALL Hall of Fame
  • HONOUR Honoured
  • MIP Most Improved Player
  • MVP Most Valuable Player
  • OTHER Other
  • ROOKIE Rookie
Example: MVPPossible values:
awardSubTypestring | nullableOptional

Award sub type

Example: 1st Team
notesstring | nullableOptional

Award Notes

externalIdstring | nullableOptional

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
Responses
put
/ice3/o/{organizationId}/awards/{awardId}

Delete an award

delete
/ice3/o/{organizationId}/awards/{awardId}

Delete a specific award

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
awardIdstring · uuidRequired

The unique identifier of the award

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
delete
/ice3/o/{organizationId}/awards/{awardId}
PreviousTransfersNextMatch PLAY BY PLAY

Last updated

Was this helpful?