# Match PLAY BY PLAY

A match involves a number of events. These events aggregate to form a play-by-play. The play-by-play assigned to a match are controlled by these calls.

## Get a list play-by-play records for a match

> Return a list of play-by-play records for a match

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\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_Pbp_EventModel":{"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 Fixture PBP Event belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","type":"string","format":"uuid"},"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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event 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"},"fromTimestamp":{"name":"fromTimestamp","description":"Where the date/time (UTC) this play-by-play event was sent >= this value","schema":{"type":"string","format":"date-time"},"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"},"pbplimit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":2000,"minimum":1,"default":1000},"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"},"periodId":{"name":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":false,"in":"query"},"toTimestamp":{"name":"toTimestamp","description":"Where the date/time (UTC) this play-by-play event was sent <= this value","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"}}},"paths":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/playbyplay":{"get":{"tags":["Match PLAY-BY-PLAY"],"summary":"Get a list play-by-play records for a match","description":"Return a list of play-by-play records for a match","operationId":"fixture_pbp_list","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp_Event 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_Pbp_EventModel"}}}}}}},"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/fromTimestamp"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/pbplimit"},{"$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/periodId"},{"$ref":"#/components/parameters/toTimestamp"}]}}}}
```

## Delete all play-by-play records for a match

> Delete all play-by-play records for a match

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\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_PbpModel":{"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 fixture_pbp belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{"title":"Event details","description":"Event details","type":"object","nullable":true,"properties":{}},"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":"fixture_pbp 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}/playbyplay":{"delete":{"tags":["Match PLAY-BY-PLAY"],"summary":"Delete all play-by-play records for a match","description":"Delete all play-by-play records for a match","operationId":"fixture_pbp_all_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp 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_PbpModel"}}}}}}},"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"}]}}}}
```

## Get a list of live play-by-play records for a match

> \
> &#x20;   Return a list of live play-by-play records for a match. This call will return records of matches\
> &#x20;   still in-progress if available.  If the match is complete this call operates the same as the non 'live'\
> &#x20;   route.\
> \
> &#x20;   Rate limited to 2 requests every minute - returns HTTP 429 Too Many Requests if called more often.\
> &#x20;  &#x20;

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\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_live"]}],"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_Pbp_EventModel":{"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 Fixture PBP Event belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","type":"string","format":"uuid"},"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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event 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"},"fromTimestamp":{"name":"fromTimestamp","description":"Where the date/time (UTC) this play-by-play event was sent >= this value","schema":{"type":"string","format":"date-time"},"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"},"pbplimit":{"name":"limit","description":"The maximum number of records to return. See [Pagination](#section/Introduction/Pagination) for more information.","schema":{"type":"integer","format":"int32","maximum":2000,"minimum":1,"default":1000},"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"},"periodId":{"name":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":false,"in":"query"},"toTimestamp":{"name":"toTimestamp","description":"Where the date/time (UTC) this play-by-play event was sent <= this value","schema":{"type":"string","format":"date-time"},"required":false,"in":"query"}}},"paths":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/playbyplay/live":{"get":{"tags":["Match PLAY-BY-PLAY"],"summary":"Get a list of live play-by-play records for a match","description":"\n    Return a list of live play-by-play records for a match. This call will return records of matches\n    still in-progress if available.  If the match is complete this call operates the same as the non 'live'\n    route.\n\n    Rate limited to 2 requests every minute - returns HTTP 429 Too Many Requests if called more often.\n    ","operationId":"fixture_pbp_list_live","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp_Event 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_Pbp_EventModel"}}}}}}},"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/fromTimestamp"},{"$ref":"#/components/parameters/hideNull"},{"$ref":"#/components/parameters/include"},{"$ref":"#/components/parameters/pbplimit"},{"$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/periodId"},{"$ref":"#/components/parameters/toTimestamp"}]}}}}
```

## Get a full list of match events, suitable for subsequent import.

> Includes play-by-play and setup events for a match

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\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:admin"]}],"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"}}}}}},"SuccessModel":{"type":"object","additionalProperties":false,"properties":{"success":{"description":"Was the call a success?","type":"boolean"}},"title":" 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"},"onlySetup":{"name":"onlySetup","description":"Include only setup events when exporting?","schema":{"type":"boolean"},"required":false,"in":"query"},"periodId":{"name":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":false,"in":"query"},"withScores":{"name":"withScores","description":"Include scores in exported events?","schema":{"type":"boolean"},"required":false,"in":"query"}}},"paths":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/events/export":{"get":{"tags":["Match PLAY-BY-PLAY"],"summary":"Get a full list of match events, suitable for subsequent import.","description":"Includes play-by-play and setup events for a match","operationId":"fixture_pbp_export","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Success 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/SuccessModel"}}}}}}},"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"},{"$ref":"#/components/parameters/onlySetup"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"$ref":"#/components/parameters/periodId"},{"$ref":"#/components/parameters/withScores"}]}}}}
```

## Add or Update historical play-by-play records for a match

> \
> &#x20;   Depending on primary keys, Add a match play-by-play or update an existing record.  This call operates\
> &#x20;   in bulk for all events in a specific period. \<b>Note:\</b>This call should only be used to import historical data.\
> &#x20;   Changes to current/live data show be peformed only via your live capture software.  If this call is used data may\
> &#x20;   become invalid as statistics/actions may not be recalculated.\
> &#x20;  &#x20;

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:admin"]}],"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"}}}}}},"SuccessModel":{"type":"object","additionalProperties":false,"properties":{"success":{"description":"Was the call a success?","type":"boolean"}},"title":" 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}/events/import":{"post":{"tags":["Match PLAY-BY-PLAY"],"summary":"Add or Update historical play-by-play records for a match","description":"\n    Depending on primary keys, Add a match play-by-play or update an existing record.  This call operates\n    in bulk for all events in a specific period. <b>Note:</b>This call should only be used to import historical data.\n    Changes to current/live data show be peformed only via your live capture software.  If this call is used data may\n    become invalid as statistics/actions may not be recalculated.\n    ","operationId":"fixture_pbp_events_import","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Success 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/SuccessModel"}}}}}}},"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"}]}}}}
```

## Add an individual a match play-by-play event

> Add a specific period play-by-play from a match event

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:admin"]}],"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_Pbp_EventModel":{"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 Fixture PBP Event belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","type":"string","format":"uuid"},"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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event 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"}}},"paths":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/periods/{periodId}/playbyplay":{"post":{"tags":["Match PLAY-BY-PLAY"],"summary":"Add an individual a match play-by-play event","description":"Add a specific period play-by-play from a match event","operationId":"fixture_pbp_event_add","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp_Event 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_Pbp_EventModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"$ref":"#/components/parameters/external"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"name":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":true,"in":"path"},{"name":"section","description":"The section of the period (sub-period)","schema":{"type":"string","maxLength":100},"required":false,"in":"query"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"fixtureId":{"description":"The unique identifier of the match","type":"string","format":"uuid"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event post body"}}}}}}}}
```

## Delete a match play-by-play

> Delete a specific period play-by-play from a match

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\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_PbpModel":{"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 fixture_pbp belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{"title":"Event details","description":"Event details","type":"object","nullable":true,"properties":{}},"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":"fixture_pbp 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}/periods/{periodId}/playbyplay":{"delete":{"tags":["Match PLAY-BY-PLAY"],"summary":"Delete a match play-by-play","description":"Delete a specific period play-by-play from a match","operationId":"fixture_pbp_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp 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_PbpModel"}}}}}}},"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":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":true,"in":"path"},{"name":"section","description":"The section of the period (sub-period)","schema":{"type":"string","maxLength":100},"required":false,"in":"query"}]}}}}
```

## Update an individual a match play-by-play event

> Update a specific period play-by-play from a match event

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:admin"]}],"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_Pbp_EventModel":{"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 Fixture PBP Event belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","type":"string","format":"uuid"},"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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event 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"}}},"paths":{"/futsal/o/{organizationId}/fixtures/{fixtureId}/periods/{periodId}/playbyplay/{eventId}":{"put":{"tags":["Match PLAY-BY-PLAY"],"summary":"Update an individual a match play-by-play event","description":"Update a specific period play-by-play from a match event","operationId":"fixture_pbp_event_update","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp_Event 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_Pbp_EventModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"name":"eventId","description":"The unique identifier of an event in a match","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"$ref":"#/components/parameters/external"},{"name":"fixtureId","description":"The unique identifier of the fixture","schema":{"type":"string","format":"uuid"},"required":true,"in":"path"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"name":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":true,"in":"path"},{"name":"section","description":"The section of the period (sub-period)","schema":{"type":"string","maxLength":100},"required":false,"in":"query"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event put body"}}}}}}}}
```

## Delete a match play-by-play event

> Delete a specific period play-by-play from a match event

```json
{"openapi":"3.0.0","info":{"title":"DataCore API  - Futsal","version":"v1"},"tags":[{"name":"Match PLAY-BY-PLAY","description":"A match involves a number of events. These events aggregate to form a play-by-play.  The play-by-play assigned to a match are controlled by these calls.\n"}],"servers":[{"url":"https://api.dc.connect.sportradar.com/v1","description":"Production server"},{"url":"https://api.dc.stg.connect-nonprod.sportradar.dev/v1","description":"NonProduction/Staging server"}],"security":[{"OAuth2":["write:admin"]}],"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_Pbp_EventModel":{"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 Fixture PBP Event belongs to","type":"object"},"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"},"periodId":{"description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"section":{"description":"The section of the period (sub-period)","type":"string","maxLength":100},"events":{},"class":{"description":"The class of the event\n>- `clock` Information about the current status of the clock match\n>- `sport` A sporting action that relates to the running of the match\n","type":"string","enum":["sport","clock"],"maxLength":100,"default":"sport"},"eventType":{"description":"See [Event Types](http://developer.connect.sportradar.com/datacore/streaming.html#section/Message-Types/event) for more information","type":"string","maxLength":100},"eventId":{"description":"Unique identifier of this event","type":"string","format":"uuid"},"playId":{"description":"Unique identifier of this play (group of events)","type":"string","format":"uuid"},"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"},"subType":{"description":"The Sub Type of event. See <b>Streaming API</b> documenation for more information.","type":"string","maxLength":100},"options":{},"received":{"description":"The UNIX timestamp when the event was received.","type":"integer","format":"int32"},"status":{"description":"The status of this message.  Options are `added` (Default); `updated` - meaning the content of this event has been edited; `deleted` - meaning this event has been deleted; `enriched` - meaning further information has been added to the event (not changed).","type":"string"},"success":{"description":"Whether the action was successful","type":"boolean"},"x":{"description":"The x co-ordinate of the event. Represented as percentage from left (0) to right (100).","type":"number","format":"float"},"y":{"description":"The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).","type":"number","format":"float"},"z":{"description":"The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).","type":"number","format":"float"},"clock":{"description":"The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS","type":"string"},"shotClock":{"description":"The time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS","type":"string"},"eventTime":{"description":"The date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.","type":"string","format":"date-time"},"officialId":{"description":"The unique ID of the official making this decision","type":"string","format":"uuid"},"zone":{"description":"See [Event Types]() for more information","type":"string","maxLength":50},"scores":{"title":"Current scores","description":"The current scores","type":"object","nullable":true,"additionalProperties":{"description":"The current score of the entity (given by the key).  For insertions this should still be the current (maximum) score (not the score at the time of event being inserted)","type":"string","maxLength":50}},"timestamp":{"description":"The date/time (UTC) this event was sent.","type":"string","format":"date-time"},"clientType":{"description":"Type of the client that sent the event","type":"string","maxLength":200},"clientId":{"description":"ID of the client that sent the event","type":"string","maxLength":200},"sport":{"description":"Sport one letter code","type":"string","maxLength":1},"topic":{"description":"MQTT topic where the event was sent","type":"string","maxLength":200},"type":{"description":"Type of the event message","type":"string","maxLength":100},"sequence":{"description":"Client event sequence number","type":"integer","format":"int32","nullable":true}},"title":"Fixture PBP Event 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}/periods/{periodId}/playbyplay/{eventId}":{"delete":{"tags":["Match PLAY-BY-PLAY"],"summary":"Delete a match play-by-play event","description":"Delete a specific period play-by-play from a match event","operationId":"fixture_pbp_event_delete","responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","title":"Fixture_Pbp_Event 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_Pbp_EventModel"}}}}}}},"default":{"$ref":"#/components/responses/ErrorResponse"}},"parameters":[{"name":"eventId","description":"The unique identifier of an event in a match","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"},{"name":"organizationId","description":"The unique identifier of the organization","schema":{"type":"string","minLength":5,"maxLength":5},"required":true,"in":"path"},{"name":"periodId","description":"The identifier for the period\n>- None Total match\n>- `1` Period 1\n>- `2` Period 2\n>- `3` Period 3\n>- `4` Period 4\n>- `10` Extra time 1\n>- `11` Extra time 2\n>- `20` Penalty shoot out\n","schema":{"type":"integer","format":"int32","enum":[0,1,2,3,4,10,11,20]},"required":true,"in":"path"},{"name":"section","description":"The section of the period (sub-period)","schema":{"type":"string","maxLength":100},"required":false,"in":"query"}]}}}}
```