NYCPlanning / labs-zap-search

Search application for the DCP Zoning Application Search
https://zap.planning.nyc.gov
13 stars 3 forks source link

Research spike: Querying for projects with recently completed milestone for land use fee paid. #1528

Open TylerMatteo opened 1 month ago

TylerMatteo commented 1 month ago

The goal of this research spike is to show a proof of concept of how we might query for the data we think we'll need for the ZAP Listserv project. One criteria we may use to trigger notifications is to look for projects that have completed certain milestones on a rolling basis (nightly, weekly, etc). In this spike, we will try performing a query on the CRM UAT2 environment using CRM's OData API, the same API we use in the ZAP Search and Applicant Portal APIs.

For this spike, there are three CRM entities to be aware of:

The query should return a list of projects with associated Project Milestone entities that meet the following criteria:

Possible approaches

I'm open to however the engineer(s) working on this want to tackle this but one approach might be to build on the existing code in the ZAP Search or Applicant Portal APIs that facilitate querying for projects with OData. Another might be to simply build a raw OData query for the this list of projects to call the OData endpoint directly in a tool such as Postman.

Effort

As spikes are meant to be time boxed, I'm suggesting we limit time spent on this to about half a sprint with two engineers collaborating on it.

Desired Outcomes

horatiorosa commented 1 month ago

@TylerMatteo what were the new req for the spike you mentioned late last week?

TylerMatteo commented 1 month ago

Pulling out in favor of #1529