Periods

Modified on Wed, 14 Dec 2022 at 09:13 PM

The following examples will depict Periods message structure

XML

   <Period>
      <Incidents null="true" />
      <IsConfirmed>false</IsConfirmed>
      <IsFinished>false</IsFinished>
      <Results>
         <element>
            <Position>1</Position>
            <Value>0</Value>
         </element>
         <element>
            <Position>2</Position>
            <Value>0</Value>
         </element>
      </Results>
      <SequenceNumber>0</SequenceNumber>
      <SubPeriods null="true" />
      <Type>10</Type>
   </Period>

Json

[
  {
    "Type": 10,
    "IsFinished": false,
    "IsConfirmed": false,
    "Results": [
      {
        "Position": "1",
        "Value": "0"
      },
      {
        "Position": "2",
        "Value": "0"
      }
    ],
    "Incidents": null,
    "SubPeriods": null,
    "SequenceNumber": 0
  }
]

Attributes	Data Type	Description
Type	enum	The type of the period
IsFinished	bool	Indicates whether the period is finished or not
IsConfirmed	bool	Indicates whether the period and its scores are confirmed

Note: Delivering the IsFinished as true and the IsConfirmed as false means we couldn't validate the final result of the specific period

Score Model

Source	Data Type	Description
Score	string	The score of a specific participant in a Scoreboard or Period element
Score.Position	int	In 2-participant events, the positions will be 1 (home) or 2 (away) For outright events, the positions will represent the initial position of the participant

Incident Model

Every period element may contain a list of incidents (e.g. goals that were scored). Incidents will appear as long as we have the information.

Note: Incidents may be sent after a final status had been received.

Attributes	Data Type	Description
Period	enum	The type of period, in which the incident had occurred
Seconds	bool	Time of incident occurrence
ParticipantPosition	bool	In 2-participant events, the positions will be 1 (home) or 2 (away) For outright events, the positions will represent the initial position of the participant
PlayerName	string	The name of the player responsible for the incident

For Cricket Only - SubPeriods represent the number of Runs made within the last Over in addition the number of Overs played so far will be shown under SequenceNumber - as can be seen in the following example Here

Note: SequanceNumber is only relevant for Cricket at the moment.