Documentation of eduGAIN database access API
Method: link_tests
Description:
Show the list of link test results. The result gives a cummulative view on links of given type. If there are several docments listed under the same type then the result wil show failure uness all these documents are OK. The last OK status will allso be understood as depending on the whole group.Supported formats: json, print_r
Arguments used:
- fed_id (optional)
- allowed values: a federation code (see list_fed_codes for a list of available codes).
Limits the results to a single federation. - reg_auth (optional)
- allowed values: a federation registration authority URN
Limits the results to a single federation. If fed_id argument is also present then it takes precedence over reg_auth - date (optional)
- default: today
allowed values: Any date in the format YYYY-MM-DD is allowed.
The data for the single date is shown. If this argument is present then start_date and end_date are not taken into account. - start_date (optional)
- allowed values: Any date in the format YYYY-MM-DD is allowed.
The data starting from this date is shown. This argument is diregarded in the presence of the date argument. - end_date (optional)
- allowed values: Any date in the format YYYY-MM-DD is allowed.
The data until this date is shown. This argument is diregarded in the presence of the date argument. - only_errors (optional)
- allowed values: 1 to indicate the option is set, any other value will be disregarded
Show only tests that failed. - format (optional)
- default: json
allowed values: any supported format
Returns:
Arrays of structured data - one entry per link type and test time.
Example:
- Status list from the last test
- https://technical.edugain.org/api.php?action=link_tests&format=print_r