Skip to content

Instantly share code, notes, and snippets.

@arpan-jain

arpan-jain/liveMatch.schema.md

Last active May 9, 2019 13:40
Show Gist options
  • Save arpan-jain/367e1dea3558918e19fd96dc3a8dbc87 to your computer and use it in GitHub Desktop.
Save arpan-jain/367e1dea3558918e19fd96dc3a8dbc87 to your computer and use it in GitHub Desktop.
Download ZIP
Schema for Live Match Card
Raw
liveMatch.schema.md

Schema

Properties

Property Type Required Nullable Defined by
authRequired enum Required No (this schema)
ctaText enum Required No (this schema)
ctaText2 enum Required No (this schema)
ctaUri string Required No (this schema)
ctaUri2 string Required No (this schema)
data object Required No (this schema)
title enum Required No (this schema)
type enum Required No (this schema)

authRequired

authRequired

  • is required
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

authRequired Known Values

Value Description
false

ctaText

ctaText

  • is required
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

ctaText Known Values

Value Description
View Scorecard

ctaText2

ctaText2

  • is required
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

ctaText2 Known Values

Value Description
View Scorecard

ctaUri

ctaUri

  • is required
  • type: string
  • defined in this schema

ctaUri Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)
  • minimum length: 1 characters

ctaUri2

ctaUri2

  • is required
  • type: string
  • defined in this schema

ctaUri2 Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)
  • minimum length: 1 characters

data

data

  • is required
  • type: object
  • defined in this schema

data Type

object with following properties:

Property Type Required
awayTeamId integer Required
awayTeamImage string Required
awayTeamName string Required
awayTeamShortName string Required
homeTeamId integer Required
homeTeamImage string Required
homeTeamName string Required
homeTeamShortName string Required
innings array Required
matchId integer Required
matchInfo string Required
matchStartTimeUTC string Required
matchStatus string Required
matchSummary string Required
matchTitle string Required
matchType string Required
playerOfMatchId Required
playerOfMatchName Required
playerOfSeriesId Required
playerOfSeriesName Required
tossString string Required
tournamentId integer Required
tournamentName string Required
venueId integer Required
venueName string Required
winningTeamId Required
winningTeamName Required

awayTeamId

awayTeamId

  • is required
  • type: integer
awayTeamId Type

integer

awayTeamImage

awayTeamImage

  • is required
  • type: string
awayTeamImage Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)
  • minimum length: 1 characters

awayTeamName

awayTeamName

  • is required
  • type: string
awayTeamName Type

string

  • minimum length: 1 characters

awayTeamShortName

awayTeamShortName

  • is required
  • type: string
awayTeamShortName Type

string

  • minimum length: 1 characters

homeTeamId

homeTeamId

  • is required
  • type: integer
homeTeamId Type

integer

homeTeamImage

homeTeamImage

  • is required
  • type: string
homeTeamImage Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)
  • minimum length: 1 characters

homeTeamName

homeTeamName

  • is required
  • type: string
homeTeamName Type

string

  • minimum length: 1 characters

homeTeamShortName

homeTeamShortName

  • is required
  • type: string
homeTeamShortName Type

string

  • minimum length: 1 characters

innings

innings

  • is required
  • type: object[]* at least 1 items in the array
innings Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
currentBatsmen array Optional
currentBowler object Optional
currentOver array Optional
inningId integer Required
inningOrder integer Required
isCurrent number Optional
matchId integer Required
teamId integer Required
totalOvers number Required
totalRuns integer Required
totalWickets integer Required

currentBatsmen

currentBatsmen

  • is optional
  • type: object[]* between 0 and 2 items in the array
currentBatsmen Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
ballsFaced integer Required
fours integer Required
nonStrike number Required
onStrike number Required
playerId integer Required
playerName string Required
runs integer Required
sixes integer Required

ballsFaced

ballsFaced

  • is required
  • type: integer
ballsFaced Type

integer

  • minimum value: 0

fours

fours

  • is required
  • type: integer
fours Type

integer

  • minimum value: 0

nonStrike

nonStrike

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

nonStrike Known Values
Value Description
0
1

onStrike

onStrike

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

onStrike Known Values
Value Description
0
1

playerId

playerId

  • is required
  • type: integer
playerId Type

integer

playerName

playerName

  • is required
  • type: string
playerName Type

string

  • minimum length: 1 characters

runs

runs

  • is required
  • type: integer
runs Type

integer

  • minimum value: 0

sixes

sixes

  • is required
  • type: integer
sixes Type

integer

  • minimum value: 0

currentBowler

currentBowler

  • is optional
  • type: object
currentBowler Type

object with following properties:

Property Type Required
oversBowled number Required
playerId integer Required
playerName string Required
runsConceded integer Required
wickets integer Required

oversBowled

oversBowled

  • is required
  • type: number
oversBowled Type

number

  • minimum value: 0
  • must be a multiple of 1

playerId

playerId

  • is required
  • type: integer
playerId Type

integer

playerName

playerName

  • is required
  • type: string
playerName Type

string

  • minimum length: 1 characters

runsConceded

runsConceded

  • is required
  • type: integer
runsConceded Type

integer

  • minimum value: 0

wickets

wickets

  • is required
  • type: integer
wickets Type

integer

  • minimum value: 0

currentOver

currentOver

  • is optional
  • type: object[]* at least 0 items in the array
currentOver Type

Array type: object[]

All items must be of the type: object with following properties:

Property Type Required
battingTeamId integer Required
battingTeamName string Required
bowlerId integer Required
bowlerName string Required
bowlingTeamId integer Required
bowlingTeamName string Required
dismissalTypeId Required
dismissalTypeName Required
fielderId Required
fielderName Required
fieldingActionId Required
fieldingActionName Required
inningOrder integer Required
isBye number Required
isFour number Required
isLegBye number Required
isNoBall number Required
isSix number Required
isWicket number Required
isWide number Required
isfreeHit number Required
matchId integer Required
nonStrikeBatsmanId integer Required
nonStrikeBatsmanName string Required
onStrikeBatsmanId integer Required
onStrikeBatsmanName string Required
over integer Required
overBall integer Required
totalRuns integer Required

battingTeamId

battingTeamId

  • is required
  • type: integer
battingTeamId Type

integer

battingTeamName

battingTeamName

  • is required
  • type: string
battingTeamName Type

string

  • minimum length: 1 characters

bowlerId

bowlerId

  • is required
  • type: integer
bowlerId Type

integer

bowlerName

bowlerName

  • is required
  • type: string
bowlerName Type

string

  • minimum length: 1 characters

bowlingTeamId

bowlingTeamId

  • is required
  • type: integer
bowlingTeamId Type

integer

bowlingTeamName

bowlingTeamName

  • is required
  • type: string
bowlingTeamName Type

string

  • minimum length: 1 characters

dismissalTypeId

dismissalTypeId

  • is required
  • type: complex
dismissalTypeId Type

Any following options needs to be fulfilled.

Option 1

number

Option 2

integer

dismissalTypeName

dismissalTypeName

  • is required
  • type: complex
dismissalTypeName Type

Any following options needs to be fulfilled.

Option 1

string

Option 2

string

  • minimum length: 1 characters

fielderId

fielderId

  • is required
  • type: complex
fielderId Type

Any following options needs to be fulfilled.

Option 1

number

Option 2

integer

fielderName

fielderName

  • is required
  • type: complex
fielderName Type

Any following options needs to be fulfilled.

Option 1

string

Option 2

string

  • minimum length: 1 characters

fieldingActionId

fieldingActionId

  • is required
  • type: complex
fieldingActionId Type

Any following options needs to be fulfilled.

Option 1

number

Option 2

integer

fieldingActionName

fieldingActionName

  • is required
  • type: complex
fieldingActionName Type

Any following options needs to be fulfilled.

Option 1

string

Option 2

string

  • minimum length: 1 characters

inningOrder

inningOrder

  • is required
  • type: integer
inningOrder Type

integer

  • minimum value: 1

isBye

isBye

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isBye Known Values
Value Description
0
1

isFour

isFour

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isFour Known Values
Value Description
0
1

isLegBye

isLegBye

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isLegBye Known Values
Value Description
0
1

isNoBall

isNoBall

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isNoBall Known Values
Value Description
0
1

isSix

isSix

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isSix Known Values
Value Description
0
1

isWicket

isWicket

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isWicket Known Values
Value Description
0
1

isWide

isWide

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isWide Known Values
Value Description
0
1

isfreeHit

isfreeHit

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

isfreeHit Known Values
Value Description
0
1

matchId

matchId

  • is required
  • type: integer
matchId Type

integer

nonStrikeBatsmanId

nonStrikeBatsmanId

  • is required
  • type: integer
nonStrikeBatsmanId Type

integer

nonStrikeBatsmanName

nonStrikeBatsmanName

  • is required
  • type: string
nonStrikeBatsmanName Type

string

  • minimum length: 1 characters

onStrikeBatsmanId

onStrikeBatsmanId

  • is required
  • type: integer
onStrikeBatsmanId Type

integer

onStrikeBatsmanName

onStrikeBatsmanName

  • is required
  • type: string
onStrikeBatsmanName Type

string

  • minimum length: 1 characters

over

over

  • is required
  • type: integer
over Type

integer

  • minimum value: 0

overBall

overBall

  • is required
  • type: integer
overBall Type

integer

totalRuns

totalRuns

  • is required
  • type: integer
totalRuns Type

integer

  • minimum value: 0

inningId

inningId

  • is required
  • type: integer
inningId Type

integer

inningOrder

inningOrder

  • is required
  • type: integer
inningOrder Type

integer

  • minimum value: 1

isCurrent

isCurrent

  • is optional
  • type: enum

The value of this property must be equal to one of the known values below.

isCurrent Known Values
Value Description
0
1

matchId

matchId

  • is required
  • type: integer
matchId Type

integer

teamId

teamId

  • is required
  • type: integer
teamId Type

integer

totalOvers

totalOvers

  • is required
  • type: number
totalOvers Type

number

  • minimum value: 0
  • must be a multiple of 1

totalRuns

totalRuns

  • is required
  • type: integer
totalRuns Type

integer

  • minimum value: 0

totalWickets

totalWickets

  • is required
  • type: integer
totalWickets Type

integer

  • minimum value: 0

matchId

matchId

  • is required
  • type: integer
matchId Type

integer

matchInfo

matchInfo

  • is required
  • type: string
matchInfo Type

string

  • minimum length: 1 characters

matchStartTimeUTC

matchStartTimeUTC

  • is required
  • type: string
matchStartTimeUTC Type

string

matchStatus

matchStatus

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

matchStatus Known Values
Value Description
ENDED

matchSummary

matchSummary

  • is required
  • type: string
matchSummary Type

string

  • minimum length: 1 characters

matchTitle

matchTitle

  • is required
  • type: string
matchTitle Type

string

  • minimum length: 1 characters

matchType

matchType

  • is required
  • type: enum

The value of this property must be equal to one of the known values below.

matchType Known Values
Value Description
ODI
T20
TEST

playerOfMatchId

playerOfMatchId

  • is required
  • type: complex
playerOfMatchId Type

Any following options needs to be fulfilled.

Option 1

number

Option 2

integer

playerOfMatchName

playerOfMatchName

  • is required
  • type: complex
playerOfMatchName Type

Any following options needs to be fulfilled.

Option 1

string

Option 2

string

  • minimum length: 1 characters

playerOfSeriesId

playerOfSeriesId

  • is required
  • type: complex
playerOfSeriesId Type

Any following options needs to be fulfilled.

Option 1

number

Option 2

integer

playerOfSeriesName

playerOfSeriesName

  • is required
  • type: complex
playerOfSeriesName Type

Any following options needs to be fulfilled.

Option 1

string

Option 2

string

  • minimum length: 1 characters

tossString

tossString

  • is required
  • type: string
tossString Type

string

  • minimum length: 1 characters

tournamentId

tournamentId

  • is required
  • type: integer
tournamentId Type

integer

tournamentName

tournamentName

  • is required
  • type: string
tournamentName Type

string

  • minimum length: 1 characters

venueId

venueId

  • is required
  • type: integer
venueId Type

integer

venueName

venueName

  • is required
  • type: string
venueName Type

string

  • minimum length: 1 characters

winningTeamId

winningTeamId

  • is required
  • type: complex
winningTeamId Type

Any following options needs to be fulfilled.

Option 1

number

Option 2

integer

winningTeamName

winningTeamName

  • is required
  • type: complex
winningTeamName Type

Any following options needs to be fulfilled.

Option 1

string

Option 2

string

  • minimum length: 1 characters

title

title

  • is required
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

title Known Values

Value Description
MATCH RESULT

type

type

  • is required
  • type: enum
  • defined in this schema

The value of this property must be equal to one of the known values below.

type Known Values

Value Description
POST_MATCH
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment