28 August 2008

Home > News, help & information > Web services > Action goals

News, help & information

	News, help & information Website news Help guides Web services Advice to practitioners Training information & resources About BARS What is BARS? History of development How does BARS work? Who uses BARS? User statistics

Action goals web service

Returns detailed information for action goals matching a combination of the specified input parameters.

Inputs

Name	Description
Habitat	The name of a habitat. Action goals targeting the specific habitat will be returned.
Species	The name of a species - must be specified using its scientific (latin) name. Action goals targeting the specific species will be returned.
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. Action goals associated with the given location or any location contained within the given location will be returned.
Partnership	The name of an LBAP partnership. Actions which are linked to the LBAP partnership will be returned.
ActivityType	An action goal activity type. Action goals with the given activity type 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).

Outputs

An array of the following data structure is returned:

Name		Description
Type		Type of action goal - 'Habitat', 'Species' or 'User-defined'.
WorkProgrammes		Array of individual work programmes for this action - 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.
Organisations		Array of organisations working on this action - see below.
	Name	Name of organisation.
	Role	Role in which organisation is working in relation to the action - either 'Lead' or 'Support'.
ActionCode		Action code.
ActionText		Action text.
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.

Notes

Multiple inputs are combined to narrow a search (i.e. return fewer results).
User-defined goals are only returned when neither habitat nor species are specified.

View SOAP request and response information