ADDER A.I.M. Guide de l'utilisateur télécharger pdf (Page 51)

INSTALLATIONCONFIGURATIONOPERATION

FURTHER

INFORMATION

INDEX

logout

This method was last updated in API version 1, and is compatible with API requests from

version 1 onwards.

The authentication token provided by the Login function can be used until the logout

function is called.

Input parameters:

- token

- v (the A.I.M. API version this request is designed for)

Output values:

- timestamp - the current server time

- success - 0 = fail, 1 = success

Examples

Input:

/api/?method=logout&token=xxxxx&v=1

Output:

<api_response>

</api_response>

<api_response>

<error>

<msg>Error logging out (you may already have logged out)</msg>

</error>

</errors>

</api_response>

get_devices

This method was last updated in API version 2, and is compatible with API requests from

version 2 onwards.

This function returns a list of devices.

Input parameters:

- token

- v (the A.I.M. API version this request is designed for)

- device_type (‘rx’ = receivers, ‘tx’ = transmitters. Default = ‘rx’)

- lter_d_name (Optional. Device name search string)

- lter_d_description (Optional. Device description search string)

- lter_d_location (Optional. Device location search string)

- sort (Optional. Sort results by ‘name’/’description’/’location’. Default = ‘name’)

- sort_dir (Optional. Sort direction for results ‘asc’/’desc’. Default = ‘asc’)

- status (Optional. ‘’,’outdated_A.I.M._ip’,’rebooting’,’ofine’,’outdated_rmware’,’invalid_

backup_rmware’,’rebooting’,’upgrading_rmware’,’backup_mode’)

- show_all (Optional. If set and not blank, shows all receivers, not just those the logged-in

user is permitted to use)

- page (page number to start showing results for, default = 1)

- results_per_page (number of results per page, default = 1000)

Output values:

- version - the current API version number

- timestamp - the current server time

- success

- page (page number)

- results_per_page (number of results per page, default = unlimited)

- total_devices - the total number of devices

- count_devices - the number of devices on this page

continued

1 2 ... 46 47 48 49 50 51 52 53 54 55 56 ... 60 61

Commentaires sur ces manuels

Pas de commentaire

ADDER A.I.M. Guide de l'utilisateur Page 51

Commentaires sur ces manuels