Documentation of aiohttp-handlers

Contents:

• Accounts handler
• Account handler
• Lists handler
• Version handler
• Search handler
• Config handler
• Docs handler

Common jsons

server_error

Object Properties

• error_code (integer) – inner error code, for more info about errors go to Service errors.

• detail (string) – error description

JSON Example

{
    "error_code": 3366,
    "detail": "BdrvjGUSHomqVVmHxqeZ"
}

account_info

Object Properties

• account_id (uuid4) – account id

• email (email) – email of account

• organization_name (organization_name) – organization name

• status (boolean) – if account is currently blocked, system returns True

JSON Example

{
    "account_id": "02c157c4-a992-460e-ae72-5cdd2d7fc16c",
    "email": "zwhitehead@example.org",
    "organization_name": "{organization_name object}",
    "status": false
}

account_stats

Object Properties

• list_count (integer) – list count of account

• face_attribute_count (integer) – face attribute count of account

• face_count (integer) – face count of account

JSON Example

{
    "list_count": 5455,
    "face_attribute_count": 9870,
    "face_count": 8200
}

account

Object Properties

• info (account_info) – account info

• stats (account_stats) – account stats

JSON Example

{
    "info": {
        "account_id": "d43c880c-0e54-4f75-b526-3f0cdf5326d1",
        "email": "nielsenadrian@example.org",
        "organization_name": "{organization_name object}",
        "status": true
    },
    "stats": {
        "list_count": 1495,
        "face_attribute_count": 5999,
        "face_count": 1983
    }
}

luna_list

Object Properties

• list_id (uuid4) – list id

• account_id (uuid4) – account id

• user_data (user_name) – user data about list

• count_object_in_list (integer) – object’s count in list

• last_update_time (iso8601) – time of last action with list (attach or detach face from list)

JSON Example

{
    "list_id": "baea2aec-0931-43ec-8cad-2886897bd575",
    "account_id": "fad67157-f55b-4c8a-aa2c-18c4ab60b988",
    "user_data": "tdurham",
    "count_object_in_list": 5792,
    "last_update_time": "2003-11-02T03:06:22"
}