Customer civic data

Create a polling subscription over the change feed

Limited, machine-only release. Creates one feed bound to the authenticated customer and to the exact API key that made the request. No caller-supplied account, customer, credential, or key identifier is accepted, and the binding and the resource filter are immutable once created. Many feeds may share one key. The name is unique per account and key among live feeds: posting the same live name with the same resource returns the existing feed instead of creating a second one, and the same name with a different resource is refused. The response carries the start cursor captured from the feed high-water position at creation, so a client that stores it can poll from that point on. If the feed state cannot be read, the request fails and creates nothing.

post/api/v1/data/subscriptions

Request

  • Base URL: https://aicdapi.com
  • URL: https://aicdapi.com/api/v1/data/subscriptions
  • Auth: HTTP bearer

Request body

namestring required

A caller-chosen name, unique per account and key among live feeds, of 1 to 80 characters after trimming.

resource'jurisdictions' | 'public_bodies' | 'source_endpoints' | 'topics' | 'meetings' | 'documents' | 'agenda_items' | 'topic_matches' | 'classification_evidence' | 'civic_events' | 'aliases' nullable

One resource name from the civic data catalog (CivicResource), or null to cover every resource. Omitting the field means null. The value is pinned for the feed's life.

Response

This name and resource already had a live feed for this account and key, so the existing feed is returned rather than a second one being created.

Changes

No recorded changes to this operation across all 1 revision of this API.