Requests

Once successfully configured and enabled, Jadu will send requests to the specified URIs for the following actions:

• Property search by postcode
• Fetch a single property by identifier
• Street search by street name
• Fetch a single street by identifier

Full request URIs are constructed by Jadu by prefixing the relevant path with the value of base_uri. Trailing slashes will be stripped from the end of base_uri and the start of the _path values before concatenating them together with a single forward slash in between.

Arguments are sent with the request, inserted into the URIs where the relevant placeholders are given. Values used in these arguments will be prepared before sending as follows:

• Trailing whitespace stripped
• URL-encoded

All of the requests should respond with an HTTP 200 status code on success, and a body containing a JSON string listing any matching results.

Any non-200 status code will be treated by Jadu as an error and logged.

If Jadu is not able to parse the response body into a JSON object, an error will be logged.

Any additional data returned within a JSON object will be ignored by Jadu. Additional data will not cause an error.

If any error occurs, the response body will not be processed as address data but may be logged.

Individual requests are detailed in subsequent sections.