bcgov / bcgov/reserve-rec-api

Connect with fee register API

Open
#172 1 comment 0 reactions 0 assignees View on GitHub
Reservations
Dominant language
JavaScript
Stars
2
Forks
7
Avg merge
15h 49m
Merged PRs (30d)
57

Description

#### Description:
In order to support on the calculation of park fees, we need to connect to the fee register via API.

#### Development Checklist:

- [ ] Create a fee endpoint in our reserve rec api to make the get requests to the data register
- [ ] This endpoint will need to support querying by including ORCS, Facility, Activity
- [ ] Add proper error handling for Data Register API failures
- [ ] Add response validation to ensure fee data structure is correct
- [ ] Create fee calculation logic using base nightly rate from API response
- [ ] Ensure all environments have correct DATA_REGISTER_URL
- [ ] Ensure all environments have valid DATA_REGISTER api key setup.

#### Dependencies

- Blocked by https://github.com/bcgov/reserve-rec-api/issues/177
- Blocking

**Relevant documentation as reference**
[Fee Register example Doc](https://bcgov.sharepoint.com/:w:/r/teams/031072/Shared%20Documents/%5B2%20-%20Portfolio%5D%20Parks-Rec%20Digital%20Transformation/6%20-%20Portfolio%20Planning/Fee%20register/feereg%20Doc.docx?d=w102262777bd94cbbaccd367ed62b8d03&csf=1&web=1&e=2NVlDA)

**Definition of Ready**

- [ ] Acceptance criteria are included
- [ ] Wireframes are included (if applicable)
- [ ] Design / Solution is accepted by Product Owner (if applicable)
- [ ] Dependencies are identified (technical, business, regulatory/policy)
- [ ] Story has been estimated (under 13 pts)

**Definition of Done**
- In progress:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] UI meets accessibility requirements
- [ ] Unit tests are written
- [ ] Work is traceable in GitHub
- [ ] PR linked to ticket number
- [ ] If needed/required - Dev adds flag/label to highlight any migration steps necessary prior to PROD deployment

- Code review:
- [ ] Code is peer reviewed and has passed CI/CD tests

- QA:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] Code is potentially shippable to the production environment
- [ ] Functional features have been tested and passed by QA
- [ ] UI components tested by designer
- [ ] Code is deployed to PROD when moved to 'done' column (unless requested otherwise by PO)

- PO Review:
- [ ] Acceptance criteria are tested (Functionality meets the acceptance criteria defined in the ticket)
- [ ] Reviewed and approved by Product Owner

#### Notes:
- No need to set up new api keys, we can leverage pre-existing connection with data reg api.
-

Contributor guide

No contributing guide indexed for this repository

Research direction

No files or tests are named. Start by inspecting the existing data-register connection and reserve rec API entry points, then review blocking issue #177. Done means the fee endpoint supports the listed query fields, handles API failures, validates responses, calculates from the nightly rate, and has tested environment configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.