Clubs

The Club is a grouping of teams. The club may share the same administrative structure over all the teams.

Get a list of clubs

get
/icehockey/o/{organizationId}/entityGroups

Return a list of available clubs

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
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
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'
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
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: -nameFullLocal,nameFullLatinPattern: ^(\-?nameFullLocal|\-?nameFullLatin|,)*$
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
/icehockey/o/{organizationId}/entityGroups

Create a club

post
/icehockey/o/{organizationId}/entityGroups

Create a new club

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

The unique identifier of the club

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

The international reference for this club given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 30Required

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
nameFullLocalstring · max: 150Required

The full name of the club in the local language

Example: Los Angeles Armadillos
nameFullLatinstring | nullableOptional

The full name of the club in latin characters

Example: Los Angeles Armadillos
codeLocalstring | nullableOptional

The code of the club in the local language

Example: TEST
codeLatinstring | nullableOptional

The code of the club in latin characters

Example: TEST
externalIdstring | nullableOptional

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
defaultVenueIdstring · uuid | nullableOptional

The unique identifier of the default venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
alternateVenueIdsstring · uuid[]Optional
Responses
200

Successful operation

application/json
post
/icehockey/o/{organizationId}/entityGroups

Get a club

get
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Return detailed information about a specific club

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

The unique identifier of the entity group

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
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Update a club

put
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Change the information of a specific club

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

The unique identifier of the entity group

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
internationalReferencestring | nullableOptional

The international reference for this club given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 30Optional

Status

  • ACTIVE Active
  • INACTIVE Inactive
  • PENDING Pending
Example: ACTIVEPossible values:
nameFullLocalstring · max: 150Optional

The full name of the club in the local language

Example: Los Angeles Armadillos
nameFullLatinstring | nullableOptional

The full name of the club in latin characters

Example: Los Angeles Armadillos
codeLocalstring | nullableOptional

The code of the club in the local language

Example: TEST
codeLatinstring | nullableOptional

The code of the club in latin characters

Example: TEST
externalIdstring | nullableOptional

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

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
defaultVenueIdstring · uuid | nullableOptional

The unique identifier of the default venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
alternateVenueIdsstring · uuid[]Optional
Responses
200

Successful operation

application/json
put
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Delete a club

delete
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Delete a specific club

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

The unique identifier of the entity group

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
/icehockey/o/{organizationId}/entityGroups/{entityGroupId}

Last updated

Was this helpful?