getChampList
Properties:
  • id: Corresponds to a Verb definition. Each Verb definition corresponds to the meaning of a Verb, not the word. The IRI should be human-readable and contain the Verb meaning.
  • display: The human readable representation of the Verb in one or more languages. This does not have any impact on the meaning of the Statement, but serves to give a human-readable display of the meaning already determined by the chosen Verb.
Verb Meaning:

Example

JSON Representation:
  • Request:
    
    {
        "verb": {
            "id": "http://bao.mijnklas.nl/xapi/verbs/getChampList",
            "display": {
                "nl-NL": "Inhoud"
            }
        },
        "object": {
            "id": "http://bao.mijnklas.nl/xapi/activities/champList",
            "objectType": "Activity",
            "definition": {
                "extensions": {
                    "http://bao.mijnklas.nl/xapi/extensions/champList": {
                        "competitionId": "1",
                        "numberOfChamps": "3"
                    }
                }
            }
        }
    }
            
    Response example:
    
    {
        "verb" : {
            "id" : "http://bao.mijnklas.nl/xapi/verbs/getChampList"
        },
        "result" : {
            "duration" : "0",
            "extensions" : {
                "objectType" : "http://bao.mijnklas.nl/xapi/extensions/json",
                "http://bao.mijnklas.nl/xapi/extensions/json" : {
                    "name" : "champList",
                    "value" : "{\"ChampList\":[{\"Rank\":1,\"UserId\":4406545,\"FirstName\":\"Edwin(DEV)\",\"Preposition\":\"- \",\"SurName\":\"- \",\"Residence\":\"- \",\"GroupName\":\"- \",\"Score\":615,\"NumberOfTimesPlayed\":1},{\"Rank\":1,\"UserId\":4406658,\"FirstName\":\"Marc\",\"Preposition\":\"- \",\"SurName\":\"- \",\"Residence\":\"- \",\"GroupName\":\"- \",\"Score\":575,\"NumberOfTimesPlayed\":1},{\"Rank\":1,\"UserId\":4406778,\"FirstName\":\"Martijn LL\",\"Preposition\":\"- \",\"SurName\":\"- \",\"Residence\":\"- \",\"GroupName\":\"- \",\"Score\":0,\"NumberOfTimesPlayed\":1}],\"Properties\":[]}"
                }
            }
        }
    }
    /* If you un-escape and nicely format "value", it looks like this: */
    {
        "ChampList" : [{
                "Rank" : 1,
                "UserId" : 4406545,
                "FirstName" : "Edwin(DEV)",
                "Preposition" : "- ",
                "SurName" : "- ",
                "Residence" : "- ",
                "GroupName" : "- ",
                "Score" : 615,
                "NumberOfTimesPlayed" : 1
            }, {
                "Rank" : 1,
                "UserId" : 4406658,
                "FirstName" : "Marc",
                "Preposition" : "- ",
                "SurName" : "- ",
                "Residence" : "- ",
                "GroupName" : "- ",
                "Score" : 575,
                "NumberOfTimesPlayed" : 1
            }, {
                "Rank" : 1,
                "UserId" : 4406778,
                "FirstName" : "Martijn LL",
                "Preposition" : "- ",
                "SurName" : "- ",
                "Residence" : "- ",
                "GroupName" : "- ",
                "Score" : 0,
                "NumberOfTimesPlayed" : 1
            }
        ],
        "Properties" : []
    }
            
Legend:
  • Different colors in the JSON Representation give special meaning to that part of the json.

    Optional: May be added for clarity. Bao xApi ignores it if present.

    Removed: Bao xApi has no use for it but TinCan Api requests/requires it. Bao xApi ignores it if present.

    Comment: Comment for clarification of the property. This should not be present in the json representation

;