Name |
Description |
| Location |
The name of a geographical location. This can be a country, region, county, district, borough, national park, SSSI or locally defined location within BARS. Actions associated with the given location or any location contained within the given location will be returned. |
| Organisation |
The name of an organisation delivering an action. Actions where a member of the specified organisation is listed as a contact will be returned. |
| Role |
Used in conjunction with the organisation input parameter to specify the role of the organisation delivering an action. Possible values are 'Lead', 'Support' or 'Both' (default). |
| Habitat |
The name of a habitat. Actions which are working on the specific habitat will be returned. |
| Species |
The name of a species - must be specified using its scientific (latin) name. Actions which are working on the specific species will be returned. |
| NationalPlan |
The name of a national action plan. Actions which are contributing to the national plan will be returned. Species action plans must be specified using scientific (latin) names. |
| LBAP |
The name of an LBAP partnership. Actions which are linked to the LBAP partnership will be returned. |
| Status |
The status of an action. Actions with the given status will be returned. |
| Category |
An action category. Actions associated with the given category will be returned. |
| StartDate and EndDate |
A pair of dates in dd/mm/yyyy format. Actions underway within the specified date range will be returned. Both start and end date must be specified to perform a date based search. |
Name |
Description |
| Code |
Action code. |
| Text |
Action text. |
| WorkProgrammes |
Array of individual work programmes - see below. |
| |
Type |
Type of work programme link (e.g. Habitat action plan). |
| |
Name |
Name of work programme link. |
| |
CommonName |
Common name of work programme link - used where the link type is a species action plan. |
| |
Supplemental |
Supplemental information - used to give the action plan name where the link type is a LBAP action plan. |
| Status |
Current action status. |
| StartDate |
Action start date. |
| EndDate |
Action end date. |
| Category1 |
Action category 1. |
| Species |
Array of individual species - see below. |
| |
Name |
Name of species. |
| |
CommonName |
Common name of species. |
| Habitats |
Array of individual habitat names. |
| Locations |
Array of individual locations - see below. |
| |
Name |
Name of location. |
| |
Type |
Type of location. |
| Contacts |
Array of individual contacts - see below. |
| |
Organisation |
Organisation. |
| |
FirstName |
First name of contact. |
| |
Surname |
Surname of contact. |
| |
JobTitle |
Contact job title. |
| |
Role |
Role in which contact is working in relation to the action - either 'Lead' or 'Support'. |
| Goals |
Array of individual action goals - see below. |
| |
Type |
Type of action goal - 'Habitat', 'Species' or 'User-defined'. |
| |
SpeciesName |
Species name for species goals. |
| |
SpeciesCommonName |
Species common name for species goals. |
| |
HabitatName |
Habitat name for habitat goals. |
| |
Location |
Location goal is relevant to. |
| |
ActivityType |
Type of goal. |
| |
Units |
Goal units. |
| |
Goal |
Goal amount. |
| |
GoalEndDate |
Goal end date. |
| |
CurrentValue |
Value currently achieved. |
| |
WorkInProgress |
Additional work in progress. |
| |
AssessmentDate |
Date assessment was carried out. |
| ProgressReports |
Array of action progress reports - see below. |
| |
Organisation |
Reporting organisation. |
| |
ContactFirstName |
First name of person making the progress report. |
| |
ContactSurname |
Surname of person making the progress report. |
| |
ContactJobTitle |
Job title of person making the progress report. |
| |
StartDate |
Start date of period covered by the progress report. |
| |
EndDate |
End date of period covered by the progress report. |
| |
Locations |
Array of locations relevant to this progress report - see below. |
| |
|
Name |
Name of location. |
| |
|
Type |
Type of location. |
| |
Uploads |
Array of uploaded files relevant to this progress report - see below. |
| |
|
Name |
Name of uploaded file. |
| |
|
Path |
Full path (in URL format) to download the uploaded file. |
