Get Score History

<< Click to Display Table of Contents >>

Navigation:  Support > REST API > Athlete API Calls >

Get Score History

Description

Returns all public scores shot, by the passed in athletes for the passed in date range, for the passed in Event Styles or Stage Styles. Athletes are identified by there user-id.

Invoke URL

https://api.orionscoringsystem.com/athlete/score/history

https://api.orionscoringsystem.com/athlete/score/history/{user-id}

Method Type

GET

Parameters

Parameter

Type

Required

Description

user-id

String

True, either as part of the invoke URL or as a query string parameter.

The UUID formatted user-id to return the score history.

Multiple values are allowed.

end-date

String formatted as a Date

False.

The end date of the date range to return scores for. Default value is value of start-date.

start-date

String formatted as a Date

False.

The start date of the date range to return scores for. Default value is today's date.

stage-style-def

String formatted as a Set Name

Either stage-style-def or event-style-def is required, but not both.

The Set Name of the stage style to return scores form.

Multiple values are allowed.

event-style-def

String formatted as a Set Name

Either stage-style-def or event-style-def is required, but not both.

The Set Name of the event style to return scores for. Will also return scores of all stage-styles that make up the event style.

format

String

False

The time format of the returned data. Must be one of:

DAY, WEEK, MONTH, QUARTER, YEAR

Defaults to DAY.

Values of WEEK, MONTH, QUARTER, YEAR return the sum of all scores fired in the date range.

continuation-token

String

False

The "ContinuationToken" attribute provided by a previous API response

This value should only be included if the total response of the API call is being spread across multiple smaller responses

"ContinuationToken" will only be included in the response if there is more data to return

If the data set is too large and a continuation token is being used, the data is returned in the same format.

The data for a single UserID may be split across multiple calls, however a single date will never be separated

Response

There are four different but related response formats- stage day, stage sum, event day and event sum.

Sum responses are returned when the format is not "DAY". In this case, all scores between the start and end date are grouped into

summed values; for example, setting the format to "WEEK" would return the sum of all score values for each week between the start and end date.

 

All responses are related in having a "ScoreHistory" field that is a dictionary with date strings as keys and lists of score instances as values.

 

Response Example

EVENT IN DAY FORMAT:

{

   "EventStyle": "v1.0:ntparc:Three-Position Sporter Air Rifle",

   "ContinuationToken": "1234-1234-1234::3::4",  //Continuation token; may or may not be included; if included, use this value for 'continuation-token' in the next API call

   "StageStyles": [

       "v1.0:ntparc:Sporter Air Rifle Prone",

       "v1.0:ntparc:Sporter Air Rifle Standing",

       "v1.0:ntparc:Sporter Air Rifle Kneeling",

       "v1.0:ntparc:Sporter Air Rifle Final"

   ],

   "IncludingRelated": false,

   "StartDate": "2019-01-01",

   "EndDate": "2019-02-01",

   "ScoreHistory": {

       "1234-1234-1234": {       //User ID

           "2019-01-08": [     //Date

               {

                   "ResultCOFID": "0000-0000-0000",

                   "EventStyle": "v1.0:ntparc:Three-Position Sporter Air Rifle",

                   "CourseOfFireDef": "v1.0:ntparc:Three-Position Air Rifle 3x10",

                   "NumberOfShots": 30,

                   "TypeOfMatch": "Local Match",

                   "ScoreFormatted": "233 - 1",

                   "Score": {

                       "I": 233,

                       "D": 247.8,

                       "X": 1,

                       "S": 233.0

                   },

                   "StageScores": [

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                           "Score": {

                               "I": 84,

                               "D": 89.1,

                               "X": 1,

                               "S": 84.0

                           },

                           "NumberOfShots": 10,

                           "ScoreFormatted": "84 - 1"

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                           "Score": {

                               "I": 75,

                               "D": 79.7,

                               "X": 0,

                               "S": 75.0

                           },

                           "NumberOfShots": 10,

                           "ScoreFormatted": "75 - 0"

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                           "Score": {

                               "I": 74,

                               "D": 79.0,

                               "X": 0,

                               "S": 74.0

                           },

                           "NumberOfShots": 10,

                           "ScoreFormatted": "74 - 0"

                       }

                   ]

               }

           ],

           "2019-01-24": [

               {

                   "ResultCOFID": "1111-1111-1111",

                   "EventStyle": "v1.0:ntparc:Three-Position Sporter Air Rifle",

                   "CourseOfFireDef": "v1.0:ntparc:Three-Position Air Rifle 3x20",

                   "NumberOfShots": 60,

                   "TypeOfMatch": "Local Match",

                   "ScoreFormatted": "488 - 0",

                   "Score": {

                       "I": 488,

                       "D": 512.9,

                       "X": 0,

                       "S": 488.0

                   },

                   "StageScores": [

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                           "Score": {

                               "I": 163,

                               "D": 171.0,

                               "X": 0,

                               "S": 163.0

                           },

                           "NumberOfShots": 20,

                           "ScoreFormatted": "163 - 0"

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                           "Score": {

                               "I": 160,

                               "D": 169.2,

                               "X": 0,

                               "S": 160.0

                           },

                           "NumberOfShots": 20,

                           "ScoreFormatted": "160 - 0"

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                           "Score": {

                               "I": 165,

                               "D": 172.7,

                               "X": 0,

                               "S": 165.0

                           },

                           "NumberOfShots": 20,

                           "ScoreFormatted": "165 - 0"

                       }

                   ]

               }

           ]

       }

   }

}

 

EVENT IN WEEK FORMAT:

 

{

   "EventStyle": "v1.0:ntparc:Three-Position Sporter Air Rifle",

   "ContinuationToken": "1234-1234-1234::3::4",

   "StageStyles": [

       "v1.0:ntparc:Sporter Air Rifle Prone",

       "v1.0:ntparc:Sporter Air Rifle Standing",

       "v1.0:ntparc:Sporter Air Rifle Kneeling",

       "v1.0:ntparc:Sporter Air Rifle Final"

   ],

   "IncludingRelated": false,

   "StartDate": "2019-01-01",

   "EndDate": "2019-02-01",

   "ScoreHistory": {

       "1234-1234-1234": {

           "2019-01-22": [

               {

                   "SumScore": {

                       "I": 721,

                       "D": 760.7,

                       "X": 1,

                       "S": 721

                   },

                   "NumberOfShots": 90,

                   "StageScores": [

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                           "SumScore": {

                               "I": 247,

                               "D": 260.1,

                               "X": 1,

                               "S": 247

                           },

                           "NumberOfShots": 30

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                           "SumScore": {

                               "I": 235,

                               "D": 248.89999999999998,

                               "X": 0,

                               "S": 235

                           },

                           "NumberOfShots": 30

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                           "SumScore": {

                               "I": 239,

                               "D": 251.7,

                               "X": 0,

                               "S": 239

                           },

                           "NumberOfShots": 30

                       }

                   ]

               }

           ],

           "2019-01-08": [

               {

                   "SumScore": {

                       "I": 246,

                       "D": 257.3,

                       "X": 2,

                       "S": 246

                   },

                   "NumberOfShots": 30,

                   "StageScores": [

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                           "SumScore": {

                               "I": 81,

                               "D": 85.1,

                               "X": 0,

                               "S": 81

                           },

                           "NumberOfShots": 10

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                           "SumScore": {

                               "I": 83,

                               "D": 86.4,

                               "X": 1,

                               "S": 83

                           },

                           "NumberOfShots": 10

                       },

                       {

                           "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                           "SumScore": {

                               "I": 82,

                               "D": 85.8,

                               "X": 1,

                               "S": 82

                           },

                           "NumberOfShots": 10

                       }

                   ]

               }

           ]

       }

   }

}

 

STAGE IN DAY FORMAT:
{

   "EventStyle": [],

   "StageStyles": [

       "v1.0:ntparc:Sporter Air Rifle Prone",

       "v1.0:ntparc:Sporter Air Rifle Standing",

       "v1.0:ntparc:Sporter Air Rifle Kneeling"

   ],

   "ContinuationToken": "1234-1234-1234::3::4",

   "IncludingRelated": false,

   "StartDate": "2019-01-01",

   "EndDate": "2019-02-01",

   "ScoreHistory": {

       "1234-1234-1234": {

           "2019-01-28": [

               {

                   "ResultCOFID": "0000-0000-0000",

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                   "CourseOfFireDef": "v1.0:ntparc:",

                   "TypeOfMatch": "Local Match",

                   "NumberOfShots": 10,

                   "Score": {

                       "I": 84,

                       "D": 89.1,

                       "X": 1,

                       "S": 84.0

                   },

                   "ScoreFormatted": "84 - 1"

               },

               {

                   "ResultCOFID": "0000-0000-0000",

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                   "CourseOfFireDef": "v1.0:ntparc:",

                   "TypeOfMatch": "Local Match",

                   "NumberOfShots": 10,

                   "Score": {

                       "I": 75,

                       "D": 79.7,

                       "X": 0,

                       "S": 75.0

                   },

                   "ScoreFormatted": "75 - 0"

               },

               {

                   "ResultCOFID": "0000-0000-0000",

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                   "CourseOfFireDef": "v1.0:ntparc:",

                   "TypeOfMatch": "Local Match",

                   "NumberOfShots": 10,

                   "Score": {

                       "I": 74,

                       "D": 79.0,

                       "X": 0,

                       "S": 74.0

                   },

                   "ScoreFormatted": "74 - 0"

               }

           ],

           "2019-01-24": [

               {

                   "ResultCOFID": "1111-1111-1111",

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                   "CourseOfFireDef": "v1.0:ntparc:",

                   "TypeOfMatch": "Local Match",

                   "NumberOfShots": 20,

                   "Score": {

                       "I": 163,

                       "D": 171.0,

                       "X": 0,

                       "S": 163.0

                   },

                   "ScoreFormatted": "163 - 0"

               },

               {

                   "ResultCOFID": "1111-1111-1111",

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                   "CourseOfFireDef": "v1.0:ntparc:",

                   "TypeOfMatch": "Local Match",

                   "NumberOfShots": 20,

                   "Score": {

                       "I": 160,

                       "D": 169.2,

                       "X": 0,

                       "S": 160.0

                   },

                   "ScoreFormatted": "160 - 0"

               },

               {

                   "ResultCOFID": "1111-1111-1111",

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                   "CourseOfFireDef": "v1.0:ntparc:",

                   "TypeOfMatch": "Local Match",

                   "NumberOfShots": 20,

                   "Score": {

                       "I": 165,

                       "D": 172.7,

                       "X": 0,

                       "S": 165.0

                   },

                   "ScoreFormatted": "165 - 0"

               }

           ]

       }

   }

}

 

 

STAGE IN WEEK FORMAT:
{

   "EventStyle": [],

   "ContinuationToken": "1234-1234-1234::3::4",

   "StageStyles": [

       "v1.0:ntparc:Sporter Air Rifle Prone",

       "v1.0:ntparc:Sporter Air Rifle Standing",

       "v1.0:ntparc:Sporter Air Rifle Kneeling"

   ],

   "IncludingRelated": false,

   "StartDate": "2019-01-01",

   "EndDate": "2019-02-01",

   "ScoreHistory": {

       "1234-1234-1234": {

           "2019-01-22": [

               {

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                   "SumScore": {

                       "I": 247,

                       "D": 260.1,

                       "X": 1,

                       "S": 247

                   },

                   "NumberOfShots": 30

               },

               {

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                   "SumScore": {

                       "I": 235,

                       "D": 248.89999999999998,

                       "X": 0,

                       "S": 235

                   },

                   "NumberOfShots": 30

               },

               {

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                   "SumScore": {

                       "I": 239,

                       "D": 251.7,

                       "X": 0,

                       "S": 239

                   },

                   "NumberOfShots": 30

               }

           ],

           "2019-01-08": [

               {

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Kneeling",

                   "SumScore": {

                       "I": 81,

                       "D": 85.1,

                       "X": 0,

                       "S": 81

                   },

                   "NumberOfShots": 10

               },

               {

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Prone",

                   "SumScore": {

                       "I": 83,

                       "D": 86.4,

                       "X": 1,

                       "S": 83

                   },

                   "NumberOfShots": 10

               },

               {

                   "StageStyle": "v1.0:ntparc:Sporter Air Rifle Standing",

                   "SumScore": {

                       "I": 82,

                       "D": 85.8,

                       "X": 1,

                       "S": 82

                   },

                   "NumberOfShots": 10

               }

           ]

       }

   }

}