Search for Units (BETA)

get

https://resources.uk.eagleeye.com/units

This method allows the calling application to search units using query parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

EES AIR Unit ID.

status

string

enum

This is a status of a Unit.

Allowed:

type

string

enum

This is a type of a Unit.

Allowed:

parentUnitId

boolean

Defaults to false

This is a flag that filters the search to child units of the passed parent unit id.

tag

string

EES AIR Unit Tag.

offset

integer

Offset allows you to skip a number of items before returning data.

limit

integer

The number of items to return.

orderBy

string

enum

Requested result set sorting order

Allowed:

Headers

X-EES-AUTH-CLIENT-ID

string

required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASH

string

required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret.

Accept-Encoding

string

enum

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

Allowed:

X-EES-TRANSACTION-ID

string

Unique Reference for the API transaction within the calling company.

X-EES-RETRY

string

This flag denotes the number of attempts that have been made for this request.

Responses

200OK.

400Bad Request.

401Unauthorized.

403Forbidden.

405Method Not Allowed.

429Too Many Requests

500Server Error

501Not Implemented

502Bad Gateway

503Service Unavailable

504Gateway Timeout