Complete Data Source LocalInfo Request
- Kim Stimpson
- Simon Chapman
Here you would make the getdata request passing in the uid, x and y or the areaid. You can always make a Cookie Type Request which requires the atLocation cookie to be passed across.
/getdata.aspx?RequestType=LocalInfo&ms=Workshop/MyHouse&format=JSON&group=Council%20and%20Democracy|Council_Tax_Info&uid=141164155969 /getdata.aspx?RequestType=RSS&ms=Workshop/MyHouse&group=Council%20and%20Democracy|Council_Tax_Info&x=161000&y=152000
Parameter | Definition | Required |
|---|---|---|
RequestType | This should be LocalInfo or RSS. LocalInfo is the correct usage, RSS is retained for backwards compatibility and will default to RSS format rather than using the XSL set in the configuration. | YES |
ms | The MapSource that you are requesting information from (NB:This must be MyHouse, e.g. ms=Workshop/MyHouse) | YES |
format | This is an optional parameter which is used to indicate the format of the response. If not specified then the name of the file in the RSSXSL setting is used as a default (see Required Studio Settings). If specified then iShare looks for an XSL file with a name of atLocalInfoFormat.xsl to use to transform the data. i.e. If the parameter format=JSON then it will look for a file called atLocalInfoJson.xsl. Supplied formats, other than the default of XML, at present are JSON and JSONP. | NO |
group | This should be of the form layergroup|layer which means you get information on a specific layer. Alternatively this can be layergroup which means you will get information on all layers in that group (prior to v5.4.4 only supported for RSS). | YES |
layer 5.4.2+ | This parameter overrides the layer passed in with the layergroup (layergroup|layer) in the above group parameter, and can now be either the layer's display name or layer name. | NO |
uid | This is an optional parameter which is the UPRN of a property. If this is specified, it ignores any cookie information. UPRN not to be used with areaid. | NO |
x and y | These are optional parameters for co-ordinates to use to lookup the data. If they are both specified, it ignores any cookie information. If one or other is missing then the other is ignored. | NO |
| distance | This is an optional parameter and must be used in conjunction with the above x and y co-ordinates. This allows you to return results within the supplied distance from the x and y co-ordinates. | NO |
areaid | This is the areaid for the Area Search Layer configured for your My House MapSource in Studio. | NO |