bcgov / bcgov/STRR

API Data Requirements for STR to Data Portal

Open
#1,384 3 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

**Context**
The STR Data Portal receives listing data from all platforms, and this data is expected to include the registration number. Our goal is to pull selected registry data into the Data Portal so that CEU staff—and potentially local government staff—can access it as needed. The Registry API should support a call to match a single specific registration number provided by the Data Portal

**User Story**
**Given** a user is on the STR Data Portal,
**When** they click the Listing Details button on the Listing View,
**Then** they are directed to the Listing Details page,
**And** they will be able to view the associated registry information.

Registration Number and relevant info

- Registration number
- Registration status
- Registration Date
- Expiry date (if registration status is active or expired)
- Cancelled date (if registration status is cancel)
- Suspend date (if registration status is suspend)
- Specific Conditions on the Registration

For the registration for hosts, show the following:

STR Unit Information

- STR Unit Address
- Property type
- Type of space
- Rental unit setup
- Ownership type (owner, co-owner, renter, other)
- PID

Property Host Info

- Host type (individual vs business)
- Full name
- Preferred name
- CRA #
- DOB
- Residential address
- Phone number
- Email
- Business legal name (if type is business)
- Business number (if type is business)

Co-host information

- Full name
- Preferred name
- Mailing address
- Phone number
- Email

Property Manager information

- Type (individual vs business)
- Full name
- Preferred name
- Mailing address
- Phone number
- Email
- Business legal name (if type is business)
- Business number (if type is business)

Business Licence Information

- BL number
- BL Expiry Date

For the registration for strata hotels, show the following:

Strata Hotel Representative(s)

- Full name
- Phone number
- Email
- Position/Title

Business Information

- Legal Name
- Mailing Address

Strata Hotel Information

- Name
- Website
- Category
- Number of Rental Units
- Strata Hotel building address(es)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Registry API and Data Portal integration described in the issue, focusing on the single-registration-number lookup in the user story. Done means the lookup can return the specified registration, host, co-host, manager, business licence, and strata hotel information for the applicable registration type.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.