search

Description

Search uploaded images.

Images will be filtered by privacy attributes.

URL

/VERSION/search.FORMAT

Available Format

JSON

HTTP Method

GET

Accepted Version

1

Requires

Authorization

Headers

Generic parameters (those must be included always)

  • access_token: (Required) admin access_token to resources. This token will be used for privacy filtering purposes.
  • id: (Optional)  PIC filename unique identifier. If specified, only the matching image will be returned.
  • keywords: (Optional) comma separated string keywords. Only images that contains all specified keywords will be returned (order independent).
  • count: (Optional) max number of items that will be returned. Default 100.
  • page: (Optional) result page number. First page is 0. Default 0.

Example

https://pic.topoos.com/1/search.json?keywords=terrain,build&count=5&access_token=7c77w8e7d-f717-81c1-34ce-902c3d4b51ca1

Reply
JSON example reply

[
    {
        "id": 1012,
        "client_id": "522b28ea-3c00-4be4-89ea-bf86f02f243b",
        "user_id": "c21427c7-16db-4044-93c3-4aa3ad09fb34",
        "filename": "penguins",
        "filename_unique": "penguins_2",
        "file_ext": ".jpg",
        "uri": "https://pic.topoos.com/penguins_2",
        "register_date": "2014-01-02T10:44:36.983+01:00",
        "geo_data": null,
        "keywords": [
            "animal",
            "bonito",
            "feo"
        ],
        "privacy": "client"
    },
    {
        "id": 1011,
        "client_id": "522b28ea-3c00-4be4-89ea-bf86f02f243b",
        "user_id": "c21427c7-16db-4044-93c3-4aa3ad09fb34",
        "filename": "koala",
        "filename_unique": "koala_5",
        "file_ext": ".jpg",
        "uri": "https://pic.topoos.com/koala_5",
        "register_date": "2014-01-02T10:43:27.800+01:00",
        "geo_data": null,
        "keywords": [
            "animal",
            "bonito"
        ],
        "privacy": "public"
    }
]