# Clubs

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

![](https://yuml.me/diagram/scruffy;dir:LR/class/\[Organizations]-%3C%3E\[Clubs],\[Organizations]-%3C%3E\[Teams],\[Clubs%7Bbg:orange%7D]-.-%3C%3E\[Teams],)

## Get a list of clubs

> Return a list of available clubs

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Ice Hockey","version":"v1"},"tags":[{"name":"Clubs","description":"The Club is a grouping of teams. The club may share the same administrative structure over all the teams.\n\n<img src = \"https://yuml.me/diagram/scruffy;dir:LR/class/[Organizations]-<>[Clubs],[Organizations]-<>[Teams],[Clubs{bg:orange}]-.-<>[Teams],\">\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["read:organization"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"orgId":"Authenticate based on a specific OrganizationId","read:orggroup":"Read data over multiple organizations using and *orggroup* code","write:organization":"Write/Update any data from below the organization","read:organization":"Read any data from the organization down","write:admin":"Perform administration API calls","write:admin_organization":"Ability to manage organizations","write:system":"Perform system configuration API calls"}}},"description":"You can create a JSON Web Token (JWT) using the [token](http://developer.connect.sportradar.com/token/#operation/getToken) 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."}},"schemas":{"ResponseMetaData":{"type":"object","properties":{"version":{"type":"integer","description":"The version of the API in use for this call"},"codeVersion":{"type":"string","description":"A string indicating the version of the code that handled this request"},"code":{"type":"integer","description":"The HTTP response code for this request"},"time":{"type":"string","format":"date-time","description":"The date/time this request was made (in UTC)."},"fromCache":{"type":"boolean","description":"Was this request served directly from the cache?"},"count":{"type":"integer","description":"The number of records being returned"},"limit":{"type":"integer","description":"The record limit in place for this request"},"offset":{"type":"integer","description":"The record offset in place for this request"},"generationTime":{"type":"number","format":"float","description":"The number of seconds taken to generate this request."}}},"ResponseLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The URI referencing this request."},"next":{"type":"string","format":"uri","description":"The URI referencing the 'next' page, if more data is available."},"previous":{"type":"string","format":"uri","description":"The URI referencing the 'previous' page, if the request is not on the first page."}}},"IncludedData":{"type":"object","description":"Available if the request used the 'include' parameter.  It contains extra data about resources found in the data block.","properties":{"resources":{"type":"object","additionalProperties":{"description":"The type of resource","type":"object","enum":["league","organisation","persons"],"additionalProperties":{"type":"object","format":"uuid","description":"The id of the resource","additionalProperties":{"description":"The model for the resource as defined by the type and id"}}}}}},"Entity_GroupsModel":{"type":"object","additionalProperties":false,"properties":{"entityGroupId":{"description":"The unique identifier of the club","type":"string","format":"uuid"},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this club belongs to","type":"object"},"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"club model"},"ImagesModel":{"type":"object","additionalProperties":false,"properties":{"imageId":{"description":"The unique identifier of the image record","type":"string","format":"uuid","readOnly":true},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this images belongs to","type":"object"},"baseType":{"description":"The object that this image relates to\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `ORGANIZATION` Organization\n>- `PERSON` Person\n>- `SEASON` Season\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["PERSON","ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","ORGANIZATION","DIVISION","CONFERENCE","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"baseId":{"description":"The unique identifier of the object associated with this image's record. If the `baseType` is `PERSON` then this would be the value of `personId`.","type":"string","format":"uuid"},"fileType":{"description":"The type of file\n>- `JPG` jpg\n>- `PNG` png\n>- `SVG` svg\n","type":"string","enum":["JPG","PNG","SVG"],"maxLength":3,"readOnly":true},"imageType":{"description":"Upload Type\n>- `LOGO` Logo - Not valid for 'PERSON' baseType\n>- `LOGO_ALTERNATE` Logo (alternate) - Not valid for 'PERSON' baseType\n>- `LOGO_BACKGROUND` Stylised logo for background purposes - Not valid for 'PERSON' baseType\n>- `PERSON_HEAD` Head shot (shoulders and head) - Only valid for 'PERSON' baseType\n>- `PERSON_POSE` Person posing - Only valid for 'PERSON' baseType\n>- `PERSON_WAIST` Head shot from the waist up - Only valid for 'PERSON' baseType\n>- `TEAM_PHOTO` Team Photo - Only valid for 'ENTITY' baseType\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["LOGO","LOGO_ALTERNATE","LOGO_BACKGROUND","PERSON_HEAD","PERSON_WAIST","PERSON_POSE","TEAM_PHOTO","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"secondaryType":{"description":"If the image relates to a secondary object. Such as a photo of a person in a team, then baseType would be PERSON and secondaryType would be TEAM.\n>- None None\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `SEASON` Season\n","type":"string","enum":["ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","DIVISION","CONFERENCE",null],"maxLength":100,"nullable":true},"secondaryId":{"description":"The unique identifier of the object associated with the secondaryType","type":"string","format":"uuid"},"rating":{"description":"The rating given to the quality of the image.  All images are LOW by default but are set ad MEDIUM if they are large enough and have transparency.  Images are only marked as HIGH if they have been manually reviewed.  You should take your use-case into account when you go to use the image.\n>- `HIGH` High\n>- `LOW` Low\n>- `MEDIUM` Medium\n","type":"string","enum":["LOW","MEDIUM","HIGH"],"maxLength":100,"readOnly":true},"url":{"description":"The URL of the image. See [Images](#section/Introduction/Images) for more information.","type":"string","readOnly":true},"maximumHeight":{"description":"The maximum height (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"maximumWidth":{"description":"The maximum width (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true}},"title":"images model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.  If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"added":{"name":"added","description":"Record was added after this date/time. In UTC.","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"},"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display.  The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"limit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":1000,"minimum":1,"default":10},"required":false,"in":"query"},"nameFullLatinContains":{"name":"nameFullLatinContains","description":"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","schema":{"type":"string","minLength":2,"maxLength":50},"required":false,"in":"query"},"nameFullLocalContains":{"name":"nameFullLocalContains","description":"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","schema":{"type":"string","minLength":2,"maxLength":50},"required":false,"in":"query"},"offset":{"name":"offset","description":"The offset of the records. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32"},"required":false,"in":"query"},"status":{"name":"status","description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","schema":{"type":"string","enum":["ACTIVE","INACTIVE","PENDING"]},"required":false,"in":"query"},"updated":{"name":"updated","description":"Record was modified after this date/time. In UTC.","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"}}},"paths":{"/icehockey/o/{organizationId}/entityGroups":{"get":{"tags":["Clubs"],"summary":"Get a list of clubs","description":"Return a list of available clubs","operationId":"entity_group_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Entity_Groups Response","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"links":{"$ref":"#/components/schemas/ResponseLinks"},"included":{"$ref":"#/components/schemas/IncludedData"},"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Entity_GroupsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/added"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/nameFullLatinContains"},{"$ref":"#/components/parameters/nameFullLocalContains"},{"$ref":"#/components/parameters/offset"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"name":"sortBy","description":"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.","schema":{"type":"string","pattern":"^(\\-?nameFullLocal|\\-?nameFullLatin|,)*$"},"required":false,"in":"query"},{"$ref":"#/components/parameters/status"},{"$ref":"#/components/parameters/updated"}]}}}}
```

## Create a club

> Create a new club

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Ice Hockey","version":"v1"},"tags":[{"name":"Clubs","description":"The Club is a grouping of teams. The club may share the same administrative structure over all the teams.\n\n<img src = \"https://yuml.me/diagram/scruffy;dir:LR/class/[Organizations]-<>[Clubs],[Organizations]-<>[Teams],[Clubs{bg:orange}]-.-<>[Teams],\">\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:organization"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"orgId":"Authenticate based on a specific OrganizationId","read:orggroup":"Read data over multiple organizations using and *orggroup* code","write:organization":"Write/Update any data from below the organization","read:organization":"Read any data from the organization down","write:admin":"Perform administration API calls","write:admin_organization":"Ability to manage organizations","write:system":"Perform system configuration API calls"}}},"description":"You can create a JSON Web Token (JWT) using the [token](http://developer.connect.sportradar.com/token/#operation/getToken) 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."}},"schemas":{"ResponseMetaData":{"type":"object","properties":{"version":{"type":"integer","description":"The version of the API in use for this call"},"codeVersion":{"type":"string","description":"A string indicating the version of the code that handled this request"},"code":{"type":"integer","description":"The HTTP response code for this request"},"time":{"type":"string","format":"date-time","description":"The date/time this request was made (in UTC)."},"fromCache":{"type":"boolean","description":"Was this request served directly from the cache?"},"count":{"type":"integer","description":"The number of records being returned"},"limit":{"type":"integer","description":"The record limit in place for this request"},"offset":{"type":"integer","description":"The record offset in place for this request"},"generationTime":{"type":"number","format":"float","description":"The number of seconds taken to generate this request."}}},"ResponseLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The URI referencing this request."},"next":{"type":"string","format":"uri","description":"The URI referencing the 'next' page, if more data is available."},"previous":{"type":"string","format":"uri","description":"The URI referencing the 'previous' page, if the request is not on the first page."}}},"IncludedData":{"type":"object","description":"Available if the request used the 'include' parameter.  It contains extra data about resources found in the data block.","properties":{"resources":{"type":"object","additionalProperties":{"description":"The type of resource","type":"object","enum":["league","organisation","persons"],"additionalProperties":{"type":"object","format":"uuid","description":"The id of the resource","additionalProperties":{"description":"The model for the resource as defined by the type and id"}}}}}},"Entity_GroupsModel":{"type":"object","additionalProperties":false,"properties":{"entityGroupId":{"description":"The unique identifier of the club","type":"string","format":"uuid"},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this club belongs to","type":"object"},"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"club model"},"ImagesModel":{"type":"object","additionalProperties":false,"properties":{"imageId":{"description":"The unique identifier of the image record","type":"string","format":"uuid","readOnly":true},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this images belongs to","type":"object"},"baseType":{"description":"The object that this image relates to\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `ORGANIZATION` Organization\n>- `PERSON` Person\n>- `SEASON` Season\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["PERSON","ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","ORGANIZATION","DIVISION","CONFERENCE","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"baseId":{"description":"The unique identifier of the object associated with this image's record. If the `baseType` is `PERSON` then this would be the value of `personId`.","type":"string","format":"uuid"},"fileType":{"description":"The type of file\n>- `JPG` jpg\n>- `PNG` png\n>- `SVG` svg\n","type":"string","enum":["JPG","PNG","SVG"],"maxLength":3,"readOnly":true},"imageType":{"description":"Upload Type\n>- `LOGO` Logo - Not valid for 'PERSON' baseType\n>- `LOGO_ALTERNATE` Logo (alternate) - Not valid for 'PERSON' baseType\n>- `LOGO_BACKGROUND` Stylised logo for background purposes - Not valid for 'PERSON' baseType\n>- `PERSON_HEAD` Head shot (shoulders and head) - Only valid for 'PERSON' baseType\n>- `PERSON_POSE` Person posing - Only valid for 'PERSON' baseType\n>- `PERSON_WAIST` Head shot from the waist up - Only valid for 'PERSON' baseType\n>- `TEAM_PHOTO` Team Photo - Only valid for 'ENTITY' baseType\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["LOGO","LOGO_ALTERNATE","LOGO_BACKGROUND","PERSON_HEAD","PERSON_WAIST","PERSON_POSE","TEAM_PHOTO","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"secondaryType":{"description":"If the image relates to a secondary object. Such as a photo of a person in a team, then baseType would be PERSON and secondaryType would be TEAM.\n>- None None\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `SEASON` Season\n","type":"string","enum":["ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","DIVISION","CONFERENCE",null],"maxLength":100,"nullable":true},"secondaryId":{"description":"The unique identifier of the object associated with the secondaryType","type":"string","format":"uuid"},"rating":{"description":"The rating given to the quality of the image.  All images are LOW by default but are set ad MEDIUM if they are large enough and have transparency.  Images are only marked as HIGH if they have been manually reviewed.  You should take your use-case into account when you go to use the image.\n>- `HIGH` High\n>- `LOW` Low\n>- `MEDIUM` Medium\n","type":"string","enum":["LOW","MEDIUM","HIGH"],"maxLength":100,"readOnly":true},"url":{"description":"The URL of the image. See [Images](#section/Introduction/Images) for more information.","type":"string","readOnly":true},"maximumHeight":{"description":"The maximum height (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"maximumWidth":{"description":"The maximum width (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true}},"title":"images model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.  If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display.  The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"}}},"paths":{"/icehockey/o/{organizationId}/entityGroups":{"post":{"tags":["Clubs"],"summary":"Create a club","description":"Create a new club","operationId":"entity_group_insert","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Entity_Groups Response","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"links":{"$ref":"#/components/schemas/ResponseLinks"},"included":{"$ref":"#/components/schemas/IncludedData"},"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Entity_GroupsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"entityGroupId":{"description":"The unique identifier of the club","type":"string","format":"uuid"},"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"title":"club post body","required":["status","nameFullLocal"]}}}}}}}}
```

## Get a club

> Return detailed information about a specific club

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Ice Hockey","version":"v1"},"tags":[{"name":"Clubs","description":"The Club is a grouping of teams. The club may share the same administrative structure over all the teams.\n\n<img src = \"https://yuml.me/diagram/scruffy;dir:LR/class/[Organizations]-<>[Clubs],[Organizations]-<>[Teams],[Clubs{bg:orange}]-.-<>[Teams],\">\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["read:organization"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"orgId":"Authenticate based on a specific OrganizationId","read:orggroup":"Read data over multiple organizations using and *orggroup* code","write:organization":"Write/Update any data from below the organization","read:organization":"Read any data from the organization down","write:admin":"Perform administration API calls","write:admin_organization":"Ability to manage organizations","write:system":"Perform system configuration API calls"}}},"description":"You can create a JSON Web Token (JWT) using the [token](http://developer.connect.sportradar.com/token/#operation/getToken) 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."}},"schemas":{"ResponseMetaData":{"type":"object","properties":{"version":{"type":"integer","description":"The version of the API in use for this call"},"codeVersion":{"type":"string","description":"A string indicating the version of the code that handled this request"},"code":{"type":"integer","description":"The HTTP response code for this request"},"time":{"type":"string","format":"date-time","description":"The date/time this request was made (in UTC)."},"fromCache":{"type":"boolean","description":"Was this request served directly from the cache?"},"count":{"type":"integer","description":"The number of records being returned"},"limit":{"type":"integer","description":"The record limit in place for this request"},"offset":{"type":"integer","description":"The record offset in place for this request"},"generationTime":{"type":"number","format":"float","description":"The number of seconds taken to generate this request."}}},"ResponseLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The URI referencing this request."},"next":{"type":"string","format":"uri","description":"The URI referencing the 'next' page, if more data is available."},"previous":{"type":"string","format":"uri","description":"The URI referencing the 'previous' page, if the request is not on the first page."}}},"IncludedData":{"type":"object","description":"Available if the request used the 'include' parameter.  It contains extra data about resources found in the data block.","properties":{"resources":{"type":"object","additionalProperties":{"description":"The type of resource","type":"object","enum":["league","organisation","persons"],"additionalProperties":{"type":"object","format":"uuid","description":"The id of the resource","additionalProperties":{"description":"The model for the resource as defined by the type and id"}}}}}},"Entity_GroupsModel":{"type":"object","additionalProperties":false,"properties":{"entityGroupId":{"description":"The unique identifier of the club","type":"string","format":"uuid"},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this club belongs to","type":"object"},"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"club model"},"ImagesModel":{"type":"object","additionalProperties":false,"properties":{"imageId":{"description":"The unique identifier of the image record","type":"string","format":"uuid","readOnly":true},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this images belongs to","type":"object"},"baseType":{"description":"The object that this image relates to\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `ORGANIZATION` Organization\n>- `PERSON` Person\n>- `SEASON` Season\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["PERSON","ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","ORGANIZATION","DIVISION","CONFERENCE","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"baseId":{"description":"The unique identifier of the object associated with this image's record. If the `baseType` is `PERSON` then this would be the value of `personId`.","type":"string","format":"uuid"},"fileType":{"description":"The type of file\n>- `JPG` jpg\n>- `PNG` png\n>- `SVG` svg\n","type":"string","enum":["JPG","PNG","SVG"],"maxLength":3,"readOnly":true},"imageType":{"description":"Upload Type\n>- `LOGO` Logo - Not valid for 'PERSON' baseType\n>- `LOGO_ALTERNATE` Logo (alternate) - Not valid for 'PERSON' baseType\n>- `LOGO_BACKGROUND` Stylised logo for background purposes - Not valid for 'PERSON' baseType\n>- `PERSON_HEAD` Head shot (shoulders and head) - Only valid for 'PERSON' baseType\n>- `PERSON_POSE` Person posing - Only valid for 'PERSON' baseType\n>- `PERSON_WAIST` Head shot from the waist up - Only valid for 'PERSON' baseType\n>- `TEAM_PHOTO` Team Photo - Only valid for 'ENTITY' baseType\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["LOGO","LOGO_ALTERNATE","LOGO_BACKGROUND","PERSON_HEAD","PERSON_WAIST","PERSON_POSE","TEAM_PHOTO","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"secondaryType":{"description":"If the image relates to a secondary object. Such as a photo of a person in a team, then baseType would be PERSON and secondaryType would be TEAM.\n>- None None\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `SEASON` Season\n","type":"string","enum":["ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","DIVISION","CONFERENCE",null],"maxLength":100,"nullable":true},"secondaryId":{"description":"The unique identifier of the object associated with the secondaryType","type":"string","format":"uuid"},"rating":{"description":"The rating given to the quality of the image.  All images are LOW by default but are set ad MEDIUM if they are large enough and have transparency.  Images are only marked as HIGH if they have been manually reviewed.  You should take your use-case into account when you go to use the image.\n>- `HIGH` High\n>- `LOW` Low\n>- `MEDIUM` Medium\n","type":"string","enum":["LOW","MEDIUM","HIGH"],"maxLength":100,"readOnly":true},"url":{"description":"The URL of the image. See [Images](#section/Introduction/Images) for more information.","type":"string","readOnly":true},"maximumHeight":{"description":"The maximum height (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"maximumWidth":{"description":"The maximum width (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true}},"title":"images model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.  If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display.  The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"limit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":1000,"minimum":1,"default":10},"required":false,"in":"query"},"offset":{"name":"offset","description":"The offset of the records. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32"},"required":false,"in":"query"}}},"paths":{"/icehockey/o/{organizationId}/entityGroups/{entityGroupId}":{"get":{"tags":["Clubs"],"summary":"Get a club","description":"Return detailed information about a specific club","operationId":"entity_group_detail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Entity_Groups Response","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"links":{"$ref":"#/components/schemas/ResponseLinks"},"included":{"$ref":"#/components/schemas/IncludedData"},"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Entity_GroupsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"name":"entityGroupId","description":"The unique identifier of the entity group","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"}]}}}}
```

## Update a club

> Change the information of a specific club

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Ice Hockey","version":"v1"},"tags":[{"name":"Clubs","description":"The Club is a grouping of teams. The club may share the same administrative structure over all the teams.\n\n<img src = \"https://yuml.me/diagram/scruffy;dir:LR/class/[Organizations]-<>[Clubs],[Organizations]-<>[Teams],[Clubs{bg:orange}]-.-<>[Teams],\">\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:organization"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"orgId":"Authenticate based on a specific OrganizationId","read:orggroup":"Read data over multiple organizations using and *orggroup* code","write:organization":"Write/Update any data from below the organization","read:organization":"Read any data from the organization down","write:admin":"Perform administration API calls","write:admin_organization":"Ability to manage organizations","write:system":"Perform system configuration API calls"}}},"description":"You can create a JSON Web Token (JWT) using the [token](http://developer.connect.sportradar.com/token/#operation/getToken) 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."}},"schemas":{"ResponseMetaData":{"type":"object","properties":{"version":{"type":"integer","description":"The version of the API in use for this call"},"codeVersion":{"type":"string","description":"A string indicating the version of the code that handled this request"},"code":{"type":"integer","description":"The HTTP response code for this request"},"time":{"type":"string","format":"date-time","description":"The date/time this request was made (in UTC)."},"fromCache":{"type":"boolean","description":"Was this request served directly from the cache?"},"count":{"type":"integer","description":"The number of records being returned"},"limit":{"type":"integer","description":"The record limit in place for this request"},"offset":{"type":"integer","description":"The record offset in place for this request"},"generationTime":{"type":"number","format":"float","description":"The number of seconds taken to generate this request."}}},"ResponseLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The URI referencing this request."},"next":{"type":"string","format":"uri","description":"The URI referencing the 'next' page, if more data is available."},"previous":{"type":"string","format":"uri","description":"The URI referencing the 'previous' page, if the request is not on the first page."}}},"IncludedData":{"type":"object","description":"Available if the request used the 'include' parameter.  It contains extra data about resources found in the data block.","properties":{"resources":{"type":"object","additionalProperties":{"description":"The type of resource","type":"object","enum":["league","organisation","persons"],"additionalProperties":{"type":"object","format":"uuid","description":"The id of the resource","additionalProperties":{"description":"The model for the resource as defined by the type and id"}}}}}},"Entity_GroupsModel":{"type":"object","additionalProperties":false,"properties":{"entityGroupId":{"description":"The unique identifier of the club","type":"string","format":"uuid"},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this club belongs to","type":"object"},"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"club model"},"ImagesModel":{"type":"object","additionalProperties":false,"properties":{"imageId":{"description":"The unique identifier of the image record","type":"string","format":"uuid","readOnly":true},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this images belongs to","type":"object"},"baseType":{"description":"The object that this image relates to\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `ORGANIZATION` Organization\n>- `PERSON` Person\n>- `SEASON` Season\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["PERSON","ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","ORGANIZATION","DIVISION","CONFERENCE","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"baseId":{"description":"The unique identifier of the object associated with this image's record. If the `baseType` is `PERSON` then this would be the value of `personId`.","type":"string","format":"uuid"},"fileType":{"description":"The type of file\n>- `JPG` jpg\n>- `PNG` png\n>- `SVG` svg\n","type":"string","enum":["JPG","PNG","SVG"],"maxLength":3,"readOnly":true},"imageType":{"description":"Upload Type\n>- `LOGO` Logo - Not valid for 'PERSON' baseType\n>- `LOGO_ALTERNATE` Logo (alternate) - Not valid for 'PERSON' baseType\n>- `LOGO_BACKGROUND` Stylised logo for background purposes - Not valid for 'PERSON' baseType\n>- `PERSON_HEAD` Head shot (shoulders and head) - Only valid for 'PERSON' baseType\n>- `PERSON_POSE` Person posing - Only valid for 'PERSON' baseType\n>- `PERSON_WAIST` Head shot from the waist up - Only valid for 'PERSON' baseType\n>- `TEAM_PHOTO` Team Photo - Only valid for 'ENTITY' baseType\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["LOGO","LOGO_ALTERNATE","LOGO_BACKGROUND","PERSON_HEAD","PERSON_WAIST","PERSON_POSE","TEAM_PHOTO","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"secondaryType":{"description":"If the image relates to a secondary object. Such as a photo of a person in a team, then baseType would be PERSON and secondaryType would be TEAM.\n>- None None\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `SEASON` Season\n","type":"string","enum":["ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","DIVISION","CONFERENCE",null],"maxLength":100,"nullable":true},"secondaryId":{"description":"The unique identifier of the object associated with the secondaryType","type":"string","format":"uuid"},"rating":{"description":"The rating given to the quality of the image.  All images are LOW by default but are set ad MEDIUM if they are large enough and have transparency.  Images are only marked as HIGH if they have been manually reviewed.  You should take your use-case into account when you go to use the image.\n>- `HIGH` High\n>- `LOW` Low\n>- `MEDIUM` Medium\n","type":"string","enum":["LOW","MEDIUM","HIGH"],"maxLength":100,"readOnly":true},"url":{"description":"The URL of the image. See [Images](#section/Introduction/Images) for more information.","type":"string","readOnly":true},"maximumHeight":{"description":"The maximum height (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"maximumWidth":{"description":"The maximum width (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true}},"title":"images model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.  If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display.  The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"}}},"paths":{"/icehockey/o/{organizationId}/entityGroups/{entityGroupId}":{"put":{"tags":["Clubs"],"summary":"Update a club","description":"Change the information of a specific club","operationId":"entity_group_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Entity_Groups Response","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"links":{"$ref":"#/components/schemas/ResponseLinks"},"included":{"$ref":"#/components/schemas/IncludedData"},"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Entity_GroupsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"name":"entityGroupId","description":"The unique identifier of the entity group","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"title":"club put body"}}}}}}}}
```

## Delete a club

> Delete a specific club

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Ice Hockey","version":"v1"},"tags":[{"name":"Clubs","description":"The Club is a grouping of teams. The club may share the same administrative structure over all the teams.\n\n<img src = \"https://yuml.me/diagram/scruffy;dir:LR/class/[Organizations]-<>[Clubs],[Organizations]-<>[Teams],[Clubs{bg:orange}]-.-<>[Teams],\">\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:organization"]}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"/oauth/token","scopes":{"orgId":"Authenticate based on a specific OrganizationId","read:orggroup":"Read data over multiple organizations using and *orggroup* code","write:organization":"Write/Update any data from below the organization","read:organization":"Read any data from the organization down","write:admin":"Perform administration API calls","write:admin_organization":"Ability to manage organizations","write:system":"Perform system configuration API calls"}}},"description":"You can create a JSON Web Token (JWT) using the [token](http://developer.connect.sportradar.com/token/#operation/getToken) 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."}},"schemas":{"ResponseMetaData":{"type":"object","properties":{"version":{"type":"integer","description":"The version of the API in use for this call"},"codeVersion":{"type":"string","description":"A string indicating the version of the code that handled this request"},"code":{"type":"integer","description":"The HTTP response code for this request"},"time":{"type":"string","format":"date-time","description":"The date/time this request was made (in UTC)."},"fromCache":{"type":"boolean","description":"Was this request served directly from the cache?"},"count":{"type":"integer","description":"The number of records being returned"},"limit":{"type":"integer","description":"The record limit in place for this request"},"offset":{"type":"integer","description":"The record offset in place for this request"},"generationTime":{"type":"number","format":"float","description":"The number of seconds taken to generate this request."}}},"ResponseLinks":{"type":"object","properties":{"self":{"type":"string","format":"uri","description":"The URI referencing this request."},"next":{"type":"string","format":"uri","description":"The URI referencing the 'next' page, if more data is available."},"previous":{"type":"string","format":"uri","description":"The URI referencing the 'previous' page, if the request is not on the first page."}}},"IncludedData":{"type":"object","description":"Available if the request used the 'include' parameter.  It contains extra data about resources found in the data block.","properties":{"resources":{"type":"object","additionalProperties":{"description":"The type of resource","type":"object","enum":["league","organisation","persons"],"additionalProperties":{"type":"object","format":"uuid","description":"The id of the resource","additionalProperties":{"description":"The model for the resource as defined by the type and id"}}}}}},"Entity_GroupsModel":{"type":"object","additionalProperties":false,"properties":{"entityGroupId":{"description":"The unique identifier of the club","type":"string","format":"uuid"},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this club belongs to","type":"object"},"internationalReference":{"description":"The international reference for this club given by the sport governing body","type":"string","maxLength":30,"nullable":true},"status":{"description":"Status\n>- `ACTIVE` Active\n>- `INACTIVE` Inactive\n>- `PENDING` Pending\n","type":"string","enum":["ACTIVE","INACTIVE","PENDING"],"maxLength":30},"nameFullLocal":{"description":"The full name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"additionalNames":{"type":"object","properties":{"nameShortLocal":{"description":"The short name of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":50,"nullable":true},"namePlaceLocal":{"description":"The name of the place associated with the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150,"nullable":true},"nameShortLatin":{"description":"The short name of the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":50,"nullable":true},"namePlaceLatin":{"description":"The name of the place associated with the club using [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true}}},"nameFullLatin":{"description":"The full name of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"codeLocal":{"description":"The code of the club in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":5,"nullable":true},"codeLatin":{"description":"The code of the club in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":5,"nullable":true},"address":{"title":"Club address","description":"Street Address for the club","type":"object","nullable":true,"additionalProperties":false,"properties":{"address1":{"description":"First line of the address","type":"string","nullable":true},"address2":{"description":"Second line of the address","type":"string","nullable":true},"address3":{"description":"Third line of the address","type":"string","nullable":true},"city":{"description":"The city/suburb of the address","type":"string","nullable":true},"state":{"description":"The state of the address","type":"string","nullable":true},"postalCode":{"description":"The postal code for the address","type":"string","nullable":true},"countryCode":{"description":"ISO Country code of the address.  We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","nullable":true,"maxLength":3,"minLength":3},"longitude":{"type":"number","nullable":true},"latitude":{"type":"number","nullable":true}}},"social":{"title":"Social Media","description":"Social Media contacts","type":"object","nullable":true,"additionalProperties":false,"properties":{"website":{"type":"string","nullable":true,"format":"uri"},"facebook":{"type":"string","nullable":true,"format":"uri"},"twitter":{"type":"string","nullable":true,"format":"uri"},"wikipedia":{"type":"string","nullable":true,"format":"uri"},"instagram":{"type":"string","nullable":true,"format":"uri"}}},"details":{"title":"Entity additional details","description":"Additional detail fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"founded":{"description":"Year Founded","type":"number","nullable":true},"squadValue":{"description":"Value of Squad","type":"number","nullable":true}}},"contacts":{"title":"Contact details","description":"Public contact fields","type":"object","nullable":true,"additionalProperties":false,"properties":{"fax":{"type":"string","nullable":true,"description":"Fax number","format":"phone"},"phone":{"type":"string","nullable":true,"description":"Primary phone number","format":"phone"},"phoneSecondary":{"type":"string","nullable":true,"format":"phone","description":"Secondary phone number"},"email":{"type":"string","nullable":true,"description":"Primary email address","format":"email"}}},"colors":{"type":"object","properties":{"primary":{"description":"Primary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"secondary":{"description":"Secondary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true},"tertiary":{"description":"Tertiary color of the club.  Colors are a hexadecimal string `RRGGBB` with `RR`(red), `GG`(green) and `BB`(blue) representing the components of the colour. ","type":"string","minLength":6,"maxLength":6,"nullable":true}}},"historicalNames":{"type":"array","nullable":true,"title":"Club historical names","description":"Array of club historical names","items":{"type":"object","title":"Club historical name","additionalProperties":false,"properties":{"dateStart":{"description":"Start date","type":"string","nullable":true,"format":"date"},"dateEnd":{"description":"End date","type":"string","nullable":true,"format":"date"},"nameFullLocal":{"description":"Full name in local language","type":"string","nullable":true},"nameFullLatin":{"description":"Full name in latin characters","type":"string","nullable":true},"nameShortLocal":{"description":"Short name in local language","type":"string","nullable":true},"nameShortLatin":{"description":"Short name in latin characters","type":"string","nullable":true},"namePlaceLocal":{"description":"Place name in latin characters","type":"string","nullable":true}}}},"externalId":{"description":"The Id of the data as set by the provider of the data","type":"string","maxLength":150,"pattern":"^[0-9A-Za-z/_-]+$","nullable":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true},"defaultVenueId":{"description":"The unique identifier of the default venue","type":"string","format":"uuid","nullable":true},"alternateVenueIds":{"type":"array","items":{"type":"string","format":"uuid"}},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"club model"},"ImagesModel":{"type":"object","additionalProperties":false,"properties":{"imageId":{"description":"The unique identifier of the image record","type":"string","format":"uuid","readOnly":true},"organizationId":{"description":"The unique identifier of the organization","type":"string","readOnly":true},"organization":{"properties":{"resourceType":{"type":"string","enum":["organizations"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The organization that this images belongs to","type":"object"},"baseType":{"description":"The object that this image relates to\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `ORGANIZATION` Organization\n>- `PERSON` Person\n>- `SEASON` Season\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["PERSON","ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","ORGANIZATION","DIVISION","CONFERENCE","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"baseId":{"description":"The unique identifier of the object associated with this image's record. If the `baseType` is `PERSON` then this would be the value of `personId`.","type":"string","format":"uuid"},"fileType":{"description":"The type of file\n>- `JPG` jpg\n>- `PNG` png\n>- `SVG` svg\n","type":"string","enum":["JPG","PNG","SVG"],"maxLength":3,"readOnly":true},"imageType":{"description":"Upload Type\n>- `LOGO` Logo - Not valid for 'PERSON' baseType\n>- `LOGO_ALTERNATE` Logo (alternate) - Not valid for 'PERSON' baseType\n>- `LOGO_BACKGROUND` Stylised logo for background purposes - Not valid for 'PERSON' baseType\n>- `PERSON_HEAD` Head shot (shoulders and head) - Only valid for 'PERSON' baseType\n>- `PERSON_POSE` Person posing - Only valid for 'PERSON' baseType\n>- `PERSON_WAIST` Head shot from the waist up - Only valid for 'PERSON' baseType\n>- `TEAM_PHOTO` Team Photo - Only valid for 'ENTITY' baseType\n>- `UNIFORM` Uniform\n>- `UNIFORM_ITEM` Uniform Item\n","type":"string","enum":["LOGO","LOGO_ALTERNATE","LOGO_BACKGROUND","PERSON_HEAD","PERSON_WAIST","PERSON_POSE","TEAM_PHOTO","UNIFORM","UNIFORM_ITEM"],"maxLength":100},"secondaryType":{"description":"If the image relates to a secondary object. Such as a photo of a person in a team, then baseType would be PERSON and secondaryType would be TEAM.\n>- None None\n>- `COMPETITION` Competition\n>- `CONFERENCE` Conference\n>- `DIVISION` Division\n>- `ENTITY` Entity\n>- `ENTITYGROUP` Entity Group\n>- `LEAGUE` League\n>- `SEASON` Season\n","type":"string","enum":["ENTITY","ENTITYGROUP","COMPETITION","SEASON","LEAGUE","DIVISION","CONFERENCE",null],"maxLength":100,"nullable":true},"secondaryId":{"description":"The unique identifier of the object associated with the secondaryType","type":"string","format":"uuid"},"rating":{"description":"The rating given to the quality of the image.  All images are LOW by default but are set ad MEDIUM if they are large enough and have transparency.  Images are only marked as HIGH if they have been manually reviewed.  You should take your use-case into account when you go to use the image.\n>- `HIGH` High\n>- `LOW` Low\n>- `MEDIUM` Medium\n","type":"string","enum":["LOW","MEDIUM","HIGH"],"maxLength":100,"readOnly":true},"url":{"description":"The URL of the image. See [Images](#section/Introduction/Images) for more information.","type":"string","readOnly":true},"maximumHeight":{"description":"The maximum height (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"maximumWidth":{"description":"The maximum width (in pixels) of this image.","type":"integer","format":"int32","readOnly":true},"updated":{"description":"Date/time last modified. In UTC","type":"string","format":"date-time","readOnly":true},"added":{"description":"Date/time added. In UTC","type":"string","format":"date-time","readOnly":true}},"title":"images model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.  If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display.  The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"forceDelete":{"name":"forceDelete","description":"Force a delete command to run and delete child records as well if there are existing records depending on the record.","schema":{"type":"boolean"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"}}},"paths":{"/icehockey/o/{organizationId}/entityGroups/{entityGroupId}":{"delete":{"tags":["Clubs"],"summary":"Delete a club","description":"Delete a specific club","operationId":"entity_group_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Entity_Groups Response","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"links":{"$ref":"#/components/schemas/ResponseLinks"},"included":{"$ref":"#/components/schemas/IncludedData"},"data":{"type":"array","description":"","items":{"$ref":"#/components/schemas/Entity_GroupsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"name":"entityGroupId","description":"The unique identifier of the entity group","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/forceDelete"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"}]}}}}
```
