Business Items service
Overview
The Order Paper services have been developed to serve tabled Order Paper business items that have been assigned a business type (i.e. not unspecified). These services are available for consumption and are documented below.
Two services are provided. A query string can be attached to filter the business items by date and by business type (based on whether the business type appears on a list of Effectives, Future Business A and Announcements). Both endpoints require an authentication key to validate the request. The second endpoint retrieves a list of Future Business B business items - this endpoint does not require any additional parameters.
URLs and parameters
This endpoint returns a list of tabled business items with a date. If no parameters are supplied (other than the authentication key) then the business type defaults to any that appears on the Effectives. The default date range is from the current date to the last date for which there are any tabled business items on the Effectives list.
URL: /businessitems/tableditemswithdaten.{format}?{query}
The second endpoint returns all Future Business B items and does not accept any parameters other than the authentication key.
URL: /businessitems/tableditemswithoutdate.{format}
| Parameter | Description |
|---|---|
| key | A key to authenticate the request. |
| fromDate | Date range start date (string: yyyy-MM-dd). |
| toDate | Date range end date (string: yyyy-MM-dd). |
| type | Can be "effectives", "futurea" or "announcements" |
Output Formats
The following output formats are available, to be included in the query:
| Format | Description |
|---|---|
| xml | Xml output, available on both services. |
| json | Json output, available on both services. |
Example URLs
/businessitems/tableditemswithdate.json?key=123
/businessitems/tableditemswithdate.xml?key=123
/businessitems/tableditemswithdate.xml?key=123&fromDate=2015-01-31&toDate=2016-02-28&type=effectives
/businessitems/tableditemswithdate.json?key=123&fromDate=2015-01-31&toDate=2016-02-28&type=futurea
/businessitems/tableditemswithdate.xml?key=123&fromDate=2015-01-31&toDate=2016-02-28&type=futurea
/businessitems/tableditemswithoutdate.json?key=123
/businessitems/tableditemswithoutdate.xml?key=123