Spis treści

  1. Spis treści
  2. Profil
    1. Pobranie profilu
      1. Format odpowiedzi
      2. Widoczność i dostępne pola
      3. Parametr fields, limity, pełne i częściowe zapytania
    2. Modyfikacja profilu

Profil

obiekt reprezentujący profil użytkownika
URL http://api.grono.net/api/profile/USER_ID_LUB_LOGIN/

Pobranie profilu

metoda GET
argumenty format=FORMAT,fields=WYBRANE_POLA
zwraca 200 OK + dane
400 Bad Request
403 Not Authorized
limit 150 pełnych zapytań na 24 godziny

Format odpowiedzi

<Profile xmlns="http://api.grono.net/schema">
  <status>Brachy melanus, folius lineatus trich penta archaeos hortensis rubra lateralis pachys lipsem platy penta hortensis cyanos.</status>
  <numfriends>43</numfriends>
  <scrname>ᴉuɹƹʞ</scrname>
  <name>Krzysztof</name>
  <city>Żywiec</city>
  <nicks>k3rni</nicks>
  <joined>27-02-2006</joined>
  <birthday>07-05-1981</birthday>
  <avatar_url>http://c12.grono.net/86/41/avatar-32831321.gif</avatar_url>
  <zodiac>taurus</zodiac>
  <nameday>25 Jul</nameday>
  <invitedby>
    <url>http://api.grono.net/api/profile/wojtek/</url>
    <scrname>wojteks</scrname>
  </invitedby>
  <location>
    <zl>14</zl>
    <lat>51.7953457303</lat>
    <lng>19.4499206543</lng>
  </location>
</Profile>

Widoczność i dostępne pola

Pola pojawiają się w profilu, jeśli ustawione są jako widoczne "dla wszystkich", lub "dla zarejestrowanych". Wpływa na to również parametr fields podany w zapytaniu (o tym niżej). Pełna lista pól z objaśnieniami:

  • avatar_url: odnośnik do obrazu avatara użytkownika. Pusty (w XML), lub null (pozostałe formaty) jeśli użytkownik nie ma ustawionego avatara.
  • invitedby: osoba, która zaprosiła użytkownika do Grona
  • location: położenie geograficzne, zaznaczone na mapie
  • status: blimp użytkownika. Ustawienie tego pola jest równoważne z ustawieniem go standardową metodą.
  • birthday: data urodzin, w formacie dzień-miesiąc-rok (np. 31-12-1985), jeśli ustawiona. W przeciwnym wypadku puste lub null (jw).
  • nameday: data imienin, w formacie dzień-miesiąc (np 25-7), jeśli ustawiona. W przeciwnym wypadku poste lub null.
  • zodiac: znak Zodiaku wyliczony z daty urodzin, jeśli ustawiona. W przeciwnym wypadku puste lub null. Przyjmuje wartości z listy: aries, taurus, gemini, cancer, leo, virgo, libra, scorpio, sagittarius, capricorn, aquarius, pisces.
  • name: imię użytkownika
  • surname: nazwisko użytkownika
  • aboutme: zawartośc pola "O mnie" w profilu.
  • interests: zawartość pola "Zainteresowania" w profilu.
  • occupation: zawartość pola "Zajmuję się" w profilu.
  • login: wybrany przez użytkownika login, używany do wywołań w API
  • sex: płeć użytkownika. Przyjmuje wartości z listy male, female.
  • city: miasto wybrane przez użytkownika w profilu
  • numfriends: ilość znajomych
  • id: numeryczny ID użytkownika, można go również używać do wywołań w API.
  • joined: data dołączenia do Grona (pole "W Gronie od" w profilu). Format dzień-miesiąc-rok (np. 16-7-2005).

Pola, których wartość można modyfikować, są wyróżnione pogrubieniem. Pozostałe są tylko do odczytu. Uwaga: lista edytowalnych pól może się w przyszłości zmieniać. Parametr fields zawiera oddzieloną przecinkami listę pól do pobrania. Nazwy tych pól bierzemy z listingu powyżej. Nierozpoznane nazwy będą ignorowane. Podanie pustej listy nie zwróci nic ciekawego.

Parametr fields, limity, pełne i częściowe zapytania

Jeśli parametr fields nie zostanie podany, zapytanie zwróci wszystkie pola. Zostanie to naliczone jako jedno pełne zapytanie. Można jednak wybierać pola które mają znaleźć się w odpowiedzi. Schemat liczenia jest wówczas następujący: 

 punkty = (ilość_pól_w_zapytaniu / 18)

Można zatem wykonać 150 zapytań pełnych (z wszystkimi polami) w ciągu 24 godzin. Jeśli ograniczymy się do scrname i daty urodzin, daje nam to możliwość wykonania 150 * 9 = 1350 zapytań. Pobieranie imienia, nazwiska, płci, nazwy ekranowej, daty urodzin i imienin to już 150 * 3 = 450 zapytań. Oczywiście nie ma osobnych limitów na mniejsze zapytania, naliczane są one jak ułamki do ogólnego limitu 150 zapytań.

Modyfikacja profilu

metoda POST
dane wybrane pola do modyfikacji, z listy powyżej
zwraca 204 No Content
400 Bad Request
403 Not Authorized
uwagi status ma maksymalnie 160 znaków (nie wliczając narzutu kodowania). dłuższy tekst będzie obcięty do tej wielkości.
wszystkie tagi HTML będą wycięte
404 jeśli podany username nie istnieje
403 jeśli próbujemy modyfikować nie swój profil
limity 150 na 24 godziny