Skip to content

Minified API Specification

taylorbr edited this page Aug 31, 2013 · 8 revisions

This is the page for the minified version of the API. It's kept separate from the main page.

1) search()

Request

    "version" : 1
    "query": "honger",
    "from" : "nld",
    "to" : "eng",
    "page" : [0,15],
    "options" : 0x1 | 0x2 | 0x4

Request minified

    "v" : 1
    "q": "honger",
    "f" : "nld",
    "t" : "eng",
    "p" : [0,15],
    "o" : 0x1 | 0x2 | 0x4

Response

    "version" : 1,
    "total" : 214,
    "sentences" : [
        {
            "id" : 123,
            "text" : "Ik heb honger.",
            "lang" : "nld",
            "tags" : [45, 24, 234, 2434],
            "audio" : 0,
            "user_id" : 789,
            "username" : "snape",
            "comments" : [342, 352, 2213],
            "direct": [234, 345, 43],
            "indirect" : [678, 343, 5]
        },
        {
            "id" : 234,
            "text" : "I am hungry.",
            "lang" : "eng",
            "tags" : [45, 24, 234, 2434],    
            "audio" : 1,
            "user_id" : 123,
            "username" : "george"
        },
        ...
        {
            "id" : 678,
            "text" : "I want to eat.",
            "lang": "eng",
            "tags" : [45, 24, 234, 2434],
            "audio" : 1,
            "user_id" : 345,
            "username" : "ballface69"
        },
        ...
        ,
        {
            // next sentence
        }
    ]

Response minified

    "v" : 1,
    "t" : 214,
    "s" : [
        {
            "i" : 123,
            "t" : "Ik heb honger.",
            "l" : "nld",
            "tg" : [45, 24, 234, 2434],
            "a" : 0,
            "ui" : 789,
            "un" : "snape",
            "c" : [342, 352, 2213],
            "d": [234, 345, 43],
            "i" : [678, 343, 5]
        },
        {
            "i" : 234,
            "t" : "I am hungry.",
            "l" : "eng",
            "tg" : [45, 24, 234, 2434],    
            "a" : 1,
            "ui" : 123,
            "un" : "george"
        },
        ...
        {
            "i" : 678,
            "y" : "I want to eat.",
            "l": "eng",
            "tg" : [45, 24, 234, 2434],
            "a" : 1,
            "ui" : 345,
            "un" : "ballface69"
        },
        ...
        ,
        {
            // next sentence
        }
    ]

2) getSentenceDetails()

Request

    "version" : 1,
    "id": 8341,
    "options" : 0x1 | 0x2 | 0x4

Request minified

    "v" : 1,
    "i": 8341,
    "o" : 0x1 | 0x2 | 0x4

Response

    "version" : 1
    "sentence" : [
        {
             "id" : 8341,
             "text" : "Ik heb honger.",
             "lang" : "nld",
             "tags" : [34, 56],
             "audio" : 1,
             "user_id" : 123,
             "username" : "ronnal42",
             "created" : "2013-04-15 01:12:34",
             "modified" : "2013-06-01 07:14:01",
             "tags" : [342,23,423],
             "direct": [985, 34232, 34224],
             "indirect" : [278, 8676, 3242]
        },
        {
            "id" : 985,
            "text" : "I am hungry.",
            "lang" : "eng",
            "tags" : [34, 56],
            "audio" : 0,
            "user_id" : 123,
            "username" : "hermonie granger"
        },
        ...
        { 
            "id" : 278,
            "text" : "I am hungry",
            "lang": "eng",
            "tags" : [34, 56],
            "audio" : 0,
            "user_id" : 123,
            "username" : "Harry Potter"
        },
        ...
    ],
    "comments" : [
        {
            "id" : 134,
            "sentence_id" : 5352,
            "user_id" : 1,
            "username" : "albus dumbledor",
            "created" : "2011-12-20 13:01:43",
            "modified" : "2011-12-20 13:01:43",
            "text" : "Yeah. Indeed!"
        },
        ...
    ]

Response minified

    "v" : 1
    "s" : [
        {
             "i" : 8341,
             "t" : "Ik heb honger.",
             "l" : "nld",
             "tg" : [34, 56],
             "a" : 1,
             "ui" : 123,
             "un" : "ronnal42",
             "c" : "2013-04-15 01:12:34",
             "m" : "2013-06-01 07:14:01",
             "d": [985, 34232, 34224],
             "i" : [278, 8676, 3242]
        },
        {
            "i" : 985,
            "t" : "I am hungry.",
            "l" : "eng",
            "tg" : [34, 56],
            "a" : 0,
            "ui" : 123,
            "un" : "hermonie granger"
        },
        ...
        { 
            "i" : 278,
            "t" : "I am hungry",
            "l": "eng",
            "tg" : [34, 56],
            "a" : 0,
            "ui" : 123,
            "un" : "Harry Potter"
        },
        ...
    ],
    "c" : [
        {
            "i" : 134,
            "si" : 5352,
            "ui : 1,
            "un" : "albus dumbledor",
            "c" : "2011-12-20 13:01:43",
            "m" : "2011-12-20 13:01:43",
            "t" : "Yeah. Indeed!"
        },
        ...
    ]

3) getComments()

Request

    "version" : 1,
    "id" : [32, 5426, 21]

Request minified

    "v" : 1,
    "i" : [32, 5426, 21]

Response

    "version" : 1 ,
    "comments" : [
        {
            "id" : 32,
            "sentence_id" : 5352,
            "lang" : "en",
            "text" : "Skyrim belongs to the Nords!",
            "user_id" : 1,
            "username" : "lydia"
            "created" : "2011-12-20 13:01:43",
            "modified" : "2011-12-20 13:01:43"
        },
        ...
    ]

Response minified

    "v" : 1 ,
    "c" : [
        {
            "i" : 32,
            "si" : 5352,
            "l" : "en",
            "t" : "Skyrim belongs to the Nords!",
            "ui" : 1,
            "un" : "lydia"
            "c" : "2011-12-20 13:01:43",
            "m" : "2011-12-20 13:01:43"
        },
        ...
    ]

4) getCommentDetails()

Request

    "version" : 1,
    "id": 465

Request minified

    "v" : 1,
    "i": 465

Response

    "version" : 1,
    "comment" : [
         {
             "id" : 465,
             "sentence_id" : 5352,
             "lang" : "en",
             "text" : "This sentence is wrong.",
             "user_id" : 1,
             "username" : "lydia",
             "created" : "2011-12-20 13:01:43",
             "modified" : "2011-12-20 13:01:43"
        }
    ]

Response minified

    "v" : 1,
    "c" : [
         {
             "i" : 465,
             "si" : 5352,
             "l" : "en",
             "t" : "This sentence is wrong.",
             "ui" : 1,
             "u" : "lydia",
             "c" : "2011-12-20 13:01:43",
             "m" : "2011-12-20 13:01:43"
        }
    ]

5) getUserDetails()

Request

    "version" : 1
    "id": 809

Request minified

    "v" : 1
    "i": 809

Response

    "version" : 1,
    "user" : {
        "id" : 809,
        "group_id" : 2,
        "username" : "bob69",
        "name" : "Bob Smith",
        "lang" : "jp",
        "country" : "Japan",
        "since" : "2011-12-20 13:01:43",
        "last_active" : "2013-01-01 10:09:04",
        "desc" : "My name is Bob Smith. I work at Microsoft.",
        "birthday" : "1988-06-15",
        "homepage" : "http://www.celebpics.com",
        "img" : "http://www.tatoeba.org/img/usrs/465465.jpg",
        "send_notifications" : 0,
        "level" : 1
    }

Response minified

    "v" : 1,
    "u" : {
        "i" : 809,
        "gi" : 2,
        "un" : "bob69",
        "n" : "Bob Smith",
        "l" : "jp",
        "c" : "Japan",
        "s" : "2011-12-20 13:01:43",
        "la" : "2013-01-01 10:09:04",
        "d" : "My name is Bob Smith. I work at Microsoft.",
        "b" : "1988-06-15",
        "h" : "http://www.celebpics.com",
        "im" : "http://www.tatoeba.org/img/usrs/465465.jpg",
        "sn" : 0,
        "lv" : 1
    }

6) getUsers()

Request

    "version" : 1,
    "id" : [34,542,123],
    "page" : [0, 10],
    "query" : "bob smith"

Request minified

    "v" : 1,
    "t" : "find" | "byIDs",
    "i" : [34,542,123],
    "p" : [0, 10],
    "q" : "bob smith"

Response

    "version" : 1
    "users" : [
        {
            "id" : 34,
            "group_id" : 2,
            "username" : "bob69",
            "since" : "2011-12-20 13:01:43",
            "img" : "http://www.tatoeba.org/img/usrs/465465.jpg",
        },
        {
            "id" : 542,
            "group_id" : 2,
            "username" : "big_chuck",
            "since" : "2011-12-20 13:01:43",
            "img" : "http://www.tatoeba.org/img/usrs/232.jpg",
        },
        ...
    ]

Response minified

    "v" : 1
    "u" : [
        {
            "i" : 34,
            "gi" : 2,
            "un" : "bob69",
            "s" : "2011-12-20 13:01:43",
            "im" : "http://www.tatoeba.org/img/usrs/465465.jpg",
        },
        {
            "i" : 542,
            "gi" : 2,
            "un" : "big_chuck",
            "s" : "2011-12-20 13:01:43",
            "im" : "http://www.tatoeba.org/img/usrs/232.jpg",
        },
        ...
    ]

7) fetchWall()

Request

    "version" : 1,
    "page" : [0,25],
    "options" : 0x1 | 0x2

Request minified

    "v" : 1,
    "p" : [0,25],
    "o" : 0x1 | 0x2

Response

    "wallPosts" : [
        {
            "id" : 00001,
            "user_id" : 1,
            "username" : "sarah",
            "created" : "2011-12-21 15:06:21",
            "modified" : "2013-01-15 09:04:30",
            "text" : "So how is the work on the API going?",
            "replies" : [42342, 3324, 42422, 543534]
        },
        {
            "id" : 42342,
            "user_id" : 1,
            "username" : "sarah",
            "created" : "2011-12-21 15:06:21",
            "modified" : "2013-01-15 09:04:30",
            "text" : "Good.",
            "replies" : [342, 531]
        },
        ...
    ]

Response minified

    "w" : [
        {
            "i" : 00001,
            "ui" : 1,
            "un" : "sarah",
            "c" : "2011-12-21 15:06:21",
            "m" : "2013-01-15 09:04:30",
            "t" : "So how is the work on the API going?",
            "r" : [42342, 3324, 42422, 543534]
        },
        {
            "i" : 42342,
            "ui" : 1,
            "u" : "sarah",
            "c" : "2011-12-21 15:06:21",
            "m" : "2013-01-15 09:04:30",
            "t" : "Good.",
            "r" : [342, 531]
        },
        ...
    ]

8) fetchWallThread()

Request

    "version" : 1,
    "id" : 3432

Request minified

    "v" : 1,
    "i" : 3432

Response

    "version" : 1,
    "wallPosts" : [
        {
            "id" : 3432,
            "user_id" : 1,
            "username" : "sarah",
            "created" : "2011-12-21 15:06:21",
            "modified" : "2013-01-15 09:04:30",
            "text" : "The US government spies on the entire world.",
            "replies" : [3324, 42422, 543534]
        },
        {
            "id" : 3324,
            "user_id" : 1,
            "username" : "sarah",
            "created" : "2011-12-21 15:06:21",
            "modified" : "2013-01-15 09:04:30",
            "text" : "Yes, but massive unprecedented surveillance keeps people safe.",
            "replies" : [342, 531]
        },
        ...
    ]

Response minified

    "v" : 1,
    "w" : [
        {
            "i" : 3432,
            "ui" : 1,
            "un" : "sarah",
            "c" : "2011-12-21 15:06:21",
            "m" : "2013-01-15 09:04:30",
            "t" : "The US government spies on the entire world.",
            "r" : [3324, 42422, 543534]
        },
        {
            "i" : 3324,
            "ui" : 1,
            "un" : "sarah",
            "c" : "2011-12-21 15:06:21",
            "m" : "2013-01-15 09:04:30",
            "t" : "Yes, but massive unprecedented surveillance keeps people safe.",
            "r" : [342, 531]
        },
        ...
    ]