refsoft | API
Kurzdokumentation (Stand: 19.09.2020)
Export-Aufruf
| https://api.refsoft.de/export.php?t=TOKEN&f=FORMAT&a=ACTION | |
|---|---|
| TOKEN | alphanumerischer Zugriffsschlüssel (API-Key) mit direkter Zuordnung eines Abfragesbereiches (VBL, DL, RL, ...) |
| FORMAT | json oder xml |
| ACTION | contacts für die Kontakte oder matches für die Spiele test-resultfür Regeltest-Ergebnisse |
Export-Ausgabe (Kontakte)
<refsoftExport>
<timestamp>Zeitstempel</timestamp>
<username>Benutzername des API-Key</username>
<filterName>Filterbezeichnung</filterName>
<API-Season>Saison</API-Season>
<dataSets>Anzahl der Datensätze</dataSets>
<contacts>
<contact>
<contactId>Kontakt-ID (refsoft)</contactId>
<samsUuid>SAMS-Uuid</samsUuid>
<gender>Geschlecht</gender>
<title>Titel</title>
<firstName>Vorname</firstName>
<lastName>Nachname</date>
<street>Straße</street>
<number>Hausnummer</number>
<zipCode>PLZ</zipCode>
<city>Ort</city>
<country>Land</country>
<phone>Telefon (privat)</phone>
<work>Telefon (dienstlich)</work>
<mobile>Mobil</mobile>
<email>E-Mail</email>
<birthDate>Geburtsdatum (YYYY-MM-DD)</birthDate>
<samsScorePin>SAMS Score-Pin (6-stellig)</samsScorePin>
</contact>
<contact>
weitere Kontakte
</contact>
</contacts>
</refsoftExport>
Export-Ausgabe (Spiele)
<refsoftExport>
<timestamp>Zeitstempel</timestamp>
<username>Benutzername des API-Key</username>
<filterName>Filterbezeichnung</filterName>
<API-Season>Saison</API-Season>
<dataSets>Anzahl der Datensätze</dataSets>
<matches>
<match>
<matchId>Spiel-ID (refsoft)</matchId>
<divisionId>Staffel-ID (refsoft)</divisionId>
<division>Kurzbezeichnung der Liga</division>
<matchNumber>Spielnummer</matchNumber>
<samsMatchId>SAMS-MatchId</samsMatchId>
<samsMatchUuid>SAMS-MatchUuid</samsMatchUuid>
<date>Datum (YYYY-MM-DD)</date>
<time>Spielbeginn (HH:MM:SS)</time>
<home>Heimmannschaft</home>
<away>Gastmannschaft</away>
<locationId>Hallen-ID (refsoft)</locationId>
<locationName>Name der Spielhalle</locationName>
<officials>
<firstReferee>
<refereeId>Schiedsrichter-ID (refsoft)</refereeId>
<samsUuid>SAMS-Uuid</samsUuid>
<gender>Geschlecht</gender>
<title>Titel</title>
<firstName>Vorname</firstName>
<lastName>Nachname</lastName>
<city>Stadt</city>
<country>Land</country>
</firstReferee>
<secondReferee>
...
</secondReferee>
<delegate>
...Spiel-/Schiedsrichterbeobachter
</delegate>
<supervisor>
...Supervisor
</supervisor>
<firstLinejudge>
...Linienrichter #1
</firstLinejudge>
<secondLinejudge>
...Linienrichter #2
</secondLinejudge>
<thirdLinejudge>
...Linienrichter #3
</thirdLinejudge>
<fourthLinejudge>
...Linienrichter #4
</fourthLinejudge>
</officials>
</match>
<match>
weitere Spiele...
</match>
</matches>
</refsoftExport>
Export-Ausgabe (Testergebnisse)
<refsoftExport>
<timestamp>Zeitstempel</timestamp>
<username>Benutzername des API-Key</username>
<exportName>eLearning</exportName>
<test>
<facts>
<refsoftTestId>refsoft-Test-ID</refsoftTestId>
<testName>Name des Tests</testName>
<contactTestId>Test-ID (Kontakt)</contactTestId>
<contactTestUuid>Test-UUID (Kontakt)</contactTestUuid>
<attempt>Versuch</attempt>
<start>Beginn (YYYY-MM-DD hh:mm:ss)</start>
<duration>Dauer (hh:mm:ss)</duration>
<testStatus>Test-Status (1 = laufender Test; 2 = beendeter Test)</testStatus>
<finishBySystem>automatisch beendeter Test (0 = normal durch Benutzer beendet; 1 = Zeitüberschreitung)</finishBySystem>
<passed>bestanden / Endergebnis (0 = nicht bestanden; 1 = bestanden)</passed>
<passingQuota>Ergebnis in Prozent (Fragen)</passingQuota>
<passingQuota2>Ergebnis in Prozent (Marker)</passingQuota2>
<numberOfQuestions>Anzahl der Fragen</numberOfQuestions>
<numberOfAnsweredQuestions>Anzahl der beantworteten Fragen</numberOfAnsweredQuestions>
<numberOfRightQuestions>Anzahl der richtigen Fragen</numberOfRightQuestions>
<numberOfMarkers>Anzahl der Marker</numberOfRightMarkers>
<numberOfRightMarkers>Anzahl der richtigen Marker</numberOfRightMarkers>
</facts>
<system>
<browser>Browser</browser>
<version>Browser-Version</version>
<platform>Betriebssystem</platform>
<deviceType>Endgerät</deviceType>
<lastIPv4>zuletzt genutzte IPv4-Adresse (123.456.789.123)</lastIPv4>
</system>
<questions>
<internalId>Interne Fragen-ID innerhalb des Tests (1 bis X)</internalId>
<questionId>Globale Fragen-ID (insbesondere für inhaltliche Rückfragen)</questionId>
<questionType>Fragentyp (1 = Multiple Choice)</questionType>
<firstView>Erste Ansicht (YYYY-MM-DD hh:mm:ss)</firstView>
<firstSubmit>Erste Antwort (YYYY-MM-DD hh:mm:ss)</firstSubmit>
<question>Frage bzw. Aufgabe</internalId>
<answers>
<details>
<internalId>Interne ID der Antwortmöglichkeit (1 bis max. 8)</internalId>
<answer>Text der Antwortmöglichkeit</answer>
<marker>0 = Marker nicht gesetzt | 1 = Marker gesetzt</marker>
<status>Status des Markers</status>
<standardSolution>0 = Marker MUSS nicht gesetzt werden | 1 = Marker MUSS gesetzt werden</standardSolution>
<...>
<summary>
<markersSet>Anzahl der gesetzer Marker</markersSet>
<markersSetCorrectly>Anzahl der richtig gesetzten Marker</markersSetCorrectly>
<markersSetCorrectly2>Anzahl der richtig gesetzten Marker</markersSetCorrectly2>
<markersAllCorrectly>0 = Alle Marker sind NICHT richtig gesetzt | 1 = Alle Marker sind richtig gesetzt</markersAllCorrectly>
</answers>
</questions>
</refsoftExport>