Federal Register Connector

info@ismena.com

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The Federal Register Connector facilitates seamless integration with the Federal Register API, providing access to published documents, public inspection documents, agency details, images, and suggested searches. This connector acts as a proxy to streamline data retrieval, supporting actions for fetching individual or multiple documents, searching documents, retrieving issue tables of contents, and accessing agency and search metadata. It supports JSON, XML, and CSV response formats and is optimized for deployment on Google Cloud Platform (GCP).

Integration Overview

This document provides a detailed guide for each integration point, its purpose, configuration, and workflow support using the Federal Register Connector.

getDocument: Fetches a single Federal Register document by document number.
getMultipleDocuments: Fetches multiple Federal Register documents by document numbers.
searchDocuments: Searches all Federal Register documents with various conditions.
getFacetCounts: Retrieves counts of documents grouped by a specified facet.
getIssueTOC: Fetches the table of contents for a specific Federal Register issue.
getPublicInspectionDocument: Fetches a single public inspection document.
getMultiplePublicInspectionDocuments: Fetches multiple public inspection documents.
getCurrentPublicInspectionDocuments: Fetches all current public inspection documents.
searchPublicInspectionDocuments: Searches all public inspection documents.
getAllAgencies: Retrieves details for all federal agencies.
getAgency: Fetches details for a specific agency by slug.
getImage: Retrieves image variants and metadata by identifier.
getSuggestedSearches: Fetches all suggested searches, optionally filtered by section.
getSuggestedSearch: Fetches details for a specific suggested search by slug.

Detailed Integration Documentation

Single Document Retrieval

Action	getDocument
Purpose	Retrieves metadata and details for a specific Federal Register document by document number, useful for accessing specific regulatory information.
Parameters	Required: document_number: Federal Register document number (string, e.g., 2019-24499). format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include in the response (array of strings, e.g., title,abstract).
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP deployment, configure the connector in a Cloud Function or Cloud Run service.
Output	Successful: Returns a JSON, XML, or CSV object with: abstract: Document abstract (string). agencies: Array of agency objects with name and slug. document_number: Document number (string). publication_date: Publication date (string, format: YYYY-MM-DD). title: Document title (string). type: Document type (RULE, PRORULE, NOTICE, PRESDOCU). Failure: Returns error details (e.g., status: 404, message: Document not found).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getDocument action with document_number=2019-24499 and format=json. Process the response to display document details in a GCP-hosted application.

Multiple Documents Retrieval

Action	getMultipleDocuments
Purpose	Retrieves metadata and details for multiple Federal Register documents by document numbers, useful for batch processing.
Parameters	Required: document_numbers: Comma-separated list of document numbers (string, e.g., 2019-24499,2019-24500). format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include in the response (array of strings, e.g., title,abstract).
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP deployment, store document numbers in Cloud Storage for batch processing.
Output	Successful: Returns a JSON, XML, or CSV object with: count: Number of documents (integer). results: Array of document objects with abstract, agencies, document_number, publication_date, title, type. Failure: Returns error details (e.g., status: 400, message: Invalid document numbers).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getMultipleDocuments action with document_numbers=2019-24499,2019-24500 and format=json. Store results in Google BigQuery for analysis.

Document Search

Action	searchDocuments
Purpose	Searches Federal Register documents published since 1994 using various conditions, useful for regulatory research.
Parameters	Required: format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include (array of strings, e.g., title,abstract). per_page: Results per page (integer, default: 20, max: 1000). page: Page number (integer, default: 1). order: Sort order (string, enum: [relevance, newest, oldest, executive_order_number], default: relevance). conditions[type]: Document type (RULE, PRORULE, NOTICE, PRESDOCU). conditions[agency_ids][]: Agency IDs (array of integers). conditions[publication_date][year]: Publication year (integer). conditions[publication_date][gte]: Publication date ≥ (string, YYYY-MM-DD). conditions[publication_date][lte]: Publication date ≤ (string, YYYY-MM-DD). conditions[term]: Search term (string). conditions[president]: President identifier (string, e.g., barack-obama). conditions[presidential_document_type]: Presidential document type (string, e.g., executive_order). conditions[docket_id]: Docket ID (string).
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP deployment, use Cloud Scheduler to automate searches.
Output	Successful: Returns a JSON, XML, or CSV object with: count: Number only if fields are not specified (integer). description: Search description (string). results: Array of document objects with abstract, agencies, document_number, publication_date, title, type. Failure: Returns error details (e.g., status: 400, message: Invalid query parameters).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the searchDocuments action with format=json and conditions[type]=RULE. Display results in a GCP-hosted dashboard.

Facet Counts Retrieval

Action	getFacetCounts
Purpose	Retrieves counts of Federal Register documents grouped by a specified facet, useful for analyzing document distributions.
Parameters	Required: facet: Facet to group by (string, e.g., agency, type). Optional: conditions[type]: Document type (RULE, PRORULE, NOTICE, PRESDOCU). conditions[agency_ids][]: Agency IDs (array of integers). conditions[publication_date][year]: Publication year (integer).
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP deployment, use BigQuery for facet analysis.
Output	Successful: Returns a JSON object with: facets: Array of objects with name (string) and count (integer). Failure: Returns error details (e.g., status: 400, message: Invalid facet).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getFacetCounts action with facet=agency. Store facet counts in Google BigQuery for visualization.

Issue Table of Contents Retrieval

Action	getIssueTOC
Purpose	Retrieves the table of contents for a specific Federal Register issue, useful for navigating daily publications.
Parameters	Required: publication_date: Publication date (string, format: YYYY-MM-DD, e.g., 2023-01-01). format: Response format (string, enum: [json, xml, csv]). Optional: None
Configuration	Ensure the connector is configured with the base URL via CONNECTOR_ENV_FEDERALREGISTER_BASE_URL. For GCP deployment, use Cloud Scheduler for daily retrieval.
Output	Successful: Returns a JSON, XML, or CSV object with: publication_date: Issue date (string, format: YYYY-MM-DD). documents: Array of document objects with abstract, agencies, document_number, title, type. Failure: Returns error details (e.g., status: 404, message: Issue not found).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getIssueTOC action with publication_date=2023-01-01 and format=json. Display the table of contents in a GCP-hosted application.

Single Public Inspection Document Retrieval

Action	getPublicInspectionDocument
Purpose	Retrieves metadata and PDF link for a specific public inspection document, useful for pre-publication access.
Parameters	Required: document_number: Document number (string). format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include (array of strings).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, store PDFs in Cloud Storage.
Output	Successful: Returns a JSON, XML, or CSV object with document details (e.g., abstract, document_number, pdf_url). Failure: Returns error details (e.g., status: 404, message: Document not found).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getPublicInspectionDocument action with document_number and format=json. Store the PDF in GCP Cloud Storage.

Multiple Public Inspection Documents Retrieval

Action	getMultiplePublicInspectionDocuments
Purpose	Retrieves metadata and details for multiple public inspection documents, useful for batch processing.
Parameters	Required: document_numbers: Comma-separated list of document numbers (string). format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include (array of strings).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, use Cloud Storage for outputs.
Output	Successful: Returns a JSON, XML, or CSV object with: count: Number of documents (integer). results: Array of document objects with abstract, document_number, pdf_url. Failure: Returns error details (e.g., status: 400, message: Invalid document numbers).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getMultiplePublicInspectionDocuments action with document_numbers and format=json. Store results in Google BigQuery.

Current Public Inspection Documents Retrieval

Action	getCurrentPublicInspectionDocuments
Purpose	Retrieves all current public inspection documents, useful for monitoring recent filings.
Parameters	Required: format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include (array of strings). per_page: Results per page (integer, default: 20). page: Page number (integer, default: 1).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, use Cloud Scheduler for periodic retrieval.
Output	Successful: Returns a JSON, XML, or CSV object with: count: Number of documents (integer). results: Array of document objects with abstract, document_number, pdf_url. Failure: Returns error details (e.g., status: 400, message: Invalid parameters).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getCurrentPublicInspectionDocuments action with format=json. Store results in Google BigQuery for monitoring.

Public Inspection Documents Search

Action	searchPublicInspectionDocuments
Purpose	Searches all public inspection documents, useful for finding pre-publication documents.
Parameters	Required: format: Response format (string, enum: [json, xml, csv]). Optional: fields[]: Fields to include (array of strings). per_page: Results per page (integer, default: 20). page: Page number (integer, default: 1). order: Sort order (string, enum: [relevance, newest, oldest]).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, use Cloud Scheduler for automated searches.
Output	Successful: Returns a JSON, XML, or CSV object with: count: Number of documents (integer). results: Array of document objects with abstract, document_number, pdf_url. Failure: Returns error details (e.g., status: 400, message: Invalid parameters).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the searchPublicInspectionDocuments action with format=json and order=newest. Display results in a GCP-hosted dashboard.

All Agencies Retrieval

Action	getAllAgencies
Purpose	Retrieves details for all federal agencies listed in the Federal Register, useful for regulatory analysis.
Parameters	Required: None. Optional: fields[]: Fields to include (array of strings, e.g., name,slug).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, store agency data in BigQuery.
Output	Successful: Returns a JSON object with: results: Array of agency objects with id, name, slug, description. Failure: Returns error details (e.g., status: 500, message: Server error).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getAllAgencies action. Store agency data in Google BigQuery for analysis.

Single Agency Retrieval

Action	getAgency
Purpose	Retrieves details for a specific agency by slug, useful for targeted agency information.
Parameters	Required: slug: Agency slug (string, e.g., environmental-protection-agency). Optional: fields[]: Fields to include (array of strings, e.g., name,description).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, use Cloud Run for API calls.
Output	Successful: Returns a JSON object with id, name, slug, description. Failure: Returns error details (e.g., status: 404, message: Agency not found).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getAgency action with slug=environmental-protection-agency. Display agency details in a GCP-hosted application.

Image Retrieval

Action	getImage
Purpose	Retrieves image variants and metadata by identifier, useful for accessing visual assets.
Parameters	Required: identifier: Image identifier (string). Optional: None.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, store images in Cloud Storage.
Output	Successful: Returns a JSON object with: identifier: Image identifier (string). variants: Array of objects with size, url, width, height. Failure: Returns error details (e.g., status: 404, message: Image not found).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getImage action with identifier. Store images in GCP Cloud Storage for rendering.

Suggested Searches Retrieval

Action	getSuggestedSearches
Purpose	Retrieves all suggested searches, optionally filtered by section, useful for guiding user queries.
Parameters	Required: None. Optional: section: Federal Register section to filter searches (string).
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, cache results in Memorystore.
Output	Successful: Returns a JSON object with an array of suggested search objects (slug, title, section, query). Failure: Returns error details (e.g., status: 500, message: Server error).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getSuggestedSearches action with optional section. Display suggested searches in a GCP-hosted search interface.

Single Suggested Search Retrieval

Action	getSuggestedSearch
Purpose	Retrieves details for a specific suggested search by slug, useful for targeted query suggestions.
Parameters	Required: slug: Suggested search slug (string). Optional: None.
Configuration	Ensure the connector is configured with the base URL via the CONNECTOR_ENV_FEDERALREGISTER_BASE_URL environment variable. For GCP deployment, use Cloud Run for API calls.
Output	Successful: Returns a JSON object with slug, title, section, query. Failure: Returns error details (e.g., status: 404, message: Search not found).
Workflow Example	Configure the connector with the base URL in GCP Secret Manager. Execute the getSuggestedSearch action with slug. Integrate the search query into a GCP-hosted application.

Workflow Creation with the Connector

Example Workflow: Regulatory Document Analysis

Got it! Here’s your content structured with the **listings as row headings**:

Retrieve Agency Information	Use the getAllAgencies action to fetch a list of federal agencies and identify agencies of interest (e.g., environmental-protection-agency).
Search Relevant Documents	Execute the searchDocuments action with `format=json`, `conditions[agency_ids][]` for selected agencies, and `conditions[type]=RULE`. Process results to extract relevant documents.
Export and Analyze Documents	Use the getDocument action with `document_number` and `format=csv` for specific documents. Store CSV files in GCP Cloud Storage and analyze using Google BigQuery.

This workflow enables applications to explore agency details, search regulatory documents, and analyze data, enhancing regulatory compliance and research capabilities on GCP.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to Wired for Banking