Query Offices by Region

reapit / foundations

Foundations platform mono repo

57 stars 21 forks source link

Query Offices by Region #10712

Closed abrahamseni closed 7 months ago

abrahamseni commented 7 months ago

Our client needs to query Offices by Region

Context: /offices?region='east' or can we use extrasField for this?

Expected return values: offices within the region.

Specification

Project: Reapit.Services.Offices
Add new string Region property to OfficeModel that exposes the semi structured field offices.extra.oRegion
Add new string Region property to GetOfficesQuery that allows filtering on this value. Typically we wouldn't do this with it being a semi structured field, however that is a fairly finite number of rows in this table which is relatively small even on larger databases so we shouldn't see any overly noticeable issues with performance. The largest table across the estate only has 860 rows.
When GetOfficesQuery.Region is present, filter as appropriate. It's likely acceptable to just do this in memory (after fetching only offices with a region using LIKE), but if not, each database has a GetExtra function that can be used for this purpose)

github-actions[bot] commented 7 months ago

Thank you for raising a feature request. Feature requests will be prioritised in accordance with our roadmap, customer and developer priorities. This request will be reviewed in our weekly refinement sessions and assigned to a specific project board or column, depending on the nature of the request and the development work required. For more information on our processes, please click here

rochellelevy commented 7 months ago

@HollyJoyPhillips would it be possible to get this into your next sprint? This is our last couple of weeks with them and we would like to get the work completed.

HollyJoyPhillips commented 7 months ago

Hi @rochellelevy, it needs to go through refinement first to understand if it's possible/how much development work is involved. Once we have that we will be able to look at allocation. We have refinement tomorrow. Thanks.

rochellelevy commented 7 months ago

@HollyJoyPhillips thank you!

AshDeeming commented 7 months ago

Hi @abrahamseni Access for the fields mentioned above has been set up and should become active within the next 15 minutes. Region-> oRegion

abrahamseni commented 7 months ago

Thanks @AshDeeming ,

We can access the oRegion but we also need to query the offices by region, i.e: /offices?region='lettings country' and give back the results of offices in that region.

abrahamseni commented 7 months ago

Also, can you help me with the region list? Where can we access it?

rochellelevy commented 7 months ago

@AshDeeming @HollyJoyPhillips can you help Abraham please?

AshDeeming commented 7 months ago

Hi @rochellelevy & @abrahamseni the initial work to add 'Region' has been completed =-however this ticket has now been updated to review the Parameter request too