Sign in

v1

latestOpenAPI 3.0.12026-07-1481717.4 KB
Interests

Return interests that have been published on a register as a collection of CSVs packaged in a ZIP file.

If the result set is an empty, an empty ZIP will be returned.

get/api/v1/Interests/csv

Query parameters

MemberIdinteger

Search for an interest created by member with this ID.

CategoryIdinteger

Search for an interest with associated category with this ID.

PublishedFromstring date

Search for an interest published on or after this date.

PublishedTostring date

Search for an interest published on or before this date.

RegisteredFromstring date

Search for an interest registered on or after this date.

RegisteredTostring date

Search for an interest registered on or before this date.

UpdatedFromstring date

Search for an interest which has any updates on or after this date.

UpdatedTostring date

Search for an interest which has any updates on or before this date.

RegisterIdinteger

Search for an interest published in a register with this ID. If not provided, default value is latest register ID.

IncludeFieldDescriptionsboolean

Returns a metadata file for each category, containing a list of fields which are available for a member to add further information about the interest.

Response

OK