Roles

A person can be assigned a role inside an organization, team or match. This is the job, position or responsibility they hold. The routes allow roles to be returned that are linked to matches or not.

Get a list of non-match roles

get
/hockey/o/{organizationId}/roles

Return a list of roles for the organization (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
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
nameFamilyLatinStartsWithstring · max: 50Optional

Family latin name starts with

nameFamilyLocalStartsWithstring · max: 50Optional

Family local name starts with

nameFullLatinstring · max: 50Optional

The full name of the person in latin characters

nameFullLatinContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLatin=David Johnson nameFullLatinContains=Dav will match nameFullLatinContains=John will match nameFullLatinContains=son will not match

Example: Dav and nameFullLatin='David Johnson'
nameFullLocalstring · max: 50Optional

The full name of the person

nameFullLocalContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLocal=David Johnson nameFullLocalContains=Dav will match nameFullLocalContains=John will match nameFullLocalContains=son will not match

Example: Dav and nameFullLocal='David Johnson'
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
rolestring · enumOptional

Role. Can specify multiple values delimited by comma.

  • ADMINISTRATOR_TOURNAMENT Tournament Administrator
  • APPEAL_JURY Appeal Jury
  • APPEAL_JURY_PRESIDENT Appeal Jury President
  • ASSISTANT_REFEREE_1 Assistant Referee 1
  • ASSISTANT_REFEREE_2 Assistant Referee 2
  • CAPTAIN Captain
  • CAPTAIN_VICE Vice Captain
  • CEO CEO
  • CLUB_IT_OFFICER Club IT Officer
  • CLUB_OFFICIAL Club Official
  • CLUB_OFFICIAL_ASSISTANT Substitute for contact person of club
  • COACH Coach
  • COACH_ASSISTANT Assistant Coach
  • COACH_ASSISTANT_HEAD Assistant Head Coach
  • COACH_ASSOCIATE_HEAD Associate Head Coach
  • COACH_DEVELOPMENT Development Coach
  • COACH_GK Goalkeeper Coach
  • COACH_HEAD Head Coach
  • COACH_HEAD_INTERIM Interim Head Coach
  • COACH_OTHER Other coaching staff
  • COACH_SC Strength and Conditioning Coach
  • COACH_SENIOR Senior Coach
  • COACH_SPECIALIST Specialist Coach
  • COMMISSIONER Commissioner
  • COMMITTEE Committee
  • CREW_CHIEF Crew Chief
  • DELEGATE Delegate
  • DIRECTOR Director
  • DOCTOR Doctor
  • GENERAL General
  • GROUNDSKEEPER Groundskeeper
  • JUDGE Judge
  • JUDGE_SCORING Scoring Judge (SJ)
  • JUDGE_TIMING Timing Judge (TJ)
  • LIAISON_OFFICER Liaison Officer
  • MANAGER Manager
  • MATCH_LIAISON Match Liaison
  • MATCH_MANAGER Match Manager
  • MATCH_OFFICIAL Match Official
  • MATCH_SUPERVISOR Match Supervisor
  • MEDIA_OFFICER Media Officer
  • MEDICAL_OFFICER Medical Officer
  • MEDICAL_OFFICER_CF Medical Officer (Continental Federation)
  • MEDICAL_OFFICER_FIH Medical Officer (FIH)
  • MEDICAL_STAFF Medical Staff
  • NATIONAL_TOURNAMENT_OFFICIAL National Tournament Official
  • OFFICE_STAFF Office Staff
  • OFFICIAL_A Official A
  • OFFICIAL_B Official B
  • OFFICIAL_C Official C
  • OFFICIAL_D Official D
  • OFFICIAL_E Official E
  • OTHER Other
  • PHYSICAL_TRAINER Physical Trainer
  • PHYSIOTHERAPIST Physiotherapist
  • PLAYER_CONTRACT_MANAGER Player Contract Manager
  • PRESIDENT President
  • PRESIDENT_VICE Vice President
  • PSYCHOLOGIST Psychologist
  • REFEREE Referee
  • REFEREE_ASSISTANT Referee Assistant
  • REFEREE_ASSISTANT_RESERVE Reserve Assistant Referee
  • REFEREE_LIAISON Referee Liaison
  • REFEREE_OBSERVER Referee Observer
  • REFEREE_OBSERVER_LIAISON Referee Observer Liaison
  • REFEREE_RESERVE Reserve Referee
  • REPRESENTATIVE_ASSOCIATION Association Representative
  • REPRESENTATIVE_ASSOCIATION_CONTINENTAL Continental Association Representative
  • REPRESENTATIVE_ASSOCIATION_GOVERNING_BODY Governing Body Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERCONTINENTAL Intercontinental Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERNATIONAL International Association Representative
  • REPRESENTATIVE_ASSOCIATION_NATIONAL National Association Representative
  • REPRESENTATIVE_ASSOCIATION_REGIONAL Regional Association Representative
  • REPRESENTATIVE_CONTINENTAL_FEDERATION Continental Federation Representative
  • REPRESENTATIVE_FEDERATION Federation Representative
  • REPRESENTATIVE_GOVERNING_BODY Governing Body Representative
  • REPRESENTATIVE_INTERCONTINENTAL_FEDERATION Intercontinental Federation Representative
  • REPRESENTATIVE_INTERNATIONAL_FEDERATION International Federation Representative
  • REPRESENTATIVE_NATIONAL_FEDERATION National Federation Representative
  • REPRESENTATIVE_REGIONAL_FEDERATION Regional Federation Representative
  • SCOREKEEPER Scorekeeper
  • SCOREKEEPER_ASSISTANT Assistant Scorekeeper
  • SCORER Scorer
  • SCORER_ASSISTANT Assistant Scorer
  • SCOUT_1 Scout 1
  • SCOUT_2 Scout 2
  • SCOUT_3 Scout 3
  • SCOUT_SUPERVISOR Scout Supervisor
  • SECRETARY Secretary
  • SHOT_CLOCK_OPERATOR Shot Clock Operator
  • SPORT_DIRECTOR Sporting Director
  • STAND_IN_MANAGER Stand-In Manager
  • STATISTICIAN Statistician
  • TEAM_COORDINATOR Team Coordinator
  • TEAM_LEADER Team Leader
  • TEAM_MANAGER Team Manager
  • TEAM_MEDIA_OFFICER Team Media Officer
  • TECHNICAL_DELEGATE Technical Delegate
  • TECHNICAL_DELEGATE_ASSISTANT Assistant Technical Delegate
  • TECHNICAL_OFFICER Technical Officer
  • TECHNICAL_OFFICIAL Technical Official (TO)
  • TIMEKEEPER Timekeeper
  • TIMER Timer
  • TRAINER Trainer
  • TRAINER_ASSISTANT Assistant Trainer
  • TRANSLATOR Translator
  • TREASURER Treasurer
  • UMPIRE Umpire
  • UMPIRE_1 Umpire 1
  • UMPIRE_2 Umpire 2
  • UMPIRE_ASSISTANT_MANAGER Assistant Umpire Manager
  • UMPIRE_MANAGER Umpire Manager
  • UMPIRE_NATIONAL National Umpire
  • UMPIRE_NEUTRAL Neutral Umpire
  • UMPIRE_RESERVE Reserve Umpire (RU)
  • UMPIRE_VIDEO Video Umpire (VU)
  • VIDEO_ANALYST Video Analyst
  • VIDEO_TECHNICIAN Video Technician (VT)
  • YOUTH_COORDINATOR Youth Coordinator
Example: COACHPossible values:
seasonIdstring · uuidOptional

The unique identifier of the season

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

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: rolePattern: ^(\-?role|,)*$
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
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
/hockey/o/{organizationId}/roles
GET /v1/hockey/o/{organizationId}/roles HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Create a role

post
/hockey/o/{organizationId}/roles

Add a new role

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

The unique identifier of the role

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

The club that this team belongs to

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

The unique identifier of the team

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

The unique identifier of the season

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

The unique identifier of the match

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

The unique identifier of the person

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
dateFromstring · date | nullableOptional

Date the role started (Not for a role within a match)

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

Date the role ended (Not for a role within a match)

Example: 1978-08-24
bibstring | nullableOptional

The number displayed on the jersey

Example: 34
roleNumberinteger · int32 | nullableOptional

Number within the role. eg: Assistant Coach 2

Example: 1
rolestring · enum · max: 100Required

Role

  • ADMINISTRATOR_TOURNAMENT Tournament Administrator
  • APPEAL_JURY Appeal Jury
  • APPEAL_JURY_PRESIDENT Appeal Jury President
  • COACH Coach
  • COACH_ASSISTANT Assistant Coach
  • COACH_HEAD Head Coach
  • COACH_OTHER Other coaching staff
  • DOCTOR Doctor
  • JUDGE Judge
  • JUDGE_SCORING Scoring Judge (SJ)
  • JUDGE_TIMING Timing Judge (TJ)
  • MANAGER Manager
  • MATCH_MANAGER Match Manager
  • MEDIA_OFFICER Media Officer
  • MEDICAL_OFFICER Medical Officer
  • MEDICAL_OFFICER_CF Medical Officer (Continental Federation)
  • MEDICAL_OFFICER_FIH Medical Officer (FIH)
  • NATIONAL_TOURNAMENT_OFFICIAL National Tournament Official
  • OTHER Other
  • PHYSICAL_TRAINER Physical Trainer
  • PHYSIOTHERAPIST Physiotherapist
  • PSYCHOLOGIST Psychologist
  • REPRESENTATIVE_ASSOCIATION Association Representative
  • REPRESENTATIVE_ASSOCIATION_CONTINENTAL Continental Association Representative
  • REPRESENTATIVE_ASSOCIATION_GOVERNING_BODY Governing Body Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERCONTINENTAL Intercontinental Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERNATIONAL International Association Representative
  • REPRESENTATIVE_ASSOCIATION_NATIONAL National Association Representative
  • REPRESENTATIVE_ASSOCIATION_REGIONAL Regional Association Representative
  • REPRESENTATIVE_CONTINENTAL_FEDERATION Continental Federation Representative
  • REPRESENTATIVE_FEDERATION Federation Representative
  • REPRESENTATIVE_GOVERNING_BODY Governing Body Representative
  • REPRESENTATIVE_INTERCONTINENTAL_FEDERATION Intercontinental Federation Representative
  • REPRESENTATIVE_INTERNATIONAL_FEDERATION International Federation Representative
  • REPRESENTATIVE_NATIONAL_FEDERATION National Federation Representative
  • REPRESENTATIVE_REGIONAL_FEDERATION Regional Federation Representative
  • STAND_IN_MANAGER Stand-In Manager
  • TEAM_LEADER Team Leader
  • TEAM_MANAGER Team Manager
  • TEAM_MEDIA_OFFICER Team Media Officer
  • TECHNICAL_DELEGATE Technical Delegate
  • TECHNICAL_DELEGATE_ASSISTANT Assistant Technical Delegate
  • TECHNICAL_OFFICER Technical Officer
  • TECHNICAL_OFFICIAL Technical Official (TO)
  • TRANSLATOR Translator
  • UMPIRE Umpire
  • UMPIRE_1 Umpire 1
  • UMPIRE_2 Umpire 2
  • UMPIRE_ASSISTANT_MANAGER Assistant Umpire Manager
  • UMPIRE_MANAGER Umpire Manager
  • UMPIRE_NATIONAL National Umpire
  • UMPIRE_NEUTRAL Neutral Umpire
  • UMPIRE_RESERVE Reserve Umpire (RU)
  • UMPIRE_VIDEO Video Umpire (VU)
  • VIDEO_ANALYST Video Analyst
Example: COACHPossible values:
roleSubTypestring | nullableOptional

Role sub type

Example: Offensive Coach
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
/hockey/o/{organizationId}/roles
POST /v1/hockey/o/{organizationId}/roles HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 462

{
  "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "status": "ACTIVE",
  "dateFrom": "1978-08-24",
  "dateTo": "1978-08-24",
  "bib": "34",
  "roleNumber": 1,
  "role": "COACH",
  "roleSubType": "Offensive Coach",
  "externalId": "A123"
}
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Get a list of match roles

get
/hockey/o/{organizationId}/roles/in/fixtures

Return a list of roles 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
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
nameFamilyLatinStartsWithstring · max: 50Optional

Family latin name starts with

nameFamilyLocalStartsWithstring · max: 50Optional

Family local name starts with

nameFullLatinstring · max: 50Optional

The full name of the person in latin characters

nameFullLatinContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLatin=David Johnson nameFullLatinContains=Dav will match nameFullLatinContains=John will match nameFullLatinContains=son will not match

Example: Dav and nameFullLatin='David Johnson'
nameFullLocalstring · max: 50Optional

The full name of the person

nameFullLocalContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLocal=David Johnson nameFullLocalContains=Dav will match nameFullLocalContains=John will match nameFullLocalContains=son will not match

Example: Dav and nameFullLocal='David Johnson'
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
rolestring · enumOptional

Role. Can specify multiple values delimited by comma.

  • ADMINISTRATOR_TOURNAMENT Tournament Administrator
  • APPEAL_JURY Appeal Jury
  • APPEAL_JURY_PRESIDENT Appeal Jury President
  • ASSISTANT_REFEREE_1 Assistant Referee 1
  • ASSISTANT_REFEREE_2 Assistant Referee 2
  • CAPTAIN Captain
  • CAPTAIN_VICE Vice Captain
  • CEO CEO
  • CLUB_IT_OFFICER Club IT Officer
  • CLUB_OFFICIAL Club Official
  • CLUB_OFFICIAL_ASSISTANT Substitute for contact person of club
  • COACH Coach
  • COACH_ASSISTANT Assistant Coach
  • COACH_ASSISTANT_HEAD Assistant Head Coach
  • COACH_ASSOCIATE_HEAD Associate Head Coach
  • COACH_DEVELOPMENT Development Coach
  • COACH_GK Goalkeeper Coach
  • COACH_HEAD Head Coach
  • COACH_HEAD_INTERIM Interim Head Coach
  • COACH_OTHER Other coaching staff
  • COACH_SC Strength and Conditioning Coach
  • COACH_SENIOR Senior Coach
  • COACH_SPECIALIST Specialist Coach
  • COMMISSIONER Commissioner
  • COMMITTEE Committee
  • CREW_CHIEF Crew Chief
  • DELEGATE Delegate
  • DIRECTOR Director
  • DOCTOR Doctor
  • GENERAL General
  • GROUNDSKEEPER Groundskeeper
  • JUDGE Judge
  • JUDGE_SCORING Scoring Judge (SJ)
  • JUDGE_TIMING Timing Judge (TJ)
  • LIAISON_OFFICER Liaison Officer
  • MANAGER Manager
  • MATCH_LIAISON Match Liaison
  • MATCH_MANAGER Match Manager
  • MATCH_OFFICIAL Match Official
  • MATCH_SUPERVISOR Match Supervisor
  • MEDIA_OFFICER Media Officer
  • MEDICAL_OFFICER Medical Officer
  • MEDICAL_OFFICER_CF Medical Officer (Continental Federation)
  • MEDICAL_OFFICER_FIH Medical Officer (FIH)
  • MEDICAL_STAFF Medical Staff
  • NATIONAL_TOURNAMENT_OFFICIAL National Tournament Official
  • OFFICE_STAFF Office Staff
  • OFFICIAL_A Official A
  • OFFICIAL_B Official B
  • OFFICIAL_C Official C
  • OFFICIAL_D Official D
  • OFFICIAL_E Official E
  • OTHER Other
  • PHYSICAL_TRAINER Physical Trainer
  • PHYSIOTHERAPIST Physiotherapist
  • PLAYER_CONTRACT_MANAGER Player Contract Manager
  • PRESIDENT President
  • PRESIDENT_VICE Vice President
  • PSYCHOLOGIST Psychologist
  • REFEREE Referee
  • REFEREE_ASSISTANT Referee Assistant
  • REFEREE_ASSISTANT_RESERVE Reserve Assistant Referee
  • REFEREE_LIAISON Referee Liaison
  • REFEREE_OBSERVER Referee Observer
  • REFEREE_OBSERVER_LIAISON Referee Observer Liaison
  • REFEREE_RESERVE Reserve Referee
  • REPRESENTATIVE_ASSOCIATION Association Representative
  • REPRESENTATIVE_ASSOCIATION_CONTINENTAL Continental Association Representative
  • REPRESENTATIVE_ASSOCIATION_GOVERNING_BODY Governing Body Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERCONTINENTAL Intercontinental Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERNATIONAL International Association Representative
  • REPRESENTATIVE_ASSOCIATION_NATIONAL National Association Representative
  • REPRESENTATIVE_ASSOCIATION_REGIONAL Regional Association Representative
  • REPRESENTATIVE_CONTINENTAL_FEDERATION Continental Federation Representative
  • REPRESENTATIVE_FEDERATION Federation Representative
  • REPRESENTATIVE_GOVERNING_BODY Governing Body Representative
  • REPRESENTATIVE_INTERCONTINENTAL_FEDERATION Intercontinental Federation Representative
  • REPRESENTATIVE_INTERNATIONAL_FEDERATION International Federation Representative
  • REPRESENTATIVE_NATIONAL_FEDERATION National Federation Representative
  • REPRESENTATIVE_REGIONAL_FEDERATION Regional Federation Representative
  • SCOREKEEPER Scorekeeper
  • SCOREKEEPER_ASSISTANT Assistant Scorekeeper
  • SCORER Scorer
  • SCORER_ASSISTANT Assistant Scorer
  • SCOUT_1 Scout 1
  • SCOUT_2 Scout 2
  • SCOUT_3 Scout 3
  • SCOUT_SUPERVISOR Scout Supervisor
  • SECRETARY Secretary
  • SHOT_CLOCK_OPERATOR Shot Clock Operator
  • SPORT_DIRECTOR Sporting Director
  • STAND_IN_MANAGER Stand-In Manager
  • STATISTICIAN Statistician
  • TEAM_COORDINATOR Team Coordinator
  • TEAM_LEADER Team Leader
  • TEAM_MANAGER Team Manager
  • TEAM_MEDIA_OFFICER Team Media Officer
  • TECHNICAL_DELEGATE Technical Delegate
  • TECHNICAL_DELEGATE_ASSISTANT Assistant Technical Delegate
  • TECHNICAL_OFFICER Technical Officer
  • TECHNICAL_OFFICIAL Technical Official (TO)
  • TIMEKEEPER Timekeeper
  • TIMER Timer
  • TRAINER Trainer
  • TRAINER_ASSISTANT Assistant Trainer
  • TRANSLATOR Translator
  • TREASURER Treasurer
  • UMPIRE Umpire
  • UMPIRE_1 Umpire 1
  • UMPIRE_2 Umpire 2
  • UMPIRE_ASSISTANT_MANAGER Assistant Umpire Manager
  • UMPIRE_MANAGER Umpire Manager
  • UMPIRE_NATIONAL National Umpire
  • UMPIRE_NEUTRAL Neutral Umpire
  • UMPIRE_RESERVE Reserve Umpire (RU)
  • UMPIRE_VIDEO Video Umpire (VU)
  • VIDEO_ANALYST Video Analyst
  • VIDEO_TECHNICIAN Video Technician (VT)
  • YOUTH_COORDINATOR Youth Coordinator
Example: COACHPossible values:
seasonIdstring · uuidOptional

The unique identifier of the season

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

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: rolePattern: ^(\-?role|,)*$
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
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
/hockey/o/{organizationId}/roles/in/fixtures
GET /v1/hockey/o/{organizationId}/roles/in/fixtures HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Get a list of roles in a match

get
/hockey/o/{organizationId}/fixtures/{fixtureId}/roles

Return a list of roles 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
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
nameFamilyLatinStartsWithstring · max: 50Optional

Family latin name starts with

nameFamilyLocalStartsWithstring · max: 50Optional

Family local name starts with

nameFullLatinstring · max: 50Optional

The full name of the person in latin characters

nameFullLatinContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLatin=David Johnson nameFullLatinContains=Dav will match nameFullLatinContains=John will match nameFullLatinContains=son will not match

Example: Dav and nameFullLatin='David Johnson'
nameFullLocalstring · max: 50Optional

The full name of the person

nameFullLocalContainsstring · min: 2 · max: 50Optional

Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameFullLocal=David Johnson nameFullLocalContains=Dav will match nameFullLocalContains=John will match nameFullLocalContains=son will not match

Example: Dav and nameFullLocal='David Johnson'
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
rolestring · enumOptional

Role. Can specify multiple values delimited by comma.

  • ADMINISTRATOR_TOURNAMENT Tournament Administrator
  • APPEAL_JURY Appeal Jury
  • APPEAL_JURY_PRESIDENT Appeal Jury President
  • ASSISTANT_REFEREE_1 Assistant Referee 1
  • ASSISTANT_REFEREE_2 Assistant Referee 2
  • CAPTAIN Captain
  • CAPTAIN_VICE Vice Captain
  • CEO CEO
  • CLUB_IT_OFFICER Club IT Officer
  • CLUB_OFFICIAL Club Official
  • CLUB_OFFICIAL_ASSISTANT Substitute for contact person of club
  • COACH Coach
  • COACH_ASSISTANT Assistant Coach
  • COACH_ASSISTANT_HEAD Assistant Head Coach
  • COACH_ASSOCIATE_HEAD Associate Head Coach
  • COACH_DEVELOPMENT Development Coach
  • COACH_GK Goalkeeper Coach
  • COACH_HEAD Head Coach
  • COACH_HEAD_INTERIM Interim Head Coach
  • COACH_OTHER Other coaching staff
  • COACH_SC Strength and Conditioning Coach
  • COACH_SENIOR Senior Coach
  • COACH_SPECIALIST Specialist Coach
  • COMMISSIONER Commissioner
  • COMMITTEE Committee
  • CREW_CHIEF Crew Chief
  • DELEGATE Delegate
  • DIRECTOR Director
  • DOCTOR Doctor
  • GENERAL General
  • GROUNDSKEEPER Groundskeeper
  • JUDGE Judge
  • JUDGE_SCORING Scoring Judge (SJ)
  • JUDGE_TIMING Timing Judge (TJ)
  • LIAISON_OFFICER Liaison Officer
  • MANAGER Manager
  • MATCH_LIAISON Match Liaison
  • MATCH_MANAGER Match Manager
  • MATCH_OFFICIAL Match Official
  • MATCH_SUPERVISOR Match Supervisor
  • MEDIA_OFFICER Media Officer
  • MEDICAL_OFFICER Medical Officer
  • MEDICAL_OFFICER_CF Medical Officer (Continental Federation)
  • MEDICAL_OFFICER_FIH Medical Officer (FIH)
  • MEDICAL_STAFF Medical Staff
  • NATIONAL_TOURNAMENT_OFFICIAL National Tournament Official
  • OFFICE_STAFF Office Staff
  • OFFICIAL_A Official A
  • OFFICIAL_B Official B
  • OFFICIAL_C Official C
  • OFFICIAL_D Official D
  • OFFICIAL_E Official E
  • OTHER Other
  • PHYSICAL_TRAINER Physical Trainer
  • PHYSIOTHERAPIST Physiotherapist
  • PLAYER_CONTRACT_MANAGER Player Contract Manager
  • PRESIDENT President
  • PRESIDENT_VICE Vice President
  • PSYCHOLOGIST Psychologist
  • REFEREE Referee
  • REFEREE_ASSISTANT Referee Assistant
  • REFEREE_ASSISTANT_RESERVE Reserve Assistant Referee
  • REFEREE_LIAISON Referee Liaison
  • REFEREE_OBSERVER Referee Observer
  • REFEREE_OBSERVER_LIAISON Referee Observer Liaison
  • REFEREE_RESERVE Reserve Referee
  • REPRESENTATIVE_ASSOCIATION Association Representative
  • REPRESENTATIVE_ASSOCIATION_CONTINENTAL Continental Association Representative
  • REPRESENTATIVE_ASSOCIATION_GOVERNING_BODY Governing Body Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERCONTINENTAL Intercontinental Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERNATIONAL International Association Representative
  • REPRESENTATIVE_ASSOCIATION_NATIONAL National Association Representative
  • REPRESENTATIVE_ASSOCIATION_REGIONAL Regional Association Representative
  • REPRESENTATIVE_CONTINENTAL_FEDERATION Continental Federation Representative
  • REPRESENTATIVE_FEDERATION Federation Representative
  • REPRESENTATIVE_GOVERNING_BODY Governing Body Representative
  • REPRESENTATIVE_INTERCONTINENTAL_FEDERATION Intercontinental Federation Representative
  • REPRESENTATIVE_INTERNATIONAL_FEDERATION International Federation Representative
  • REPRESENTATIVE_NATIONAL_FEDERATION National Federation Representative
  • REPRESENTATIVE_REGIONAL_FEDERATION Regional Federation Representative
  • SCOREKEEPER Scorekeeper
  • SCOREKEEPER_ASSISTANT Assistant Scorekeeper
  • SCORER Scorer
  • SCORER_ASSISTANT Assistant Scorer
  • SCOUT_1 Scout 1
  • SCOUT_2 Scout 2
  • SCOUT_3 Scout 3
  • SCOUT_SUPERVISOR Scout Supervisor
  • SECRETARY Secretary
  • SHOT_CLOCK_OPERATOR Shot Clock Operator
  • SPORT_DIRECTOR Sporting Director
  • STAND_IN_MANAGER Stand-In Manager
  • STATISTICIAN Statistician
  • TEAM_COORDINATOR Team Coordinator
  • TEAM_LEADER Team Leader
  • TEAM_MANAGER Team Manager
  • TEAM_MEDIA_OFFICER Team Media Officer
  • TECHNICAL_DELEGATE Technical Delegate
  • TECHNICAL_DELEGATE_ASSISTANT Assistant Technical Delegate
  • TECHNICAL_OFFICER Technical Officer
  • TECHNICAL_OFFICIAL Technical Official (TO)
  • TIMEKEEPER Timekeeper
  • TIMER Timer
  • TRAINER Trainer
  • TRAINER_ASSISTANT Assistant Trainer
  • TRANSLATOR Translator
  • TREASURER Treasurer
  • UMPIRE Umpire
  • UMPIRE_1 Umpire 1
  • UMPIRE_2 Umpire 2
  • UMPIRE_ASSISTANT_MANAGER Assistant Umpire Manager
  • UMPIRE_MANAGER Umpire Manager
  • UMPIRE_NATIONAL National Umpire
  • UMPIRE_NEUTRAL Neutral Umpire
  • UMPIRE_RESERVE Reserve Umpire (RU)
  • UMPIRE_VIDEO Video Umpire (VU)
  • VIDEO_ANALYST Video Analyst
  • VIDEO_TECHNICIAN Video Technician (VT)
  • YOUTH_COORDINATOR Youth Coordinator
Example: COACHPossible values:
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: rolePattern: ^(\-?role|,)*$
statusstring · enumOptional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
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
/hockey/o/{organizationId}/fixtures/{fixtureId}/roles
GET /v1/hockey/o/{organizationId}/fixtures/{fixtureId}/roles HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Delete all a role

delete
/hockey/o/{organizationId}/fixtures/{fixtureId}/roles

Delete all role

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)]
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
/hockey/o/{organizationId}/fixtures/{fixtureId}/roles
DELETE /v1/hockey/o/{organizationId}/fixtures/{fixtureId}/roles HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Get a role

get
/hockey/o/{organizationId}/roles/{roleId}

Return detailed information about a specific role

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

The unique identifier of the role

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
/hockey/o/{organizationId}/roles/{roleId}
GET /v1/hockey/o/{organizationId}/roles/{roleId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Update a role

put
/hockey/o/{organizationId}/roles/{roleId}

Change the information of a specific role

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

The unique identifier of the role

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

The club that this team belongs to

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

The unique identifier of the team

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

The unique identifier of the season

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

The unique identifier of the match

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

The unique identifier of the person

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
dateFromstring · date | nullableOptional

Date the role started (Not for a role within a match)

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

Date the role ended (Not for a role within a match)

Example: 1978-08-24
bibstring | nullableOptional

The number displayed on the jersey

Example: 34
roleNumberinteger · int32 | nullableOptional

Number within the role. eg: Assistant Coach 2

Example: 1
rolestring · enum · max: 100Optional

Role

  • ADMINISTRATOR_TOURNAMENT Tournament Administrator
  • APPEAL_JURY Appeal Jury
  • APPEAL_JURY_PRESIDENT Appeal Jury President
  • COACH Coach
  • COACH_ASSISTANT Assistant Coach
  • COACH_HEAD Head Coach
  • COACH_OTHER Other coaching staff
  • DOCTOR Doctor
  • JUDGE Judge
  • JUDGE_SCORING Scoring Judge (SJ)
  • JUDGE_TIMING Timing Judge (TJ)
  • MANAGER Manager
  • MATCH_MANAGER Match Manager
  • MEDIA_OFFICER Media Officer
  • MEDICAL_OFFICER Medical Officer
  • MEDICAL_OFFICER_CF Medical Officer (Continental Federation)
  • MEDICAL_OFFICER_FIH Medical Officer (FIH)
  • NATIONAL_TOURNAMENT_OFFICIAL National Tournament Official
  • OTHER Other
  • PHYSICAL_TRAINER Physical Trainer
  • PHYSIOTHERAPIST Physiotherapist
  • PSYCHOLOGIST Psychologist
  • REPRESENTATIVE_ASSOCIATION Association Representative
  • REPRESENTATIVE_ASSOCIATION_CONTINENTAL Continental Association Representative
  • REPRESENTATIVE_ASSOCIATION_GOVERNING_BODY Governing Body Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERCONTINENTAL Intercontinental Association Representative
  • REPRESENTATIVE_ASSOCIATION_INTERNATIONAL International Association Representative
  • REPRESENTATIVE_ASSOCIATION_NATIONAL National Association Representative
  • REPRESENTATIVE_ASSOCIATION_REGIONAL Regional Association Representative
  • REPRESENTATIVE_CONTINENTAL_FEDERATION Continental Federation Representative
  • REPRESENTATIVE_FEDERATION Federation Representative
  • REPRESENTATIVE_GOVERNING_BODY Governing Body Representative
  • REPRESENTATIVE_INTERCONTINENTAL_FEDERATION Intercontinental Federation Representative
  • REPRESENTATIVE_INTERNATIONAL_FEDERATION International Federation Representative
  • REPRESENTATIVE_NATIONAL_FEDERATION National Federation Representative
  • REPRESENTATIVE_REGIONAL_FEDERATION Regional Federation Representative
  • STAND_IN_MANAGER Stand-In Manager
  • TEAM_LEADER Team Leader
  • TEAM_MANAGER Team Manager
  • TEAM_MEDIA_OFFICER Team Media Officer
  • TECHNICAL_DELEGATE Technical Delegate
  • TECHNICAL_DELEGATE_ASSISTANT Assistant Technical Delegate
  • TECHNICAL_OFFICER Technical Officer
  • TECHNICAL_OFFICIAL Technical Official (TO)
  • TRANSLATOR Translator
  • UMPIRE Umpire
  • UMPIRE_1 Umpire 1
  • UMPIRE_2 Umpire 2
  • UMPIRE_ASSISTANT_MANAGER Assistant Umpire Manager
  • UMPIRE_MANAGER Umpire Manager
  • UMPIRE_NATIONAL National Umpire
  • UMPIRE_NEUTRAL Neutral Umpire
  • UMPIRE_RESERVE Reserve Umpire (RU)
  • UMPIRE_VIDEO Video Umpire (VU)
  • VIDEO_ANALYST Video Analyst
Example: COACHPossible values:
roleSubTypestring | nullableOptional

Role sub type

Example: Offensive Coach
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
put
/hockey/o/{organizationId}/roles/{roleId}
PUT /v1/hockey/o/{organizationId}/roles/{roleId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 414

{
  "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
  "status": "ACTIVE",
  "dateFrom": "1978-08-24",
  "dateTo": "1978-08-24",
  "bib": "34",
  "roleNumber": 1,
  "role": "COACH",
  "roleSubType": "Offensive Coach",
  "externalId": "A123"
}
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Delete a role

delete
/hockey/o/{organizationId}/roles/{roleId}

Delete a specific role

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

The unique identifier of the role

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
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
/hockey/o/{organizationId}/roles/{roleId}
DELETE /v1/hockey/o/{organizationId}/roles/{roleId} HTTP/1.1
Host: api.dc.connect.sportradar.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "meta": {
    "version": 1,
    "codeVersion": "d6cd1e2bd19e03a81132a23b2025920577f84e37",
    "code": 200,
    "time": "2018-06-05 23:43:41.227584+00:00",
    "fromCache": false,
    "count": 7,
    "limit": 10,
    "offset": 10,
    "generationTime": 0.011604
  },
  "links": {
    "self": "https://example.com",
    "next": "https://example.com",
    "previous": "https://example.com"
  },
  "included": {
    "resources": {
      "ANY_ADDITIONAL_PROPERTY": "league"
    }
  },
  "data": [
    {
      "roleId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "organizationId": "9",
      "organization": {
        "resourceType": "organizations",
        "id": "9"
      },
      "entityGroupId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entityGroup": {
        "resourceType": "entityGroups",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "entityId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "entity": {
        "resourceType": "entities",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "seasonId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "season": {
        "resourceType": "seasons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "fixtureId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "fixture": {
        "resourceType": "fixtures",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "personId": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc",
      "person": {
        "resourceType": "persons",
        "id": "009e9276-5c80-11e8-9c2d-fa7ae01bbebc"
      },
      "status": "ACTIVE",
      "dateFrom": "1978-08-24",
      "dateTo": "1978-08-24",
      "bib": "34",
      "roleNumber": 1,
      "role": "COACH",
      "roleSubType": "Offensive Coach",
      "externalId": "A123",
      "updated": "2025-11-19T05:45:55.084Z",
      "added": "2025-11-19T05:45:55.084Z"
    }
  ]
}

Last updated

Was this helpful?