Twick.it-Blog

explain

Markus Möller

URL:

http://twick.it/interfaces/api/explain.xml

http://twick.it/interfaces/api/explain.json

Funktion:

Liefert die Erklärung eines Themas durch den besten Twick / die besten Twicks.

Parameter:

	Optional/Pflicht	Werte	Default	Bedeutung
search	Pflicht	Zeichenkette		Name des Themas
limit	optional	Ganzzahlen >= 0	1	Die Anzahl der Twicks, die zurückgegeben werden sollen. Eine Zahl <= 0 bedeutet keine Limitierung.
similar	optional	Boolean 1 oder 0	0	Führt bei 1 eine Ähnlichkeitssuche durch. Bei 0 muss der Titel des Themas exakt übereinstimmen.
skipHomonyms	optional	Boolean 1 oder 0	0	Zeigt bei 1 keine Homonyme (=Mehrdeutigkeiten) an.
lng	optional	"de", "en"	Sprache des Browsers	Sprache, in der gesucht werden soll.

Rückgabe (XML):

http://twick.it/interfaces/api/explain.xml?search=Fliege

<?xml version="1.0" encoding="utf-8"?>
<result>
  <query>search=Fliege</query>
  <topics>
    <topic>
      <id>20</id>
      <title>Fliege (Insekt)</title>
      <url>http://twick.it/de/Fliege-(Insekt)</url>
      <tags>
        <tag count="2">flügeln</tag>
        <tag count="2">fliegendes insekt</tag>
        <tag count="1">gejagt</tag>
        <tag count="1">fliegenklatsche</tag>
        <tag count="1">nervig</tag>
        <tag count="1">gilt</tag>
        <tag count="1">dreckig</tag>
        <tag count="1">hervorragendem</tag>
        <tag count="1">getötet</tag>
        <tag count="1">geflügeltes</tag>
      </tags>
      <geo>
        <latitude></latitude>
        <longitude></longitude>
      </geo>
      <twicks>
        <twick>
          <id>32</id>
          <acronym></acronym>
          <text>Insekt mit Flügeln. Gilt als dreckig und nervig. Wird
                mit einer Fliegenklatsche gejagt und getötet.</text>
          <link></link>
          <url>http://twick.it/de/Fliege-(Insekt)#32</url>
          <standalone_url>

http://twick.it/twick/de/Fliege-(Insekt)/Youser/32

          </standalone_url>
          <creation_date>2009-06-02 20:25:10</creation_date>
          <rating>
            <count>4</count>
            <sum>2</sum>
            <ratio>75</ratio>
          </rating>
          <user>
            <gravatar>http://www.gravatar.com/avatar/...</gravatar>
            <name>Youser (Sean Kollak)</name>
            <username>Youser</username>
            <url>http://twick.it/user/Youser</url>
          </user>
        </twick>
      </twicks>
    </topic>
    <topic>
      <id>280</id>
      <title>Fliege (Kleidungsstück)</title>
      <url>http://twick.it/de/Fliege-(Kleidungsstueck)</url>
      <tags>
        <tag count="1">kragen</tag>
        <tag count="1">männer</tag>
        <tag count="1">kleidungsstück</tag>
        <tag count="1">tragen</tag>
      </tags>
      <geo>
        <latitude></latitude>
        <longitude></longitude>
      </geo>
      <twicks>
        <twick>
          <id>466</id>
          <acronym></acronym>
          <text>Kleidungsstück, das Männer um den  Kragen tragen.</text>
          <link></link>
          <url>http://twick.it/de/Fliege-(Kleidungsstueck)#466</url>
          <standalone_url>

http://twick.it/twick/de/Fliege-(Kleidungsstueck)/derlangemarkus/466

          </standalone_url>
          <creation_date>2009-07-07 21:35:00</creation_date>
          <rating>
            <count>0</count>
            <sum>0</sum>
            <ratio>0</ratio>
          </rating>
          <user>
            <gravatar>http://www.gravatar.com/avatar/...</gravatar>
            <name>derlangemarkus (Markus Möller)</name>
            <username>derlangemarkus</username>
            <url>http://twick.it/user/derlangemarkus</url>
          </user>
        </twick>
      </twicks>
    </topic>
  </topics>
</result>

Rückgabe (JSON):

http://twick.it/interfaces/api/explain.json?search=Fliege

{
  "query"  : "type=json&search=Fliege",
  "topics": [
    {
      "id" : "20",
      "title"  : "Fliege (Insekt)",
      "url" :  "http://twick.it/de/Fliege-(Insekt)",
      "tags" : [
        {
          "tag" :  "flügeln",
          "count"  : 2
        },
        {
          "tag" :  "fliegendes  insekt",
          "count"  : 2
        },
        {
          "tag" :  "gejagt",
          "count"  : 1
        },
        {
          "tag" :  "fliegenklatsche",
          "count"  : 1
        },
        {
          "tag" :  "nervig",
          "count"  : 1
        },
        {
          "tag" :  "gilt",
          "count"  : 1
        },
        {
          "tag" :  "dreckig",
          "count"  : 1
        },
        {
          "tag" :  "hervorragendem",
          "count"  : 1
        },
        {
          "tag" :  "getötet",
          "count"  : 1
        },
        {
          "tag" :  "geflügeltes",
          "count"  : 1
        }
      ],
      "geo" : {
          "latitude" :  "",
          "longitude"  : ""
      },
      "twicks" : [
        {
          "id" : 32,
          "acronym" :  "",
          "text" : "Insekt mit Flügeln. Gilt als dreckig und nervig.
                    Wird  mit  einer Fliegenklatsche gejagt und getötet.",
          "link" : "",
          "url" :  "http://twick.it/de/Fliege-(Insekt)#32",
          "standalone_url" : "",
          "creation_date"  : "2009-06-02 20:25:10",
          "rating" : {
            "count"  : 4,
            "sum" :  2,
            "ratio"  : 75
          },
          "user" : {
            "gravatar" : "http://www.gravatar.com/...",
            "name" : "Youser (Sean Kollak)",
            "username" : "Youser",
            "url" :  "http://twick.it/user/Youser"
          }
        }
      ]
    },
    {
      "id" : "280",
      "title"  : "Fliege (Kleidungsstück)",
      "url" :  "http://twick.it/de/Fliege-(Kleidungsstueck)",
      "tags" : [
        {
          "tag" :  "kragen",
          "count"  : 1
        },
        {
          "tag" :  "männer",
          "count"  : 1
        },
        {
          "tag" :  "kleidungsstück",
          "count"  : 1
        },
        {
          "tag" :  "tragen",
          "count"  : 1
        }
      ],
      "geo" : {
          "latitude" :  "",
          "longitude"  : ""
      },
      "twicks" : [
        {
          "id" : 466,
          "acronym" :  "",
          "text" : "Kleidungsstück, das Männer um  den  Kragen tragen.",
          "link" : "",
          "url" :  "http://twick.it/de/Fliege-(Kleidungsstueck)#466",
          "standalone_url" : "",
          "creation_date"  : "2009-07-07 21:35:00",
          "rating" : {
            "count"  : 0,
            "sum" :  0,
            "ratio"  : 0
          },
          "user" : {
            "gravatar" : "http://www.gravatar.com/...",
            "name" : "derlangemarkus (Markus Möller)",
            "username" : "derlangemarkus",
            "url" :  "http://twick.it/user/derlangemarkus"
          }
        }
      ]
    }
  ]
}

2 Kommentare

Kommentar

Berliner

Gute Beschreibung … allerdings gibt es doch zu einem Thema mehrere Twicks. Wie spreche ich diese den an?

Kommentar

Markus Möller

Der Parameter Limit gibt an, wie viele Twicks zurück gegeben werden. Standard ist halt 1.

Gib einfach eine negative Zahl an, um alle Erklärungen zu einem Thema zu erhalten.

Hinterlasse einen Kommentar

Suchen:

Suchen