# Match Roster A person can be rostered/selected to a specific match. ## Get the roster for a match > Return a list of persons in the roster for a match ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error. If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"added":{"name":"added","description":"Record was added after this date/time. In UTC.","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"},"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display. The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"limit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":1000,"minimum":1,"default":10},"required":false,"in":"query"},"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":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/roster":{"get":{"tags":["Match Roster"],"summary":"Get the roster for a match","description":"Return a list of persons in the roster for a match","operationId":"fixture_roster_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/added"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"$ref":"#/components/parameters/updated"}]}}}} ``` ## Create/Update a match roster > Depending on the data, Add a new match roster entry or update an existing one ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster 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":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/roster":{"post":{"tags":["Match Roster"],"summary":"Create/Update a match roster","description":"Depending on the data, Add a new match roster entry or update an existing one","operationId":"fixture_roster_insert_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster post body"}}}}}}}} ``` ## Get the roster for a team in a match > Return a list of persons in the roster for a team in a match ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error. If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"added":{"name":"added","description":"Record was added after this date/time. In UTC.","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"},"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display. The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"limit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":1000,"minimum":1,"default":10},"required":false,"in":"query"},"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":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/entities/{entityId}/roster":{"get":{"tags":["Match Roster"],"summary":"Get the roster for a team in a match","description":"Return a list of persons in the roster for a team in a match","operationId":"fixture_roster_list_by_entity","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/added"},{"name":"entityId","description":"The unique identifier of the entity","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"$ref":"#/components/parameters/updated"}]}}}} ``` ## Get the roster information for a person in a match > Return the detailed roster information for a person in a match ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster model"},"ErrorModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error. If there are multiple errors, then this will be the code of the first one.","format":"int32"},"message":{"type":"string","description":"A message indicating the reason for the error. If there are multiple errors, then this is the message for the first one."},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorListModel"}}}},"ErrorListModel":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP Error code indicating the type of error.","format":"int32"},"reason":{"enum":["INVALID_DATA","NOT_FOUND","NOT_AUTHORISED","ERROR","DELETE_ERROR"],"description":"A short code indicating the type of error"},"message":{"type":"string","description":"A message indicating the reason for the error"},"rowNumber":{"type":"integer","description":"The row number of the payload that cause the error","format":"int32"}}}},"responses":{"ErrorResponse":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ResponseMetaData"},"error":{"$ref":"#/components/schemas/ErrorModel"}}}}}}},"parameters":{"external":{"name":"external","description":"A comma separated list of fields that will instead be interpreted as an externalId. See [External Ids](#section/Introduction/External-Ids) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"fields":{"name":"fields","description":"A comma separated list of fields to display. The response will only display these fields. See [Partial Response](#section/Partial-Response) section for more information.","schema":{"type":"string"},"required":false,"in":"query"},"hideNull":{"name":"hideNull","description":"Don't display data fields with null values or empty structures","schema":{"type":"boolean"},"required":false,"in":"query"},"include":{"name":"include","description":"A comma separated list of resource types to include. See [Resource Inclusion](#section/Introduction/Resource-Inclusion) for more information.","schema":{"type":"string"},"required":false,"in":"query"},"limit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":1000,"minimum":1,"default":10},"required":false,"in":"query"},"offset":{"name":"offset","description":"The offset of the records. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32"},"required":false,"in":"query"}}},"paths":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/persons/{personId}/roster":{"get":{"tags":["Match Roster"],"summary":"Get the roster information for a person in a match","description":"Return the detailed roster information for a person in a match","operationId":"fixture_roster_detail","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"name":"personId","description":"The unique identifier of the person","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}]}}}} ``` ## Delete a match roster entry > Delete a specific match roster ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster 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":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/persons/{personId}/roster":{"delete":{"tags":["Match Roster"],"summary":"Delete a match roster entry","description":"Delete a specific match roster","operationId":"fixture_roster_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$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":"personId","description":"The unique identifier of the person","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"}]}}}} ``` ## Create/Update a match roster base route > Depending on the data, Add a new match roster entry or update an existing one, with fixtureId in the payload ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster 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":{"/futsal/o/{organizationId}/fixtures/roster":{"post":{"tags":["Match Roster"],"summary":"Create/Update a match roster base route","description":"Depending on the data, Add a new match roster entry or update an existing one, with fixtureId in the payload","operationId":"fixture_roster_insert_update_base_route","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster post body"}}}}}}}} ``` ## Delete entire match roster > Delete entire match roster ```json {"openapi":"3.0.0","info":{"title":"DataCore API - Futsal","version":"v1"},"tags":[{"name":"Match Roster","description":"A person can be rostered/selected to a specific match.\n\n[Match Roster{bg:orange}],[Match Roster]-<>[Persons]\">\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"}}}}}},"Fixture_RosterModel":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"fixture":{"properties":{"resourceType":{"type":"string","enum":["fixtures"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The match","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 match roster belongs to","type":"object"},"entityId":{"description":"The unique identifier of the team","type":"string","format":"uuid"},"entity":{"properties":{"resourceType":{"type":"string","enum":["entities"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The team information","type":"object"},"personId":{"description":"The unique identifier of the person","type":"string","format":"uuid"},"person":{"properties":{"resourceType":{"type":"string","enum":["persons"]},"id":{"description":"Unique identifier for this resource","type":"string"}},"description":"The person information","type":"object"},"bib":{"description":"The number displayed on the jersey","type":"string","maxLength":30,"nullable":true},"position":{"description":"Playing position","type":"string","maxLength":100,"nullable":true},"starter":{"description":"Did person start the match on the court","type":"boolean"},"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":"match roster 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":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/persons/roster":{"delete":{"tags":["Match Roster"],"summary":"Delete entire match roster","description":"Delete entire match roster","operationId":"fixture_roster_delete_all","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Roster 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/Fixture_RosterModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"$ref":"#/components/parameters/fields"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$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"}]}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.sportradar.com/datacore/sports-apis/futsal/datacore-api-v1/match-roster.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.