Get Definition

<< Click to Display Table of Contents >>

Navigation:  Support > REST API > Reconfigurable Rulebook Definition API Calls >

Get Definition

Description

Returns the Reconfigurable Rulebook definition for the passed on type and set name.

Invoking

Invoke URL

https://api.orionscoringsystem.com/definition/{type}/{set-name}

Method Type

GET

Parameters

Parameter

Type

Required

Description

type

String

True, it is part of the invoke URL

The Definition Type to retrieve.

set-name

String formatted as a Set Name

True, it is part of the invoke URL

The definition's Set Name to retrieve.

version

Boolean

False

If true, then only the version information is returned.

If false, or not included, the full definition is returned.

Response

A JSON object representing the requested Reconfigurable Rulebook definition.

Response Example

{
    "Title": "",
    "Message": [],
    "ResponseCodes": [],
    "v1.0:issf:10m Air Rifle": {
        "HierarchicalName": "issf:10m Air Rifle",
        "Discipline": "RIFLE",

        "AimingMarks": [

            {

                "Color": "BLACK",

                "Shape": "CIRCLE",

                "Dimension": 30.5

            }

        ],

        "Owner": "OrionAcct000001",

        "BackgroundColor": "WHITE",

        "Version": "1.7",

        "InnerTen": {

            "Value": 10,

            "Shape": "CIRCLE",

            "Dimension": -0.5

        },

        "ScoringRings": [

            {

                "Value": 10,

                "Shape": "CIRCLE",

                "Dimension": 0.5

            },

            {

                "Value": 9,

                "Shape": "CIRCLE",

                "Dimension": 5.5

            },

            {

                "Value": 8,

                "Shape": "CIRCLE",

                "Dimension": 10.5

            },

            {

                "Value": 7,

                "Shape": "CIRCLE",

                "Dimension": 15.5

            },

            {

                "Value": 6,

                "Shape": "CIRCLE",

                "Dimension": 20.5

            },

            {

                "Value": 5,

                "Shape": "CIRCLE",

                "Dimension": 25.5

            },

            {

                "Value": 4,

                "Shape": "CIRCLE",

                "Dimension": 30.5

            },

            {

                "Value": 3,

                "Shape": "CIRCLE",

                "Dimension": 35.5

            },

            {

                "Value": 2,

                "Shape": "CIRCLE",

                "Dimension": 40.5

            },

            {

                "Value": 1,

                "Shape": "CIRCLE",

                "Dimension": 45.5

            }

        ],

        "JSONVersion": "2018-10-30",

        "Description": "10m Air Rifle Target as defined by the ISSF.",

        "SetName": "v1.0:issf:10m Air Rifle",

        "Type": "TARGET"

    }

}