bcgov / bcgov/STRR

SPIKE - Can we get PID via API to BC Data Warehouse

Open
#1,430 9 comments 0 reactions 0 assignees View on GitHub
STR
Dominant language
Python
Stars
2
Forks
22
Avg merge
2d 35m
Merged PRs (30d)
11

Description

## Objective
The purpose of this SPIKE is to explore and develop a solution that enables our system to automatically retrieve the Parcel Identification Number (PID) associated with a property parcel whenever a user enters their address into our system. This will involve integrating ParcelMap BC through the BC Data Warehouse API and ensuring real-time or near-real-time retrieval of PIDs.

## Background
ParcelMap BC provides a digital representation of parcel boundaries across British Columbia, including PIDs. By leveraging the integration between ParcelMap BC and the BC Data Warehouse, we aim to automate the retrieval of PIDs based on user-provided addresses, enhancing the user experience and streamlining data collection processes.

## Goals

1. **Understand API Integration**
- Identify the relevant API endpoints within the BC Data Warehouse that interact with ParcelMap BC for address-based PID retrieval.
- Confirm that these APIs support real-time querying based on user input.

2. **Real-Time Data Retrieval**
- Investigate how to structure our system’s API calls to ensure that PID retrieval occurs seamlessly as users enter their address.
- Assess the response time and data accuracy of the PID retrieval process to meet user experience standards.

3. **User Interface and Workflow Integration**
- Determine how to integrate this API call into our existing user interface (UI), ensuring that the PID is retrieved without disrupting the user’s workflow.
- Explore options for handling cases where no PID is found or where multiple PIDs might be associated with a single address.

4. **Error Handling and Validation**
- Implement robust error handling to manage cases where the API call fails or returns unexpected data.
- Validate the retrieved PID against our existing data to ensure consistency and correctness.

5. **Security and Compliance**
- Ensure that the retrieval process complies with privacy regulations and that sensitive data, such as PIDs, is handled securely.
- Review any additional security measures required for accessing and storing PIDs within our system.

6. **Documentation and Support**
- Compile documentation on the integration process, including API usage, error codes, and best practices for handling PIDs.
- Identify and engage with technical support from the BC Data Warehouse or ParcelMap BC if needed.

## Deliverables
- A working prototype that automatically retrieves a PID based on a user-entered address in our system.
- Documentation outlining the API integration process, including how to handle various edge cases.
- A report detailing the performance of the API calls, including any limitations or challenges encountered.
- Recommendations for further development or optimization based on the prototype’s performance.

## Timebox
Allocate 3-4 days for this investigation and prototype development, including research, coding, and documentation.

## Team Members
- [Assign team members here]

## Resources
- [BC Data Service API documentation](https://digital.gov.bc.ca/resources)
- [ParcelMap BC API and data access details](https://www.ltsa.ca/parcelmap-bc)
- [BC Address Geocoder API documentation](https://bcgov.github.io/data-publication/pages/dps_loc_address_geocoder.html)

## Notes
- Ensure that the solution is user-friendly and does not add noticeable delays to the user’s workflow.
- Document findings and steps clearly to support future iterations or potential scaling of this feature.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.