Findsi API documentation
Findsi is currently still in beta. As a result the API documentation is subject to change.

actors

Method GET
Rel findsi:actors
Description Returns a paged list of Actors the requesting API consumer has logged activities for

Parameters

  Required Description
filter No A filter to apply on on the result set. Actors can be filtered by their Classification (exact match).
page_index No 0-based index of the requested result set.

Response

A successful response (HTTP 200) will be a HAL document, containing the following:

Only the default _self and curies links will be included.

Embedded resources

  Type Description
actor Array Actors that the requesting API consumer has logged at least one activity for.

Properties

None

Errors

The API may respond with one of the following errors:

401 Unauthorized The Authorization header might be missing or malformed. Alternatively you may have provided an invalid API key.

Example

A basic, unfiltered request would look something like:

GET /actors HTTP/1.1
Host: api.findsi.com
Accept: application/hal+json
Authorization: findsi_api_key apikey="..."
Content-Type: application/json

If all went well, your response will look something like this:

Cache-Control no-cache
Content-Length 1214
Content-Type application/hal+json; charset=utf-8
Date Wed, 10 Sep 2014 15:27:58 GMT
Expires -1
Pragma no-cache

{
    "_links": {
        "curies": {
            "href": "http://www.findsi.com/docs/link-relations/{rel}",
            "templated": true,
            "name": "findsi"
        },
        "self": {
            "href": "/actors?page_index=0"
        }
    },
    "_embedded": {
        "findsi:actor": [
            {
                "Id": "456",
                "Classification": "user",
                "_links": {
                    "findsi:actors": {
                        "href": "/actors"
                    },
                    "findsi:actor-targets": {
                        "href": "/actors/.../targets"
                    },
                    "findsi:actor-similars": {
                        "href": "/actors/.../similars"
                    },
                    "self": {
                        "href": "/actors/..."
                    }
                }
            },
            {
                "Id": "123",
                "Classification": "user",
                "_links": {
                    "findsi:actors": {
                        "href": "/actors"
                    },
                    "findsi:actor-targets": {
                        "href": "/actors/.../targets"
                    },
                    "findsi:actor-similars": {
                        "href": "/actors/.../similars"
                    },
                    "self": {
                        "href": "/actors/..."
                    }
                }
            }
        ]
    }
}

 2014 Findsi B.V.    Findsi wesite    Feature backlog    Contact us
   docs/link-relations/actors.md