KaroAPI:Users: Unterschied zwischen den Versionen

Aus KaroWiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „Gibt Daten über die Benutzer aus. == URL-Syntax == <nowiki>https://www.karopapier.de/api/users/</nowiki><code><User></code> Der <c…“)
 
K (verschob „KaroAPI:User“ nach „KaroAPI:Users“)
(kein Unterschied)

Version vom 4. April 2018, 18:22 Uhr

Gibt Daten über die Benutzer aus.


URL-Syntax

https://www.karopapier.de/api/users/<User>

Der <User> kann dabei entweder über seinen Benutzer-Namen oder die Benutzer-ID identifiziert werden.

Rückgabe

Als Rückgabe erhalten wir ein JSON-Objekt mit verschiedensten Daten des Benutzers.

Beispiel

https://www.karopapier.de/api/users/1 oder https://www.karopapier.de/api/users/Didi


{
   "id": 1,                       // Benutzer-ID
   "login": "Didi",               // Benutzer-Name
   "color": "ffffff",             // Farbe des Autos
   "lastVisit": 0,                // Anzahl der Tage seit dem letzten Besuch
   "signup": 5902,                // Anzahl der Tage seit der Anmeldung auf Karopapier
   "dran": 6,                     // Anzahl der Spiele, bei denen der Nutzer aktuell dran ist
   "activeGames": 98,             // Anzahl der Spiele, bei denen der Nutzer aktuell mitspielt
   "acceptsDayGames": true,       // Ob der Nutzer Eingeladen werden kann
   "acceptsNightGames": true,     // Ob der Nutzer auch zu Nachtspielen eingeladen werden will
   "maxGames": 100,               // Maximale Anzahl1 an Spielen, zu denen der Nutzer eingeladen werden will.
   "sound": 10,                   //
   "soundfile": "/mp3/quiek.mp3", // Name der Sound-Datei, die als „dran“-Sound abgespielt wird
   "size": 12,                    // Größe der Karokästchen
   "border": 1,                   // Größe des Rahmens um die Karokästchen                    
   "desperate": false,            // Ob der Nutzer Spielegeil ist
   "birthdayToday": false,        // Ob der Nutzer heute Geburtstag hat 
   "karodayToday": false,         // Ob der Nutzer heute Karotag hat 
   "theme": "karo1",              // Art der Darstellung der Karopapier-Webseite 
   "bot": false                   // Ob es sich bei dem Nutzer um einen Bot handelt
}
  1. 0 steht hierbei nicht für „Bitte nicht einladen“, sondern für „Keine explizite Grenze“. Wenn der Nutzer nicht eingeladen werden will, dann steht acceptsDayGames auf false.