Vridlo/api/vridlo.user.index: Difference between revisions

From ALT Linux Wiki
(Blanked the page)
Tag: Blanking
 
Line 1: Line 1:
== vridlo.user.index ==


It allows accessing to a list of users, which are presented in the system. Do not poll this method more than once an hour.
Added into API v1.0.
=== Path ===
/v1/users
=== Methods ===
==== GET ====
Returns a list of users, which are presented in the system. Do not poll this method more than once an hour.
Added into API v1.0.
===== Authentication =====
This method requires NO authentication.
===== Arguments =====
* per_page (Optional)
Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
* page (Optional)
The page of results to return. If this argument is omitted, it defaults to 1.
NOTE: Arguments can be provided as arguments along with headers fields.
===== Example Response =====
[
  {
  "id": "1",
  "sign_in_count": "2",
  "current_sign_in_at": "10.11.1970 10:10:10",
  "last_sign_in_at": "10.10.1970 10:10:10",
  "confirmed": true,
  "admin": false,
  "description": "Info user",
  "names": [
      {
        "kind": "firstname"
        "text": "User"
      },
      {
        "kind": "paternal"
        "text": "Batkovič"
      },
      {
        "kind": "lastname"
        "text": "Batkovič"
      },
      {
        "kind": "nickname"
        "text": "Bublo"
      }
  ],
  "recitals": [
    {
        "kind": "email",
        "address": "user@gmail.com",
        "foremost": false
    },
    {
        "kind": "email",
        "address": "user@altlinux.org",
        "foremost": true
    },
    {
        "kind": "login",
        "address": "user",
        "foremost": false
    },
    {
        "kind": "jabber",
        "address": "user@jabber.ru",
        "foremost": false
    },
    {
        "kind": "website",
        "address": "http://user.me",
        "foremost": false
    },
    {
        "kind": "location",
        "address": {
          "x": "37.618448",
          "y": "55.753165",
          "grid": "yandex",
          "name": "Moskva. Kremlin. Senatskij palace"
        },
        "foremost": false
    }
  ]
  }
]
===== Return Codes =====
* '''200''' (''OK'')
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is finished.
* '''206''' (''Partial Content'')
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is NOT finished yet.
* '''416''' (''Range Not Satisfiable'')
The resource list is accessible. But data can't be returned since range provided don't match the list boundaries.
* '''422.3''' (''SSL is required'')
SSL is required to access the Vridlo API.
* '''500''' (''Service currently unavailable'')
The requested service is temporarily unavailable.

Latest revision as of 08:57, 3 December 2019