Scorecard 

My card data

 

You can share your data after all data is completed on the card including all league references, actual scores equals expected scores and both the home and away team captains have approved the card via touch ID or simple approval at which time the save button denoted by the floppy disk image transforms into a share button denoted by the upink image. Clicking on the share button, opens up the activity sheet where you can use either Mail or Save to Dropbox depending on setup.

 

The proceeding documentation details what is contained within the app data for further processing.

 

The root object

 

The root object is an array containing one object with the card property. Succeeding objects will not be processed by the app. The card object has the following mandatory properties: cardType, originalId, leagueName, division, date, homeTeam, awayTeam and matchEntries.  The cardType specifiies the different disciplines played in the match card. These include (0) open, (1) round robin and (2) three discipline. The originalId is the original native key of the match card. It is possible that the match card has been exported several times from different devices and therefore an originalId necessitates to identify the original record. The leagueName corresponds to the associated league to which the match card belongs. It is used to identify the actual league loaded within the app. Error code 110 is thrown if the league is not found. The publicLeagueId relates to the imported leagues.publicId in the league data import. The division is the associated division of the match. The date is when the match card was created. The homeScore is the total score in the card for the home team. The awayScore is the total score in the card for the away team. The matchEntries contains the match entries of the card. See section the match entry for details of each entry within the match entries list. The awayTeam is a single object that represents the away team. The homeTeam is a single object that represents the home team.

 

On both awayTeam and homeTeam, the players list contains the active players playing within the match. See section the active player for more details of each player within the players list on a specific team. The publicId relates to the imported clubs.teams.publicId in the league data import. The name relates to the imported clubs.teams.name in the league data import. The name is used to query and match the existing team during card import. Error code 121 is thrown if the team name is not found. The approvedOn is the original date and time when the team captain approved the card.

 

[  
   {  
      "card":{  
         "cardType":1,

         "originalId":"4717EC56-0634-46E9-993D-52298D1097CC",
         "leagueName":"Badders Wonderful League",

         "publicLeagueId":"101",

         "division":4,
         "date":"26-Oct-2015 2:03 pm",

         "homeScore":5,

         "awayScore":4,

         "matchEntries":[ ... ],
         "awayTeam":{  
            "players":[ ... ],
            "publicId":"1",
            "name":"Feathers-A",

            "approvedOn":"26-Oct-2015 2:09 pm"
         },
         "homeTeam":{  
            "players":[ ... ],
            "publicId":"1",
            "name":"Drops-A",

            "approvedOn":"26-Oct-2015 2:08 pm",
         }
      }
   }
]

 

The active player

 

The active player within the players list within a team (home team or away team) represents the actual player playing in a match. The mandatory properties are key, name and publicId. The key represents the position a player is assigned. Different card types consists of different sets of key positions. See section card types for more details. The name relates to the imported players.name in the league data import.

 

The publicId relates to the imported players.publicId in the league data import. The publicId is used to query and match the existing player during card import. Error code 120 is thrown if the player is not found. The registrationDate is populated if the active player is registered using the app and the date when the player was assigned to the match card (drag and drop) is the same date as the registration date when the player was created. During card import if the publicId did not find a player and the registrationDate is populated, then the record is considered as newly registered and must be saved along with the other players. 

 

The isReserved flag means that the associated player is reserve. A reserve player means that the player can play for any team at any time. This means that the player exists in the clubs.players list of the league structure. A non-reserve player means that the player only plays for the specific team. This means that the player exists in the clubs.teams.players of the league structure.

 

The optional phone number is the newly registered player's phone number as entered from the player registration screen. The optional email is the newly registered player's email as entered from the player registration screen.

 

{  
   "key":"B3",

   "name":"Paper",

   "publicId":"98E7470F-7DF7-4B87-942D-3DA37E83B2B6",

   "registrationDate":"26-Oct-2015 12:46 am",   

   "isReserved":true,
   "phone":"",
   "email":""
}

 

The match entry

 

Match entry record contains the aggregated score information about a match for a specific pair of active player from the home and away teams. The mandatory properties are index and gameEntries. Error code 130 is thrown if index and gameEntries are missing. The index is the sort order of a match entry in the matchEntries list. The homeKeys transforms to the player key position within the home team aka homeTeam.players.key. As with the player keys, the homeKeys maps to specific card types. See section card types for more details. The awayKeys transforms to the player key position within the away team aka awayTeam.players.key. As with the player keys, the awayKeys maps to specific card types. See section card types for more details. The homeScore is the aggregated total score within the match for the home team. The awayScore is the aggregated total score within the match for the away team. The gameEntries lists detailed game and score information. See section the game entry for details of each game entry within the game entries list.

 

{  

   "index":2,
   "homeKeys":"A",
   "awayKeys":"B",
   "homeScore":1,
   "awayScore":0,

   "gameEntries":[  ...  ]
}

 

The game entry

 

Game entry record contains the detailed score information about a game for a specific pair of active player from the home and away teams. The mandatory properties are index, homeKeys, awayKeys, homeScore and awayScore. The index is the sort order of a game entry in the gameEntries list. The homeKeys transforms to the player key position within the home team aka homeTeam.players.key. As with the player keys, the homeKeys maps to specific card types. See section card types for more details. The awayKeys transforms to the player key position within the away team aka awayTeam.players.key. As with the player keys, the awayKeys maps to specific card types. See section card types for more details. The homeScore is the score for the home team. The awayScore is the score for the away team. The homeIncident is an incident occured with the home pair. The awayIncident is an incident occured with the away pair. An incident is a non-scorable representation of an event that occured during a game in a match. The incidents are disqualified, retired and walkover. They have numeric equivalents when the scores are computed in the match level. The walkover translated into a win whilst disqualified and retired translates into a lose.

 

{  

   "index":18,
   "homeKeys":"XD-B",
   "awayKeys":"XD-C",
   "homeScore":0,
   "awayScore":0,

   "homeIncident":"W"
}

 

Table of properties

 

The table below shows the discussion above in tabular form. If the table below does not load please follow this link.