What are these data tools?

Our data tools can help anyone view and download all sorts of local open data and apply some calculated analysis too. It’s ideal if you want to take a deeper look at the data behind LG Inform Plus and use it in your own way.

What do I need?

Before you can use the tools, you’ll need to sign in to your account (local authority staff) or request a security key (developers).

Need more help?

Search our knowledge base to find the help you need.

To see data you must:

, ,
, ,

Download

Download and save this data

Permanent url

Create a permanent url to the data source using a public private key

/amenities

Services that are provided for the public.

Parameters

amenityType
All amenities within a particular area of a particular type. The area parameter is also required.
Example call
http://webservices.esd.org.uk/amenities?amenityType=general_practitioner&area=E09000031&ApplicationKey=ExamplePPK&Signature=uDbfTsB7g+EH722fENgmXTyIjz4=
area
All amenities within a particular area. The parameter is required.
Example call
http://webservices.esd.org.uk/amenities?area=E09000031&ApplicationKey=ExamplePPK&Signature=vOldCRy9AG1uzDesQFsM3MQCio0=



/amenities/shape

KML file containing a point for every amenity within a particular area.

Parameters

amenityType
A KML file containing points for all amenities within a particular area of a particular amenity type. The area parameter is also required.
Example call
http://webservices.esd.org.uk/amenities/shape?amenityType=general_practitioner&area=E09000031&ApplicationKey=ExamplePPK&Signature=jLOJNcC/wFC5LiQaB9IItklvKIQ=
area
A KML file containing points for all amenities within a particular area.
Example call
http://webservices.esd.org.uk/amenities/shape?area=E09000031&ApplicationKey=ExamplePPK&Signature=p2wkhfJ9XNyKj8ht2h04Qbnszpw=
styleUrl
Allows insertion of KML code to produce a file which allows the default styleUrl attribute to be replaced by the styles in the given file.
Example call
http://webservices.esd.org.uk/amenities/shape?area=E09000010&styleUrl=http://resources.esd.org.uk/styles/amenities-default.kml&ApplicationKey=ExamplePPK&Signature=QBvQ/7H86i5PvJnA+Vsk6+1T6Ec=



/amenityTypes/{identifier}

Details about a particular amenity type.

Example call




/areaTypes

Returns area types, including detailed area types such as MBC and London borough.

Example call

Parameters

area
Limit to the area types within a particular area.
Example call
http://webservices.esd.org.uk/areaTypes?area=E09000006&ApplicationKey=ExamplePPK&Signature=ldaqVISWfc75h3Sli9XBNSytSiY=
officialOnly
Filter to just official area types, so excluding user created area types.
Example call
http://webservices.esd.org.uk/areaTypes?officialOnly=true&ApplicationKey=ExamplePPK&Signature=usMDjEvdLZb0tiBHkoQTk6jam6Q=



/areaTypes/current

Current user's area type. Requires a call using OAuth to retrieve data.




/areaTypes/filter-data

Area types which have data for a particular metric type and time period.

Parameters

metricType
Area types which have data for the specified metric type or types.
Example call
http://webservices.esd.org.uk/areaTypes/filter-data?metricType=1&ApplicationKey=ExamplePPK&Signature=F5bXPJ/YKJz3+s0JryqutdEjglY=
period
Filter area types by those available for a particular time period.
Example call
http://webservices.esd.org.uk/areaTypes/filter-data?period=cal_2005&ApplicationKey=ExamplePPK&Signature=sTBPxXOe6LlvrBUK84Fo6GNq5xo=



/areaTypes/verbose

List of all details for all area types.

Example call

Parameters

officialOnly
Full details of area types filtered to just official area types, so excluding user created area types.
Example call
http://webservices.esd.org.uk/areaTypes/verbose?officialOnly=true&ApplicationKey=ExamplePPK&Signature=ejB6hS81RyAxiVWpX9F5M37970o=



/areaTypes/{identifier}

Details about a particular area type.

Example call




/areas

Geographical areas used by LG Inform. Due to the large number of areas an empty call returns no results. Results are limited to first 500 - subsequent results can be found using the "pageNumber" attribute.

Example call

Parameters

applicableToMetricType
Filter areas by comparison group and metric type's applicable area types
Example call
http://webservices.esd.org.uk/areas?area=AllLaInRegion_London&applicableToMetricType=123&ApplicationKey=ExamplePPK&Signature=AeZrHNUAZYoAkeFJ94qhlfh3YmQ=
area
Filter by area type and parent area
Example call
http://webservices.esd.org.uk/areas?area=E92000001:County&ApplicationKey=ExamplePPK&Signature=u2PqJDzUR78qKl8DjQt8P28UoVY=
areaType
All areas of a particular area type
Example call
http://webservices.esd.org.uk/areas?areaType=County&ApplicationKey=ExamplePPK&Signature=gJXof7gpgJ1EA9EEZKYp7iLWznI=
pageNumber
If retrieving more than 20,000 areas or 500 shapes this can be used to return subsequent pages.
Example call
http://webservices.esd.org.uk/areas?areaType=LLSOA&pageNumber=3&ApplicationKey=ExamplePPK&Signature=vbItCrwgzxPtCD4ZnbY7YLpBF0A=
pageSize
Number if items to be returned in each call up to a limit of 500, which is the default.
Example call
http://webservices.esd.org.uk/areas?areaType=LondonBorough&pageSize=10&ApplicationKey=ExamplePPK&Signature=EygulJBVP3y+qz6b/xOhIc7AFyI=
searchText
The search text can be either a postcode, a postcode district (the first half of the postcode), or a text string. Defaults to local authorities whether the areaType parameter is not specified.
Example call
http://webservices.esd.org.uk/areas?searchText=sw11&areaType=LocalAuthority&ApplicationKey=ExamplePPK&Signature=XfjTnQK4gh6elWSK2u0nTfOw6NQ=



/areas/{identifier}

The identifier is a GSS code, or comparison group identifier, used to find details about a particular geographical area

Example call




/areas/{identifier}/bounds

Co-ordinates for the minimum and maxim longitude and latitudes for a particular area or group of areas.

Example call




/areas/{identifier}/shape

The identifier is either a GSS code, or comparison group identifier, and is used to retrieve KML data for the corresponding geographical area(s)

Example call

Parameters

changedSince
Only return areas whose information has changed since a specified date
Example call
http://webservices.esd.org.uk/areas/E09000010/shape?changedSince=2012-06-15&ApplicationKey=ExamplePPK&Signature=76Xr5+6y7Luzzwr7wDOiiuI2a68=
pageNumber
Larger calls can be split into different pages. All calls are automatically limited to 500 areas. Use this attribute to find subsequent pages.
Example call
http://webservices.esd.org.uk/areas/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=Z6kE3dYCITLSWwePScAxeG11IA8=
pageSize
Limit the number of areas returned in each KML file.
Example call
http://webservices.esd.org.uk/areas/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=Z6kE3dYCITLSWwePScAxeG11IA8=



/bounds

Co-ordinates for the minimum and maxim longitude and latitudes for a particular area or group of areas.

Parameters

area
Returns the minimum and maximum longitudes for an area or group of areas.
Example call
http://webservices.esd.org.uk/bounds?area=E09000031&ApplicationKey=ExamplePPK&Signature=F0aQin7vFpij4OtL8X+Zvpv6+DI=



/comparisonGroups

Comparison groups are area groupings of different types, such as all district local authorities, or all fire organisations in England. Without parameters, all groups, excluding custom groups, are returned.

Example call

Parameters

mainOnly
Only the main comparison groups, so includes groupings by authority type, but excludes things like groupings by near neighbours.
Example call
http://webservices.esd.org.uk/comparisonGroups?mainOnly=true&ApplicationKey=ExamplePPK&Signature=ISfZ6VFwa1CZ1ni4w/OpU+7pzys=
memberArea
Groups of which the area is a member, but not necessarily an owner. If area 1 is a near neighbour of area 2, area 1 would be a member of the near neighbour group (along with the other near neighbours) and area 2 would be the owner of the group
Example call
http://webservices.esd.org.uk/comparisonGroups?memberArea=E09000010&ApplicationKey=ExamplePPK&Signature=2evVkMXuIIkPnwVkrUAqGPhdgA0=
ownerArea
Group which the area owns, but is not necessairly a member. An area is generally the owner of a group if the group is a main group, such as all local authorities, or is the area to which a group relates, such as near neighbours of an area.
Example call
http://webservices.esd.org.uk/comparisonGroups?ownerArea=E09000010&ApplicationKey=ExamplePPK&Signature=13Wr2C2AkxkRr9fxEFaXhmsCIOg=
type
Comparison groups of a specified comparison group type for a specified area. For example, which Experian Mosaic near neighbours a particular area has.
Example call
http://webservices.esd.org.uk/comparisonGroups?type=AllLaInRegion&ApplicationKey=ExamplePPK&Signature=hS1T4XShWkNS3VEf2FZ4IQiCli4=



/comparisonGroups/current

Shows comparison groups visible to the current user, including all main groups, non-main groups owned by user's area (e.g. Near neighbours) and custom comparison groups.

Parameters

user
Shows the main comparison group and any custom groups for a particular user, selected by user identifier.



/comparisonGroups/custom

A user can create groups of areas that they are interested in. These are called custom comparison groups. The call with no parameters returns the groups for the signed in user.

Parameters

user
A list of only the custom comparison groups for a selected user.



/comparisonGroups/custom/create

Create a custom comparison group for a user.

Parameters

areas
A list of the areas, identified by GSS code, to be included within the custom comparison group
label
A label for the custom comparison group.



/comparisonGroups/custom/{identifier}/delete

Delete a users custom comparison group.




/comparisonGroups/custom/{identifier}/update

Update a specified custom comparison group for a user.

Parameters

areas
Update the areas associated with a comparison group. All previous areas will be removed.
label
Update the label associated with a custom comparison group.



/comparisonGroups/{identifier}

Returns the details for a particular comparison group.

Example call




/comparisonGroups/{identifier}/bounds

Co-ordinates for the minimum and maxim longitude and latitudes for a particular comparison group.

Example call

Parameters

area
Returns the minimum and maximum longitudes for a comparison group.
Example call
http://webservices.esd.org.uk/comparisonGroups/AllLaInRegion_London/bounds?ApplicationKey=ExamplePPK&Signature=FGg0lhTuZEf5jaKFdqlGzRKhIKg=



/comparisonGroups/{identifier}/shape

Returns KML shapes of all areas in a comparison group

Example call

Parameters

changedSince
Only include shapes whose data has been updated since the specified date
Example call
http://webservices.esd.org.uk/comparisonGroups/AllLAInRegion_London/shape?changedSince=2012-06-15&ApplicationKey=ExamplePPK&Signature=6IdgxIllc3hNi+WUeO3XLFzrjPY=
pageNumber
Larger calls can be split into different pages. All calls are automatically limited to 500 areas. Use this attribute to find subsequent pages.
Example call
http://webservices.esd.org.uk/comparisonGroups/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=fIzjO17e3uQ+LeYhgUAlpUH1qxY=
pageSize
Limit the number of areas returned in each KML file.
Example call
http://webservices.esd.org.uk/comparisonGroups/AllBoroughInRegion_London/shape?pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=fIzjO17e3uQ+LeYhgUAlpUH1qxY=



/data

Returns table or values to populate a user specified table component. At minimum, 'area', 'metricType' and 'period' parameters are required.

Note that when the denominator metric type uses a different period type from the numerator. The first denominator period that has a "end date" less than the chosen numerator period is used with the denominator metric type.

Parameters

area
The area or comparison group that the data values are for.
Example call
http://webservices.esd.org.uk/data?area=E92000001&metricType=1&period=latest&ApplicationKey=ExamplePPK&Signature=iF74BiFw8jhEAEByW8b5DOHsrUU=
columnGrouping
Specify how the results will be grouped when viewed in a tabular format.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&outputType=table&columnGrouping=metricType&columnGrouping=period&ApplicationKey=ExamplePPK&Signature=0HTTJk8dl+yMCbpc3QhMPOCwLK4=
headerCellType
Whether the header cells should be labels or identifiers.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&headerCellType=label&ApplicationKey=ExamplePPK&Signature=ko7P51C4Vh1GjCZXha7Ik4geQVE=
includeMissing
If this is set to true, areas which do not have values will be included in the results.
Example call
http://webservices.esd.org.uk/data?metricType=3&area=AllLAInRegion_London&period=latest&includeMissing=true&ApplicationKey=ExamplePPK&Signature=pgMAVEdvV1JvFeA2ogHG/mWRT2s=
metricType
The metric type the data value is for.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&ApplicationKey=ExamplePPK&Signature=ia/zj5l7IAd+HC5d/f1UWEwJXms=
outputType
Format for which the data will be used. For example table or pie.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&outputType=table&ApplicationKey=ExamplePPK&Signature=zUI7NHaXuvmFwCAZTZ8Pok56y7U=
period
The time period that is to be returned. To just retrieve data for the latest available period, use "latest". For the most recent two time periods, use "latest:2", and so on. Otherwise one or more time period identifiers can be used.
Example call
http://webservices.esd.org.uk/data?period=latest:2&area=E92000001&metricType=1&ApplicationKey=ExamplePPK&Signature=Wt31EMNqRJGR+k3/pxSPz/BboE4=
rowGrouping
Specify how the results will be grouped when viewed in a tabular format.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&outputType=table&rowGrouping=metricType&ApplicationKey=ExamplePPK&Signature=G32wGrHn1cl8Yk/FrXPWh3m1v00=
summary
Use summaryType to define the type of summary and what will be summarised. Example summary types are sum, min and max.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=AllLAInCountry_England&period=latest&value.number=1&summary.summaryType=max&summary.summaryFor=area&ApplicationKey=ExamplePPK&Signature=GyqqqWKVOCK998tYRR0v/EL219o=
valueType
The type of value that is returned for each query is defined by the valueType parameter, examples are raw, rank and band.
Example call
http://webservices.esd.org.uk/data?metricType=1&area=E92000001&period=latest&value.valueType=direction&ApplicationKey=ExamplePPK&Signature=TaFcklnHHH+uXrM7Xu7zlmQT5V8=



/data/regression

Returns table or values to populate a user specified table component and includes a regression x1, y1, x2, y2 coordinate for the regression line between each pair of columns. As with /data, at minimum 'area', 'metricType' and 'period' are required. The regression values appear at the end of the data results.

Parameters

Same as /data method
Use the same parameters that are available for the /data method.
Example call
http://webservices.esd.org.uk/data/regression?metricType=1%2C11&area=AllLAInRegion_London&period=latest:2&value1.valueType=raw&outputType=table&columnGrouping=metricType&columnGrouping=period&rowGrouping=area&includeMissing=true&headerCellType=label&ApplicationKey=ExamplePPK&Signature=9X8rRyLTlbgwmlP7KNcIxhkWGEw=



/datasetCollections

The source from which the data used by any related datasets was obtained.

Example call




/datasetCollections/verbose

Full details of all sources used by datasets.

Example call




/datasetCollections/{identifier}

Full details of a particular source, using its identifier.

Example call




/datasets

Returns a list of datasets. Only basic details are provided including identifier, label and some others.

Example call




/datasets/{identifier}

Details about a particular dataset, using its identifier.

Example call




/dimensionMembers

List of all dimension members. Dimension members are synonymous with circumstances, and dimensions with cirumstance collections, as listed on the standards site. Dimension members may apply to multiple metric types, and each metric type can be related to multiple dimension members. For example the metric type for males aged 0-17 has the dimension members of both male in the gender dimension and 0-17 in the social aervices age bands dimension.

Example call




/dimensionMembers/verbose

Full details for all dimension members.

Example call




/dimensionMembers/{identifier}

Full details for a single dimension member, selected via the identifier.

Example call




/dimensions

Groups of related dimension members. Dimensions are synonymous with circumstance collections, as listed on the standards site.

Example call




/dimensions/verbose

List of all dimensions, giving their full details.

Example call




/dimensions/{identifier}

Full details of a single dimension, selected by its identifier.

Example call




/editor/config

Default configuration for the text token editor.

Example call

Parameters

area
Default text token editor settings for a particular area.
Example call
http://webservices.esd.org.uk/editor/config?area=E09000031&ApplicationKey=ExamplePPK&Signature=WClzFp2LiaC3V23nOijGe+M099A=
authorityArea
Set the authority area in the default text token editor settings.
Example call
http://webservices.esd.org.uk/editor/config?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=SX3NYC1Q/xwzW7/d8P7DkNrzBMQ=
childArea
Set the child area in the default text token editor settings.
Example call
http://webservices.esd.org.uk/editor/config?childArea=E05000590&ApplicationKey=ExamplePPK&Signature=/jO/S/fHLpgUuSEN/M68BQ7Z+CE=



/editor/fields

List of fields and their default labels.

Example call

Parameters

area
Default field labels in the text token editor for a particular area.
Example call
http://webservices.esd.org.uk/editor/fields?area=E09000031&ApplicationKey=ExamplePPK&Signature=Nr/1hh4k+poK/HSl6ByGeWj5ozE=
authorityArea
Default field labels in the text token editor for a particular authority area.
Example call
http://webservices.esd.org.uk/editor/fields?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=mjpg+C/CWU/mZCcpxA2bD/TlO3w=
childArea
Default field labels in the text token editor for a particular child area.
Example call
http://webservices.esd.org.uk/editor/fields?childArea=E05000590&ApplicationKey=ExamplePPK&Signature=2vrqPNqt/Izv3ckXpBJ6KVQ9Eng=



/editor/functions

List of functions available, and associated metadata.

Example call

Parameters

area
Default function list and labels for a particular area.
Example call
http://webservices.esd.org.uk/editor/functions?area=E09000031&ApplicationKey=ExamplePPK&Signature=CXkqtQYQH9H9rQ5lF4s0Vi979AY=
authorityArea
Default function list and labels for a particular authority area.
Example call
http://webservices.esd.org.uk/editor/functions?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=tNUT0TRHFyxquur6LuoG9yFMjVc=
childArea
Default function list and labels for a particular child area.
Example call
http://webservices.esd.org.uk/editor/functions?childArea=E05000590&ApplicationKey=ExamplePPK&Signature=qBArkIOScegfQZfniCHZ1Zpnmnw=



/incidentTypes

List of services related to service incidents within a particular area.




/incidents

Locations of reported service incidents, such as abandoned vehicles.

Parameters

authorityArea
Only incidents within a specific authority area. This parameter is compulsory.
Example call
http://webservices.esd.org.uk/incidents?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=ne1VaK8dorHXCLrtcTS46r77sj8=
dateRange
Include a date or date range to filter by. The following formats are valid: yyyy-MM, yyyy-MM-dd, yyyy-MM|yyyy-MM, yyyy-MM|yyyy-MM-dd, yyyy-MM-dd|yyyy-MM, yyyy-MM-dd|yyyy-MM-dd, earliest|latest
Example call
http://webservices.esd.org.uk/incidents?authorityArea=E09000031&dateRange=2015-01-01|2015-01-02&ApplicationKey=ExamplePPK&Signature=rWbefa8jFjep/l4vCrhBregwFvI=



/incidents/metadata

Overview of the service incident information for an area.

Parameters

authorityArea
Overview of service incidents for a particular area.
Example call
http://webservices.esd.org.uk/incidents/metadata?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=BXQmjFyhiRgYA+oR71WG3IhQVQc=



/incidents/shape

KML file containing a point for every service incident within a particular area.

Parameters

authorityArea
KML file with points for all service incidents within a particular area.
Example call
http://webservices.esd.org.uk/incidents/shape?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=v2KdVS11XV7zXDwmqOF8TwOk2Rc=
dateRange
Include a date or date range to filter by. The following formats are valid: yyyy-MM, yyyy-MM-dd, yyyy-MM|yyyy-MM, yyyy-MM|yyyy-MM-dd, yyyy-MM-dd|yyyy-MM, yyyy-MM-dd|yyyy-MM-dd, earliest|latest
Example call
http://webservices.esd.org.uk/incidents/shape?authorityArea=E09000031&dateRange=2015-01-01|2015-01-02&ApplicationKey=ExamplePPK&Signature=4nksyqC4XE7s+tDftXV3yQfX3CQ=
styleIconPrefix
Add some prefix text to the icon URL.
Example call
http://webservices.esd.org.uk/incidents/shape?authorityArea=E09000031&styleIconPrefix=IconPrefix&ApplicationKey=ExamplePPK&Signature=hlXTravA0ARb5KDOj6wIKL4nF6g=
styleIconScale
Change the default icon scale attribute from 0.3125 to a custom value.
Example call
http://webservices.esd.org.uk/incidents/shape?authorityArea=E09000031&styleIconScale=0.5&ApplicationKey=ExamplePPK&Signature=1m/hroSzYMnQ6V5O8qHSTxtghzs=



/incidents/shapeData

Returns detailed information about service incidents.

Parameters

authorityArea
Service incidents in an area grouped by geographical points at which they occurred.
Example call
http://webservices.esd.org.uk/incidents/shapeData?authorityArea=E09000031&ApplicationKey=ExamplePPK&Signature=HE6nUKQLk/l4WVOVdrWm+9KJ9eM=
dateRange
Include a date or date range to filter by. The following formats are valid: yyyy-MM, yyyy-MM-dd, yyyy-MM|yyyy-MM, yyyy-MM|yyyy-MM-dd, yyyy-MM-dd|yyyy-MM, yyyy-MM-dd|yyyy-MM-dd, earliest|latest
Example call
http://webservices.esd.org.uk/incidents/shapeData?authorityArea=E09000031&dateRange=2015-01-01|2015-01-02&ApplicationKey=ExamplePPK&Signature=KkdFYUePn1HHpGtGkBjxjxKUVDg=



/measurementUnits

Returns a list of all measurement units which are used for defining the units used in measures.

Example call




/measurementUnits/verbose

Full details of all measurement units.

Example call




/measurementUnits/{identifier}

Returns all details of one measurement unit using the idenitifer of the specified measurement unit.

Example call




/measures

Returns all measures as they relate to a particular dataset. These are usually split into fairly simple measurement types, such as count, or percentage of population, but can be more complex.

Example call




/measures/verbose

Returns full details of all dataset measures.

Example call




/measures/{identifier}

Returns all details of one measure, as selected by the identifier.

Example call




/metricDimensions

Metric dimension is a group of metric types having the same dataset, measure and all dimension members except for one dimension. Examples: "Employees - males, permanent by age (count)" "Employees - males, permanent by age (percentage)" ""Employees - by sex (percentage)". A dataset without dimensions has no metric dimensions.

Example call

Parameters

addNoneOption
As with metricTypeBreakdown, but with an additional "None" option.
Example call
http://webservices.esd.org.uk/metricDimensions?metricTypeBreakdown=1&addNoneOption=1&ApplicationKey=ExamplePPK&Signature=HdOff3AmRsO+U8yDskuYtI7gS2Q=
metricTypeBreakdown
Returns the metric dimensions by which a specified metric type (or pseudo-metric type) breaks down.
Example call
http://webservices.esd.org.uk/metricDimensions?metricTypeBreakdown=1&ApplicationKey=ExamplePPK&Signature=17Si6f+fVyRIWY63j/psUd4pTdo=



/metricDimensions/search

Returns metric dimensions for a particular search term.

Example call

Parameters

q
The search term to filter the results by.
Example call
http://webservices.esd.org.uk/metricDimensions/search?q=population&ApplicationKey=ExamplePPK&Signature=BFaGCxOrNQEvCK+C/wo8oQsed7I=
type
Filter results by type of item. In this case all results are "metricDimension", so adding a type will not further filter the results.
Example call
http://webservices.esd.org.uk/metricDimensions/search?q=population&type=metricDimension&ApplicationKey=ExamplePPK&Signature=Xgr9IzLbQZ0P/0pi+Soy9ttiwHM=



/metricDimensions/verbose

Full details of all metric dimensions.

Example call




/metricDimensions/{identifier}

Returns all details of one metric dimension using the identifier of the specified dimension.

Example call




/metricTypes

Returns a list of metric types. Only basic details are provided including identifier and label.

Example call

Parameters

aggregatable
Only include metric types whose area values can be aggregated together.
Example call
http://webservices.esd.org.uk/metricTypes?aggregatable=true&ApplicationKey=ExamplePPK&Signature=SAlkrvpmU59hUDdGNbKVOj5BOCc=
dataChangedSince
Only include metric types whose data has been updated since the date in question.
Example call
http://webservices.esd.org.uk/metricTypes?dataChangedSince=2013-12-20&ApplicationKey=ExamplePPK&Signature=pMtsPSMOn/N5KbnQAsDH3yzNjLU=
dataset
Filter by metric types belonging to a particular dataset.
Example call
http://webservices.esd.org.uk/metricTypes?dataset=6&ApplicationKey=ExamplePPK&Signature=Ijh8cAwmmsDYEKbvC9owy/BA0bU=
filterOff
Setting the filter as being off means that any checks for whether data will be accessible to you will be ignored
Example call
http://webservices.esd.org.uk/metricTypes?dataset=6&filterOff=1&ApplicationKey=ExamplePPK&Signature=PY1T2312NdjtBR3lqmS/9av+z7I=
measurementUnit
Filter by metric types of a particular measurement type.
Example call
http://webservices.esd.org.uk/metricTypes?measurementUnit=Quantity_1000_pounds&ApplicationKey=ExamplePPK&Signature=f7hFL3DZrYsYptc3y/kPAzvYGY4=
metadataChangedSince
Only include metric types whose metadata has been updated since the date in question.
Example call
http://webservices.esd.org.uk/metricTypes?metadataChangedSince=2013-12-20&ApplicationKey=ExamplePPK&Signature=MgUQGE3VbQSTXRFOApqwrpSOc3Q=
metadataOrDataChangedSince
Only include metric types whose data or metadata has changed since the day in question.
Example call
http://webservices.esd.org.uk/metricTypes?metadataOrDataChangedSince=2013-12-20&ApplicationKey=ExamplePPK&Signature=Hapz36I6EJ3jcZzCb46O/0HwWyI=



/metricTypes/forBreakdown

Returns a list of all metric types plus "pseudo" metric types to represent datasets where there is no metric type to represent 100% of the data. Pseudo metric types will be created for e.g. % of population by ethnicity where there is no metric type representing 100%. This method will return for each metric type (real and pseudo):identifier, label, indicator if the metric type is real or pseudo, flag to denote if there is a breakdown.

Example call




/metricTypes/search

Search through the metric types.

Example call

Parameters

q
The search term to filter the results by.
Example call
http://webservices.esd.org.uk/metricTypes/search?q=population&ApplicationKey=ExamplePPK&Signature=cauMkadQLdMwxZ0Tu06x/+5g1Og=
type
Filter results by type of item. In this case all results are "metricType", so adding a type will not further filter the results.
Example call
http://webservices.esd.org.uk/metricTypes/search?q=population&type=metricType&ApplicationKey=ExamplePPK&Signature=jpb3siiwzWkN05iSEHeRbC45FsY=



/metricTypes/updates.rss

A feed of metric types with new and changed metric type definitions and/or metric values. Without any parameters, metric types updated last night will be shown

Example call




/metricTypes/verbose

No arguments - returns all details for all metric types. As page sizes are limited, at minimum a page number parameter is required.

Parameters

application
The application the metric type is available in. This should be "esdStandards" for all metric types, "Inform" for just metric types used by LG Inform or "esdToolkit" for those used by LG Inform Plus. The pageSize parameter is required when using the application parameter.
Example call
http://webservices.esd.org.uk/metricTypes/verbose?application=Inform&pageNumber=3&pageSize=1&ApplicationKey=ExamplePPK&Signature=YjqpedXdgpu1G2CgZBT4WOpKvRw=
filterOff
Overrides any filters on the metric list to hide metric types unavailable to the current application or with security whose values may not be available. Some metric types will only return values through OAuth. The pageNumber parameter is required when using the filterOff parameter.
Example call
http://webservices.esd.org.uk/metricTypes/verbose?filterOff=true&pageNumber=3&pageSize=1&ApplicationKey=ExamplePPK&Signature=ZSfx/ojLh236c8xMSCBlmVbBqHc=
includePseudoMetricTypes
Includes a list of all pseudo metric types (those created by automated means as a total for groups of related metric types) at the end of the metric type results list.
Example call
http://webservices.esd.org.uk/metricTypes/verbose?includePseudoMetricTypes=true&pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=Xx4tmMOmFWwOxXpIvd3rsEGbjUE=
options
Only include specific items in the results. The options are T for tags, A for alternative labels, B for broken down by metric dimensions, DM for dimension members, R for related metric types, S for subjects, W for web service client application, M for measure, and D for dataset. The Pagenumber parameter is also required when using the option parameter.
Example call
http://webservices.esd.org.uk/metricTypes/verbose?options=DM,A&pageNumber=2&ApplicationKey=ExamplePPK&Signature=NDRnwDWCydd0nbwUn2R9M9+aViM=
pageNumber
The page number of the results set.
Example call
http://webservices.esd.org.uk/metricTypes/verbose?pageNumber=1&ApplicationKey=ExamplePPK&Signature=Y11ZlyqFvN8S3eu/nHmSZI5TaD0=
pageSize
Number of results per page to a maximum of 1300.
Example call
http://webservices.esd.org.uk/metricTypes/verbose?pageNumber=1&pageSize=2&ApplicationKey=ExamplePPK&Signature=pAyPF3hYxd4hgbiHMNm4fN0uHro=



/metricTypes/{identifier}

Returns details of a specified metric type.

Example call




/organisations

Returns basic details of organisations. With no parameters - will return a full list of organisations

Parameters

area
Return the local authorities responsible for the areas within which a specified GSS code or postcode comes.
Example call
http://webservices.esd.org.uk/organisations?area=sw98bj&ApplicationKey=ExamplePPK&Signature=EHLoFFCpuIbNGJUkDXB3QQBgv6U=
areaName
Return organisations that match an area name.
Example call
http://webservices.esd.org.uk/organisations?areaName=city&ApplicationKey=ExamplePPK&Signature=X/DfYYqTkqaNpYHzeevbUmYX4bs=
areaOwnersOnly
Return only organisations that are associated with a specific geographical area. This includes organisations such as local authorities and fire organisations, but not national organisations.
Example call
http://webservices.esd.org.uk/organisations?areaOwnersOnly=true&area=E09000031&ApplicationKey=ExamplePPK&Signature=/f8lls8DtwP1UNmdErQdcosMlGI=
areaType
Filter results to a particular area type.
informAccessOnly
Return only organisations that have have access to LG Inform.



/organisations/verbose

Full details of all organisations.




/organisations/{identifier}

Returns all details of one organisation, using the organisations metacode as an identifier.

Example call




/outliers/{identifier}

Returns all metric types whose value is 2 or more standard deviations from the mean for all English local authorities.

Example call

Parameters

area
A list of areas or a comparison group over which statistics should be calculated. The default is the comparison group "AllLaInCountry_England"
Example call
http://webservices.esd.org.uk/outliers/E06000039?area=Core_English_Cities&ApplicationKey=ExamplePPK&Signature=3wJh1a8ALjfMIK15Nm52iUGcLKE=
customBands
The custom threshold values beneath and/or above which outliers are defined. If more than two are used, only the first and/or last is considered.
Example call
http://webservices.esd.org.uk/outliers/E06000039?customBands=100,300&ApplicationKey=ExamplePPK&Signature=br+/Ox3u5qSWR82j7gVka2cQWNE=
metricType
A single metric type identifier, a comma separated list of metric type identifiers or a metric dimension identifier
Example call
http://webservices.esd.org.uk/outliers/E06000039?metricType=3531&ApplicationKey=ExamplePPK&Signature=4OsyUyOuP5MbcrUYo6qT8xV+y2M=
number
The minimum number of bands for quantiles and equal ranges (is the valueType parameter is set to either of these) OR the number of standard deviations from the mean. This defaults to 4 for all bands and 2 for standard deviations.
Example call
http://webservices.esd.org.uk/outliers/E06000039?number=3&ApplicationKey=ExamplePPK&Signature=oCG/RpSLdcHp0oEiLB4ZUmQLvbA=
outlierType
First or last defaulting to both, indicating if the first band, last band or both should be used to indicate an outlier
Example call
http://webservices.esd.org.uk/outliers/E06000039?outlierType=first&ApplicationKey=ExamplePPK&Signature=c8gn1rbaQOUlpp9JY6+WFzVNiUs=
valueType
The means of defining bands, which must be one of: band for quantiles, equalRanges for equal ranges, standardDeviations for standard deviations (which is the default), and customBand for custom bands.
Example call
http://webservices.esd.org.uk/outliers/E06000039?valueType=equalRanges&ApplicationKey=ExamplePPK&Signature=PULabQKh5uhPFsu/k67CiOCFFXA=



/periodTypes

Returns time period types used by the system.

Example call




/periodTypes/verbose

Full details of all time period types used by the system.

Example call




/periodTypes/{identifier}

Full details of a single specified time period type.

Example call




/periods

Returns time periods. No parameters returns all available time periods.

Example call

Parameters

excludeFuturePeriods
Exclude any time periods which are in the future.
Example call
http://webservices.esd.org.uk/periods?periodType=CalendarYear&excludeFuturePeriods=1&ApplicationKey=ExamplePPK&Signature=XzWtedmP1gtGi8GM1NGGUctyCEE=
periodType
Only return time periods of a particular time period type.
Example call
http://webservices.esd.org.uk/periods?periodType=CalendarYear&ApplicationKey=ExamplePPK&Signature=iptJXvq4c9CN1HVYkwVpDtSEAAs=



/periods/filter-data

Filters time periods by data availability specified in parameters. At minimum a metricType parameter is required.

Parameters

area
Time periods for which a particular area or comparison group has metric type values.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&ApplicationKey=ExamplePPK&Signature=BBtvCT+tXm+FoemClvo3y4y0OzA=
areaType
Only include time dates for a particular area type.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=1&area=AllLAInCountry_England&areaType=LondonBorough&ApplicationKey=ExamplePPK&Signature=K+2aNghYicnFntwnrxZuTqu69nU=
from
Include time periods from a particular time period onwards.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&from=sch_2011_12&ApplicationKey=ExamplePPK&Signature=bZ8+7yiBl/aLU8zE9Y/lBaAOXJI=
includeMissing
Include time periods which do not have values but fill gaps, so time periods are consecutive. By default missing time periods are included.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=11&area=E06000053&includeMissing=0&ApplicationKey=ExamplePPK&Signature=E03NBKnI7Jt0X0feLUHxCpdkhMQ=
metricDimension
Filter to periods applicable to a specific metric dimension.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricDimension=[531][531_Standardised_mortality_ratio][Disease]&ApplicationKey=ExamplePPK&Signature=eNIfN7bW9HloWrIwCQFJtToKjXE=
metricType
Filters time periods for which a particular metric type has values.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=1&ApplicationKey=ExamplePPK&Signature=MG/SOdP8NSlG401wk/0w7wY/QC4=
strict
Setting to 0 means when including an area group, only a single area needs to have a value for the time period to be returned. Without this where an area group is specified, all areas need to have a value for the time period to be included.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&strict=0&ApplicationKey=ExamplePPK&Signature=AAUm0/wZ6RPe8GoSN/8nKcbbx0M=
to
Include time periods up until a particular time period.
Example call
http://webservices.esd.org.uk/periods/filter-data?metricType=3&area=AllLAInRegion_London&to=sch_2011_12&ApplicationKey=ExamplePPK&Signature=xyX6WL5aEwcyNK62ydpXntPx/Ic=



/periods/{identifier}

Full details of a particular time period.

Example call




/shapes

Returns a single KML file containing all of the shapes listed.

Parameters

area
Returns the KML for the area or comparison group.
Example call
http://webservices.esd.org.uk/shapes?area=E09000031&ApplicationKey=ExamplePPK&Signature=sj1a4/DCqQTjVoVyctKzh5LhpCA=
changedSince
Only include shapes whose data has been updated since the specified date
Example call
http://webservices.esd.org.uk/shapes?area=AllLAInRegion_London&changedSince=2012-06-15&ApplicationKey=ExamplePPK&Signature=eU/BOhE70YGWk/UyTYkudXkmVJc=
pageNumber
Larger calls can be split into different pages. All calls are automatically limited to 500 areas. Use this attribute to find subsequent pages.
Example call
http://webservices.esd.org.uk/shapes?area=AllBoroughInRegion_London&pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=BGNT+qSJy9OwKKlWhAfvdm2nk/A=
pageSize
Limit the number of areas returned in each KML file.
Example call
http://webservices.esd.org.uk/shapes?area=AllBoroughInRegion_London&pageNumber=2&pageSize=1&ApplicationKey=ExamplePPK&Signature=BGNT+qSJy9OwKKlWhAfvdm2nk/A=



/subjects

Subjects which have associated metric types.

Example call




/subjects/verbose

Full details for all subjects, including associated metric types.

Example call




/subjects/{identifier}

Returns subject details, including a flat list of descendant subjects at any level (not just direct children). Every subject in a list includes information about its direct parent/parents. Metric types associated with the specified subject are given. Descandants and parents are sorted in alphabetical order of subject label.

Example call




/textToken

This web method should not be used on its own. Text token web methods retrieve small strings of text which are used to be inserted into reports based on the variables in the parameters.




/textToken/compare

Text describing if one value is greater than, equal to or less than another. The text is user-defined meaning that synonyms can be used, e.g. higher, identical, lower, etc. Most useful for comparing means, medians, percentages, etc., rather than absolute values or totals, for example, the percentage of pensioners within a ward that live alone compared to those in the country.

Parameters

area
Filter areas by comparison group or GSS code.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=WnWIjR3Ifxg0ItjNxx44kGws1NY=
equal
Customise output when compared areas are equal. Defaults to 'equal to'.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E92000001&withArea=E92000001&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=K9jOBAYANKrD4n5axfm3MNelPfY=
greater
Customise output when area is greater than compared area. Defaults to 'greater than'.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E92000001&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=e8K35HZrC35481zVT1yMM2BOzBo=
less
Customise output when area is less than compared area. Defaults to 'less than'.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E12000008&withArea=E92000001&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=q1XhLwtZgHEczwKaOLE37NVyYcw=
metricType
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=WnWIjR3Ifxg0ItjNxx44kGws1NY=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&period=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=8wEj+jWt3ldExAYmk0nE0Pp1EKY=
summaryType
Filter by summary type. Defaults to mean.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&summaryType=mean&withSummaryType=mean&period=latest&withPeriod=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=Ay/lFDegft+yGCW9VN0jI5jUac0=
withArea
Choose area for this specific comparison.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=WnWIjR3Ifxg0ItjNxx44kGws1NY=
withPeriod
Choose period for this specific comparison. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&period=latest&withPeriod=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=RoF2krMEsmtmD3+qmma2yddiiM8=
withSummaryType
Choose summary type for this specific comparison. Defaults to mean.
Example call
http://webservices.esd.org.uk/textToken/compare?metricType=3282&area=E10000011&summaryType=mean&withSummaryType=mean&period=latest&withPeriod=latest&withArea=E12000008&greater=greater than&equal=equal to&less=less than&ApplicationKey=ExamplePPK&Signature=Ay/lFDegft+yGCW9VN0jI5jUac0=



/textToken/countAreas

A count of the area types in a given bounding area. For example, the number of wards within an authority.

Parameters

area
Choose area following by area type to be counted.
Example call
http://webservices.esd.org.uk/textToken/countAreas?area=E92000001:Region&ApplicationKey=ExamplePPK&Signature=+vKCPzRRN/CrC2q0BIt1SOLxNN8=



/textToken/derived

A method for extracting derived values (for example sums, and averages) for a metric type.

Parameters

area
Filter areas by comparison group or GSS code.
Example call
http://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=KIudgsmBKWVz8YmkpLLjCiJr5rw=
metricType
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=KIudgsmBKWVz8YmkpLLjCiJr5rw=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&period=latest&ApplicationKey=ExamplePPK&Signature=FN7nUF4V+ZykdQhlb8iS5AYS8Ug=
valueType
Choose type of value to be used in summary. Defaults to 'raw'.
Example call
http://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&valueType=rank&ApplicationKey=ExamplePPK&Signature=/l+RDPBp4KENGk0yrqxjUMQkTmk=
withArea
Area or comparison group for second value in calculation. Either this or withPeriod must be specified, unless the valueType is percentDifferenceFromEquivalent or percentDifferenceFromLast.
Example call
http://webservices.esd.org.uk/textToken/derived?metricType=201&area=E09000010&withArea=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=KIudgsmBKWVz8YmkpLLjCiJr5rw=
withPeriod
Period identfier for second value in calculation. Either this or withArea must be specified, unless the valueType is percentDifferenceFromEquivalent or percentDifferenceFromLast.



/textToken/equivalent

The equivalent value in a chosen area of the predominant circumstance collection in the area covered by the report. For example, if the predominant gender in a lower-level area is male, this token can return the equivalent value for males in the region.

Parameters

area
Filter areas by comparison group or GSS code
Example call
http://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&ApplicationKey=ExamplePPK&Signature=lDVgXHSen42+vGEnvAbuajTXMeM=
for
Area for which equivalent area is read.
Example call
http://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&ApplicationKey=ExamplePPK&Signature=lDVgXHSen42+vGEnvAbuajTXMeM=
metricDimension
Filter by group of related metrics.
Example call
http://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&ApplicationKey=ExamplePPK&Signature=lDVgXHSen42+vGEnvAbuajTXMeM=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&period=cen_2011&ApplicationKey=ExamplePPK&Signature=cJsXvywF6PWXqZxezoYyrku9DQE=
rank
Filter by rank within an area. Defaults to top rank.
Example call
http://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&rank=2&ApplicationKey=ExamplePPK&Signature=0A5+k0CqdPyrqg6cwl3YZJPzraw=
returnValue
Format of returned value. Defaults to 'value'.
Example call
http://webservices.esd.org.uk/textToken/equivalent?metricDimension=[424][424_PercentageofONSpopulationcount][Agestructure]&area=E07000064&for=E10000011&returnValue=valueWithUnits&ApplicationKey=ExamplePPK&Signature=WOmfBRsW31vFhyQycl3PFY6KUIw=



/textToken/evaluate

Evaluates a text token. The "eval" parameter is the token you want evaluated, and the "area" parameter is the area you are interested in.

Parameters

area
Main area for text token to be evaulated against.
Example call
http://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E07000064&ApplicationKey=ExamplePPK&Signature=0Pbf518xghKKvnrBQPa/aG27478=
authorityArea
Authority area for text token to be evaulated against.
Example call
http://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E05003966&authorityArea=E07000064&ApplicationKey=ExamplePPK&Signature=+zPFKfVBIiBNZ2q5M6JFn3/3+kg=
childArea
Child area for text token to be evaulated against.
Example call
http://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E05003966&childArea=E05003966&ApplicationKey=ExamplePPK&Signature=b/oOSHxD6D3D5U00im0gAXFrGtA=
eval
Text token to be evaluated in report writer syntax. Examples of calls that can be used are "countAreas", "comparison-group-label", "period-label", "period-type-label", and "metric-type-label". Ampersands need converting to "%26".
Example call
http://webservices.esd.org.uk/textToken/evaluate?eval={=countAreas?area={region-identifier}:{parent-area-type-identifier}}&area=E07000064&ApplicationKey=ExamplePPK&Signature=0Pbf518xghKKvnrBQPa/aG27478=



/textToken/metricTypeMetadata

Details about a selected metric type. Returns the metric type's title (label) by default but can be configured to return a short title, data source, metric collection, a description of the metric type, its polarity rule or the data it was last updated.

Parameters

metricType
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/metricTypeMetadata?metricType=1&ApplicationKey=ExamplePPK&Signature=eJKoCsABwQ2yXMH9YLlFNzWPy6U=
returnValue
The type of metadata to return. Defaults to 'label'.
Example call
http://webservices.esd.org.uk/textToken/metricTypeMetadata?metricType=1&returnValue=helpText&ApplicationKey=ExamplePPK&Signature=mj+5DzBFP2VjUxbZq26s5U2d8pM=



/textToken/percent

The value of an area's metric displayed as a percentage of another area's value.

Parameters

area
Filter areas by comparison group or GSS code
Example call
http://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=M5/yVB415yop3uq/1QrEAMRm1/k=
metricType
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&ApplicationKey=ExamplePPK&Signature=M5/yVB415yop3uq/1QrEAMRm1/k=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&period=cal_2013&ApplicationKey=ExamplePPK&Signature=KFNkMLVrr+39CxqqgVhf2D2Ru7w=
withArea
Area or comparison group for second value in percentage calculation. Either this or withPeriod must be specified.
Example call
http://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&withPeriod=cal_2013&ApplicationKey=ExamplePPK&Signature=CaMsZsgtk3l12565u50M7Sv/1WM=
withPeriod
Period identifier for second value in percentage calculation. Either this or withArea must be specified. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/percent?metricType=1&area=E10000002&withArea=AllCountiesInCountry_England&withPeriod=cal_2013&ApplicationKey=ExamplePPK&Signature=CaMsZsgtk3l12565u50M7Sv/1WM=



/textToken/rankedMetricType

The nth ranked label or value of a metric dimension for an area. Most useful for displaying predominant groups. It's easiest to build these tokens using the text token editor.

Parameters

area
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=P4h/bWNa5wUCtQJRoZv/lrqigLg=
metricDimension
Filter by group of related metrics.
Example call
http://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&ApplicationKey=ExamplePPK&Signature=P4h/bWNa5wUCtQJRoZv/lrqigLg=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&period=latest&ApplicationKey=ExamplePPK&Signature=wVCdv3XWSSa9GRhkhGZHbPr7QyA=
rank
Desired rank. Defaults to top.
Example call
http://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&rank=2&ApplicationKey=ExamplePPK&Signature=S6aEEEl8IsRydn5Q8rA4v7rXXDs=
returnValue
Format of returned value. Defaults to 'label'.
Example call
http://webservices.esd.org.uk/textToken/rankedMetricType?metricDimension=[37][37_PerCent][Ethnicity]&area=AllBoroughInRegion_London&returnValue=ValueWithUnits&ApplicationKey=ExamplePPK&Signature=Ky+3f0eFuquE8HTomRgmWRdHRKI=



/textToken/smallAreaChart

Chart showing how a metric breaks down within a users area

Parameters

area
Filter areas by comparison group or GSS code
metricType
Filter by metric type.
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.



/textToken/smallAreaMap

Map showing how a metric breaks down within a users area

Parameters

area
Filter areas by comparison group or GSS code
metricType
Filter by metric type.
period
Filter by a particular time period or select "latest" for the latest time period. Default to 'latest'.



/textToken/smallAreaTable

Table showing how a metric breaks down within a users area

Parameters

area
Filter areas by comparison group or GSS code
metricType
Filter by metric type.
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.



/textToken/summary

The summary value of a metric type for an area type within a bounding area. For example, the mean number of houses in a ward within a chosen region.

Parameters

area
Filter areas by comparison group or GSS code
Example call
http://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&ApplicationKey=ExamplePPK&Signature=w3Wvfmg4H8t/vCA0a8u7spQVHvc=
metricType
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&ApplicationKey=ExamplePPK&Signature=w3Wvfmg4H8t/vCA0a8u7spQVHvc=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&period=latest&ApplicationKey=ExamplePPK&Signature=Bm9C/L/tRudAHxwT6+oATahD+Qg=
summaryType
Choose type of summary value needed. Defaults to 'sum'.
Example call
http://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&summaryType=mean&ApplicationKey=ExamplePPK&Signature=lZ0zbOeA0wym4A3FsnSTKvEecNc=
valueType
Choose type of value to be used in summary. Defaults to 'raw'.
Example call
http://webservices.esd.org.uk/textToken/summary?metricType=3259&area=E12000002:Unitary&valueType=rank&ApplicationKey=ExamplePPK&Signature=35FkyN+k74sZxc4kNgkP0+A9ZwM=



/textToken/value

Returns the value of a metric type for an area and period. Defaults to the latest figures for the ward.

Parameters

area
Filter areas by comparison group or GSS code
Example call
http://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&ApplicationKey=ExamplePPK&Signature=hqNmMAOjNbq3rrO8nUyR6H9q0NY=
metricType
Filter by metric type.
Example call
http://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&ApplicationKey=ExamplePPK&Signature=hqNmMAOjNbq3rrO8nUyR6H9q0NY=
period
Filter by a particular time period or select "latest" for the latest time period. Defaults to 'latest'.
Example call
http://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&period=latest&ApplicationKey=ExamplePPK&Signature=hhaXFDkLeBpsIM4bVzFZvNDxH+I=
returnValue
Format of returned value. Defaults to 'value'.
Example call
http://webservices.esd.org.uk/textToken/value?metricType=3259&area=E12000002&returnValue=ValueWithUnits&ApplicationKey=ExamplePPK&Signature=+5VwIqgBtJ5Fr4urAhVV1BTd5zg=



/users

Full list of all users

Parameters

area
Filter areas by comparison group or GSS code
informAccessOnly
Limit to users who have permission to access the LG Inform system.
organisation
List users from a particular organisation.
userStatus
Use "all" for all users, "active" for current active users, and "left" for users who have left.



/users/current

Returns details of current user, as identified by OAuth parameters




/users/verbose

Return full details from all users.

Parameters

userStatus
Use "all" for all users, "active" for current active users, and "left" for users who have left.



/users/{identifier}

Returns all details for user as included by user identifier

Example call




/valueTypes

Returns a grouping of summary or derived value types, such as sum, average, maximum, minimum, and median. Needs at least a group parameter.

Parameters

group
Name for the group of summary types.
Example call
http://webservices.esd.org.uk/valueTypes?group=esd_reports&ApplicationKey=ExamplePPK&Signature=gsAVR/YAli9YBOlw9zEX3R+Twu0=
metricType
Filter by metric type or metric types.
Example call
http://webservices.esd.org.uk/valueTypes?group=esd_reports&metricType=1&ApplicationKey=ExamplePPK&Signature=CHjES8X1NdiMT290Sji8X/C2Vk4=



/valueTypes/verbose

Full list of the available summary or derived types.

Example call