# Organizations

The Organization is the top level element in the data structure. They are the data owner. They are the ones that have provided the data.

All entities/data in the system belong to **one** organization.

![](https://yuml.me/diagram/scruffy/class/\[Organizations%7Bbg:orange%7D]-%3C%3E\[Persons],\[Organizations]-.-%3C%3E\[Leagues],\[Organizations]-.-%3C%3E\[Divisions],\[Organizations]-%3C%3E\[Competitions],\[Organizations]-%3C%3E\[Clubs],\[Organizations]-%3C%3E\[Venues],\[Organizations]-%3C%3E\[Sites],\[Organizations]-%3C%3E\[Teams])

## Get a list of organizations

> Return a list of available organizations

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Hockey","version":"v1"},"tags":[{"name":"Organizations","description":"The Organization is the top level element in the data structure.  They are the data owner. They are the ones that have provided the data.\n\nAll entities/data in the system belong to **one** organization.\n\n<img src = \"https://yuml.me/diagram/scruffy/class/[Organizations{bg:orange}]-<>[Persons],[Organizations]-.-<>[Leagues],[Organizations]-.-<>[Divisions],[Organizations]-<>[Competitions],[Organizations]-<>[Clubs],[Organizations]-<>[Venues],[Organizations]-<>[Sites],[Organizations]-<>[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"}}}}}},"OrganizationsModel":{"type":"object","additionalProperties":false,"properties":{"organizationId":{"description":"The unique identifier of the organization","type":"string","minLength":5,"maxLength":5},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"},"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},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"organization 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"},"countryCode":{"name":"countryCode","description":"Country code","schema":{"type":"string","minLength":3,"maxLength":3},"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"},"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"},"regionType":{"name":"regionType","description":"The region type\n>- `INTERNATIONAL` Multiple countries\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","schema":{"type":"string","enum":["LOCAL","STATE","NATIONAL","INTERNATIONAL"]},"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":{"/hockey/organizations":{"get":{"tags":["Organizations"],"summary":"Get a list of organizations","description":"Return a list of available organizations","operationId":"organization_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Organizations 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/OrganizationsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/added"},{"$ref":"#/components/parameters/countryCode"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/regionType"},{"$ref":"#/components/parameters/updated"}]}}}}
```

## Create a new organization

> Add a new organization to the system

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Hockey","version":"v1"},"tags":[{"name":"Organizations","description":"The Organization is the top level element in the data structure.  They are the data owner. They are the ones that have provided the data.\n\nAll entities/data in the system belong to **one** organization.\n\n<img src = \"https://yuml.me/diagram/scruffy/class/[Organizations{bg:orange}]-<>[Persons],[Organizations]-.-<>[Leagues],[Organizations]-.-<>[Divisions],[Organizations]-<>[Competitions],[Organizations]-<>[Clubs],[Organizations]-<>[Venues],[Organizations]-<>[Sites],[Organizations]-<>[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:admin_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"}}}}}},"OrganizationsModel":{"type":"object","additionalProperties":false,"properties":{"organizationId":{"description":"The unique identifier of the organization","type":"string","minLength":5,"maxLength":5},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"},"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},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"organization 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":{"/hockey/organizations":{"post":{"tags":["Organizations"],"summary":"Create a new organization","description":"Add a new organization to the system","operationId":"organization_insert","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Organizations 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/OrganizationsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"organizationId":{"description":"The unique identifier of the organization","type":"string","minLength":5,"maxLength":5},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"}},"title":"organization post body","required":["nameLocal","regionType"]}}}}}}}}
```

## Get an organization

> Return detailed information about a specific organization

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Hockey","version":"v1"},"tags":[{"name":"Organizations","description":"The Organization is the top level element in the data structure.  They are the data owner. They are the ones that have provided the data.\n\nAll entities/data in the system belong to **one** organization.\n\n<img src = \"https://yuml.me/diagram/scruffy/class/[Organizations{bg:orange}]-<>[Persons],[Organizations]-.-<>[Leagues],[Organizations]-.-<>[Divisions],[Organizations]-<>[Competitions],[Organizations]-<>[Clubs],[Organizations]-<>[Venues],[Organizations]-<>[Sites],[Organizations]-<>[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"}}}}}},"OrganizationsModel":{"type":"object","additionalProperties":false,"properties":{"organizationId":{"description":"The unique identifier of the organization","type":"string","minLength":5,"maxLength":5},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"},"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},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"organization 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":{"/hockey/organizations/{organizationId}":{"get":{"tags":["Organizations"],"summary":"Get an organization","description":"Return detailed information about a specific organization","operationId":"organization_detail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Organizations 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/OrganizationsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$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 an organization

> Change the information of a specific organization

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Hockey","version":"v1"},"tags":[{"name":"Organizations","description":"The Organization is the top level element in the data structure.  They are the data owner. They are the ones that have provided the data.\n\nAll entities/data in the system belong to **one** organization.\n\n<img src = \"https://yuml.me/diagram/scruffy/class/[Organizations{bg:orange}]-<>[Persons],[Organizations]-.-<>[Leagues],[Organizations]-.-<>[Divisions],[Organizations]-<>[Competitions],[Organizations]-<>[Clubs],[Organizations]-<>[Venues],[Organizations]-<>[Sites],[Organizations]-<>[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:admin_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"}}}}}},"OrganizationsModel":{"type":"object","additionalProperties":false,"properties":{"organizationId":{"description":"The unique identifier of the organization","type":"string","minLength":5,"maxLength":5},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"},"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},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"organization 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":{"/hockey/organizations/{organizationId}":{"put":{"tags":["Organizations"],"summary":"Update an organization","description":"Change the information of a specific organization","operationId":"organization_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Organizations 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/OrganizationsModel"}}}}}}},"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":{"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"}},"title":"organization put body"}}}}}}}}
```

## Delete an organization

> Delete an organization

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Hockey","version":"v1"},"tags":[{"name":"Organizations","description":"The Organization is the top level element in the data structure.  They are the data owner. They are the ones that have provided the data.\n\nAll entities/data in the system belong to **one** organization.\n\n<img src = \"https://yuml.me/diagram/scruffy/class/[Organizations{bg:orange}]-<>[Persons],[Organizations]-.-<>[Leagues],[Organizations]-.-<>[Divisions],[Organizations]-<>[Competitions],[Organizations]-<>[Clubs],[Organizations]-<>[Venues],[Organizations]-<>[Sites],[Organizations]-<>[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:admin_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"}}}}}},"OrganizationsModel":{"type":"object","additionalProperties":false,"properties":{"organizationId":{"description":"The unique identifier of the organization","type":"string","minLength":5,"maxLength":5},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the organization in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":150},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":30,"nullable":true},"nameLatin":{"description":"The name of the organization in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":150,"nullable":true},"countryCode":{"description":"Country code of the organization. We recommend you use ISO-3166-1:alpha3 (upper case) values where available.","type":"string","minLength":3,"maxLength":3,"nullable":true},"regionType":{"description":"How geographically relevant is this organization\n>- `INTERNATIONAL` Multiple countries\n>- `INTERSTATE` Cross state\n>- `LOCAL` Local area\n>- `NATIONAL` One country\n>- `STATE` One state\n","type":"string","enum":["LOCAL","STATE","INTERSTATE","NATIONAL","INTERNATIONAL"]},"defaultLocale":{"description":"The locale of the video","type":"string","minLength":5,"maxLength":5,"pattern":"^[a-z]{2,2}-[A-Z]{2,2}$"},"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},"images":{"type":"array","items":{"$ref":"#/components/schemas/ImagesModel"}}},"title":"organization 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":{"/hockey/organizations/{organizationId}":{"delete":{"tags":["Organizations"],"summary":"Delete an organization","description":"Delete an organization","operationId":"organization_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Organizations 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/OrganizationsModel"}}}}}}},"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"}]}}}}
```
