# Stages, Pools & Rounds **Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season. A stage is optional, but must be created if the matches `stageCode` field is utilized. **Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage. A pool is optional, but must be created if the matches `poolCode` field is utilized. A pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information. **Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage. A round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round. ![](https://yuml.me/diagram/scruffy;dir:LR/class/\[Seasons]-.-%3E\[Rounds],\[Seasons]-.-%3E\[Pools],\[Seasons]-.-%3E\[Stages],\[Stages%7Bbg:orange%7D]-.-%3E\[Pools],\[Pools%7Bbg:orange%7D]-.-%3E\[Rounds%7Bbg:orange%7D],\[Stages%7Bbg:orange%7D]-.-%3E\[Rounds],) How they link to a match: ![](https://yuml.me/diagram/scruffy;dir:LR/class/\[Stages%7Bbg:orange%7D]-.-%3E\[Matches],\[Pools%7Bbg:orange%7D]-.-%3E\[Matches],\[Rounds%7Bbg:orange%7D]-.-%3E\[Matches],) ## Get a list of stages > Return a list of stages for a season ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_StagesModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 season stage belongs to","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30},"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage 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"},"includeTotalCount":{"name":"includeTotalCount","description":"Include the total number of records matching the filters.","schema":{"type":"boolean"},"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"},"nameLatinContains":{"name":"nameLatinContains","description":"Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLatin=David Johnson nameLatinContains=Dav will match nameLatinContains=John will match nameLatinContains=son will not match","schema":{"type":"string","minLength":2,"maxLength":50},"required":false,"in":"query"},"nameLocalContains":{"name":"nameLocalContains","description":"Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLocal=David Johnson nameLocalContains=Dav will match nameLocalContains=John will match nameLocalContains=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"},"updated":{"name":"updated","description":"Record was modified after this date/time. In UTC.","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"}}},"paths":{"/football/o/{organizationId}/seasons/{seasonId}/stages":{"get":{"tags":["Stages, Pools & Rounds"],"summary":"Get a list of stages","description":"Return a list of stages for a season","operationId":"season_stage_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Stages 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/Season_StagesModel"}}}}}}},"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/includeTotalCount"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/nameLatinContains"},{"$ref":"#/components/parameters/nameLocalContains"},{"$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":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"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":"^(\\-?nameLocal|\\-?nameLatin|,)*$"},"required":false,"in":"query"},{"$ref":"#/components/parameters/updated"}]}}}} ``` ## Create a stage > Add a new stage in a season ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_StagesModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 season stage belongs to","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30},"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage 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":{"/football/o/{organizationId}/seasons/{seasonId}/stages":{"post":{"tags":["Stages, Pools & Rounds"],"summary":"Create a stage","description":"Add a new stage in a season","operationId":"season_stage_insert","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Stages 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/Season_StagesModel"}}}}}}},"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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30},"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage post body","required":["seasonId","stageCode"]}}}}}}}} ``` ## Get a stage > Return detailed information about a specific stage ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_StagesModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 season stage belongs to","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30},"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage 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"},"includeTotalCount":{"name":"includeTotalCount","description":"Include the total number of records matching the filters.","schema":{"type":"boolean"},"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":{"/football/o/{organizationId}/seasons/{seasonId}/stages/{stageCode}":{"get":{"tags":["Stages, Pools & Rounds"],"summary":"Get a stage","description":"Return detailed information about a specific stage","operationId":"season_stage_detail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Stages 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/Season_StagesModel"}}}}}}},"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/includeTotalCount"},{"$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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"name":"stageCode","description":"The stage identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"}]}}}} ``` ## Update a stage > Change the information of a specific stage ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_StagesModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 season stage belongs to","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30},"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage 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":{"/football/o/{organizationId}/seasons/{seasonId}/stages/{stageCode}":{"put":{"tags":["Stages, Pools & Rounds"],"summary":"Update a stage","description":"Change the information of a specific stage","operationId":"season_stage_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Stages 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/Season_StagesModel"}}}}}}},"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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"name":"stageCode","description":"The stage identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage put body"}}}}}}}} ``` ## Delete a stage > Delete a specific stage ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_StagesModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 season stage belongs to","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30},"nameLocal":{"description":"The name of the season stage in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the season stage in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"stageOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maxLength":3,"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}},"title":"season stage 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":{"/football/o/{organizationId}/seasons/{seasonId}/stages/{stageCode}":{"delete":{"tags":["Stages, Pools & Rounds"],"summary":"Delete a stage","description":"Delete a specific stage","operationId":"season_stages_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Stages 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/Season_StagesModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"name":"stageCode","description":"The stage identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"}]}}}} ``` ## Get a list of pools > Return a list of the pools for a season ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_PoolsModel":{"type":"object","additionalProperties":false,"properties":{"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 pool belongs to","type":"object"},"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool 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"},"includeTotalCount":{"name":"includeTotalCount","description":"Include the total number of records matching the filters.","schema":{"type":"boolean"},"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"},"nameLatinContains":{"name":"nameLatinContains","description":"Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLatin=David Johnson nameLatinContains=Dav will match nameLatinContains=John will match nameLatinContains=son will not match","schema":{"type":"string","minLength":2,"maxLength":50},"required":false,"in":"query"},"nameLocalContains":{"name":"nameLocalContains","description":"Fields that allow a 'Contains' query string parameter search for words separated by a space, matching characters left to right. Example: nameLocal=David Johnson nameLocalContains=Dav will match nameLocalContains=John will match nameLocalContains=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"},"stageCode":{"name":"stageCode","description":"The stage identifier within a season","schema":{"type":"string","maxLength":30},"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":{"/football/o/{organizationId}/seasons/{seasonId}/pools":{"get":{"tags":["Stages, Pools & Rounds"],"summary":"Get a list of pools","description":"Return a list of the pools for a season","operationId":"season_pool_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Pools 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/Season_PoolsModel"}}}}}}},"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/includeTotalCount"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/nameLatinContains"},{"$ref":"#/components/parameters/nameLocalContains"},{"$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":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"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":"^(\\-?nameLocal|\\-?nameLatin|,)*$"},"required":false,"in":"query"},{"$ref":"#/components/parameters/stageCode"},{"$ref":"#/components/parameters/updated"}]}}}} ``` ## Create a pool > Add a new pool into a season ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_PoolsModel":{"type":"object","additionalProperties":false,"properties":{"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 pool belongs to","type":"object"},"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool 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":{"/football/o/{organizationId}/seasons/{seasonId}/pools":{"post":{"tags":["Stages, Pools & Rounds"],"summary":"Create a pool","description":"Add a new pool into a season","operationId":"season_pool_insert","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Pools 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/Season_PoolsModel"}}}}}}},"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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool post body","required":["seasonId","poolCode"]}}}}}}}} ``` ## Get a pool > Return detailed information about a specific pool ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_PoolsModel":{"type":"object","additionalProperties":false,"properties":{"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 pool belongs to","type":"object"},"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool 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"},"includeTotalCount":{"name":"includeTotalCount","description":"Include the total number of records matching the filters.","schema":{"type":"boolean"},"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":{"/football/o/{organizationId}/seasons/{seasonId}/pools/{poolCode}":{"get":{"tags":["Stages, Pools & Rounds"],"summary":"Get a pool","description":"Return detailed information about a specific pool","operationId":"season_pool_detail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Pools 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/Season_PoolsModel"}}}}}}},"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/includeTotalCount"},{"$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"},{"name":"poolCode","description":"The pool identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}]}}}} ``` ## Update a pool > Change the information of a specific pool ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_PoolsModel":{"type":"object","additionalProperties":false,"properties":{"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 pool belongs to","type":"object"},"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool 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":{"/football/o/{organizationId}/seasons/{seasonId}/pools/{poolCode}":{"put":{"tags":["Stages, Pools & Rounds"],"summary":"Update a pool","description":"Change the information of a specific pool","operationId":"season_pool_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Pools 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/Season_PoolsModel"}}}}}}},"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"},{"name":"poolCode","description":"The pool identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool put body"}}}}}}}} ``` ## Delete a pool > Delete a specific pool ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_PoolsModel":{"type":"object","additionalProperties":false,"properties":{"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 pool belongs to","type":"object"},"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"nameLocal":{"description":"The name of the pool in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"nameLatin":{"description":"The name of the pool in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"poolOrder":{"description":"User defined sort order of the ~pool~","type":"integer","format":"int32","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}},"title":"pool 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":{"/football/o/{organizationId}/seasons/{seasonId}/pools/{poolCode}":{"delete":{"tags":["Stages, Pools & Rounds"],"summary":"Delete a pool","description":"Delete a specific pool","operationId":"season_pools_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Pools 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/Season_PoolsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$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"},{"name":"poolCode","description":"The pool identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}]}}}} ``` ## Get a list of rounds > Return a list of rounds in a season ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_RoundsModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 round belongs to","type":"object"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"pool":{"properties":{"resourceType":{"type":"string","enum":["seasonPools"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The pool that is related to this record","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round 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"},"includeTotalCount":{"name":"includeTotalCount","description":"Include the total number of records matching the filters.","schema":{"type":"boolean"},"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"},"poolCode":{"name":"poolCode","description":"The pool identifier within a season","schema":{"type":"string","maxLength":30},"required":false,"in":"query"},"stageCode":{"name":"stageCode","description":"The stage identifier within a season","schema":{"type":"string","maxLength":30},"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":{"/football/o/{organizationId}/seasons/{seasonId}/rounds":{"get":{"tags":["Stages, Pools & Rounds"],"summary":"Get a list of rounds","description":"Return a list of rounds in a season","operationId":"season_round_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Rounds 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/Season_RoundsModel"}}}}}}},"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/includeTotalCount"},{"$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"},{"$ref":"#/components/parameters/poolCode"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/stageCode"},{"$ref":"#/components/parameters/updated"}]}}}} ``` ## Create a round > Add a new round in a season ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_RoundsModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 round belongs to","type":"object"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"pool":{"properties":{"resourceType":{"type":"string","enum":["seasonPools"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The pool that is related to this record","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round 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":{"/football/o/{organizationId}/seasons/{seasonId}/rounds":{"post":{"tags":["Stages, Pools & Rounds"],"summary":"Create a round","description":"Add a new round in a season","operationId":"season_round_insert","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Rounds 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/Season_RoundsModel"}}}}}}},"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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round post body","required":["seasonId","roundCode"]}}}}}}}} ``` ## Get a round > Return detailed information about a specific round ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_RoundsModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 round belongs to","type":"object"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"pool":{"properties":{"resourceType":{"type":"string","enum":["seasonPools"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The pool that is related to this record","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round 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"},"includeTotalCount":{"name":"includeTotalCount","description":"Include the total number of records matching the filters.","schema":{"type":"boolean"},"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":{"/football/o/{organizationId}/seasons/{seasonId}/rounds/{roundCode}":{"get":{"tags":["Stages, Pools & Rounds"],"summary":"Get a round","description":"Return detailed information about a specific round","operationId":"season_round_detail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Rounds 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/Season_RoundsModel"}}}}}}},"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/includeTotalCount"},{"$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"},{"name":"roundCode","description":"The round identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}]}}}} ``` ## Update a round > Change the information of a specific round ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_RoundsModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 round belongs to","type":"object"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"pool":{"properties":{"resourceType":{"type":"string","enum":["seasonPools"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The pool that is related to this record","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round 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":{"/football/o/{organizationId}/seasons/{seasonId}/rounds/{roundCode}":{"put":{"tags":["Stages, Pools & Rounds"],"summary":"Update a round","description":"Change the information of a specific round","operationId":"season_round_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Rounds 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/Season_RoundsModel"}}}}}}},"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"},{"name":"roundCode","description":"The round identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round put body"}}}}}}}} ``` ## Delete a round > Delete a specific round ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_RoundsModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 round belongs to","type":"object"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"pool":{"properties":{"resourceType":{"type":"string","enum":["seasonPools"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The pool that is related to this record","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round 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":{"/football/o/{organizationId}/seasons/{seasonId}/rounds/{roundCode}":{"delete":{"tags":["Stages, Pools & Rounds"],"summary":"Delete a round","description":"Delete a specific round","operationId":"season_rounds_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Rounds 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/Season_RoundsModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$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"},{"name":"roundCode","description":"The round identifier within a season","schema":{"type":"string","maxLength":30},"required":true,"in":"path"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}]}}}} ``` ## Create or Update a round > Depending on primary keys, insert a new round or update an existing one ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Football","version":"v1"},"tags":[{"name":"Stages, Pools & Rounds","description":"**Stages** are a collection of pools, rounds or matches. A stage can form a group of teams and matches within a season.\n\nA stage is optional, but must be created if the matches `stageCode` field is utilized.\n\n**Pools** are a collection of rounds or matches. A pool can form a group of teams and matches within a season and optionally within a stage.\nA pool is optional, but must be created if the matches `poolCode` field is utilized.\n\nA pool can be defined in a match without defining it here. In that case the only information about the pool will be it's code. We recommend that all pools are added here as well to give well rounded information.\n\n**Rounds** are a collection of matches generally over a day or series of days. A round can optionally be contained within a pool and/or a stage.\nA round is optional, but must be created if the matches `roundCode` field is utilized. The simplier matches `roundNumber` can be utilized without defining as a round.\n\n[Rounds],[Seasons]-.->[Pools],[Seasons]-.->[Stages],[Stages{bg:orange}]-.->[Pools],[Pools{bg:orange}]-.->[Rounds{bg:orange}],[Stages{bg:orange}]-.->[Rounds],\">\n\nHow they link to a match:\n\n[Matches],[Pools{bg:orange}]-.->[Matches],[Rounds{bg:orange}]-.->[Matches],\">\n\n\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"}}}}}},"Season_RoundsModel":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"season":{"properties":{"resourceType":{"type":"string","enum":["seasons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The season linked to this record","type":"object"},"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 round belongs to","type":"object"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"pool":{"properties":{"resourceType":{"type":"string","enum":["seasonPools"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The pool that is related to this record","type":"object"},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stage":{"properties":{"resourceType":{"type":"string","enum":["seasonStages"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The stage that is related to this record","type":"object"},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round 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":{"/football/o/{organizationId}/seasons/{seasonId}/rounds/force":{"post":{"tags":["Stages, Pools & Rounds"],"summary":"Create or Update a round","description":"Depending on primary keys, insert a new round or update an existing one","operationId":"season_round_insert_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Season_Rounds 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/Season_RoundsModel"}}}}}}},"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"},{"name":"seasonId","description":"The unique identifier of the season","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"seasonId":{"description":"The unique identifier of the season","type":"string","format":"uuid"},"roundCode":{"description":"A unique code for the round. (Unique for season)","type":"string","maxLength":30},"poolCode":{"description":"A unique code for the pool. (Unique for season)","type":"string","maxLength":30,"nullable":true},"stageCode":{"description":"A unique code for the stage. (Unique for season)","type":"string","maxLength":30,"nullable":true},"roundNumber":{"description":"The number given to the round","type":"string","maxLength":30,"nullable":true},"nameLocal":{"description":"The name of the round in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":100,"nullable":true},"nameLatin":{"description":"The name of the round in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":100,"nullable":true},"abbreviationLocal":{"description":"An abbreviation/short name in the [local](#section/Introduction/Character-Sets-and-Names) language","type":"string","maxLength":10,"nullable":true},"abbreviationLatin":{"description":"An abbreviation/short name in [latin](#section/Introduction/Character-Sets-and-Names) characters","type":"string","maxLength":10,"nullable":true},"roundOrder":{"description":"User defined sort order of the stage","type":"integer","format":"int32","maximum":999,"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}},"title":"round post body","required":["seasonId","roundCode"]}}}}}}}} ```