DATA PORTAL API

[mbertucci]

📖 User Story As the system admin for the Data Portal Team I want to pull the registration information via API So that I can view the information in my system

Context

Local governments use Data Portal to see listing data provided by the platform such as Airbnb and VRBO. LG can see all listings at a glance on an aggregate view. If they want to see some details of a listing, they can view all details in a listing details page. This page is where our STRR data should be displayed. Data Portal will call our API once it's on the detailed listing page.

Aggregate View

Listing Details Page

📏 Business Rules:

• [ ] Data Portal receives registry data for a specific listing when users are on the details listing page (Note: Data Portal is not going to ask us to give them all the registry data for all registrations. The API call is likely to be made one by one when user is redirected to the listing details page)
• [ ] Data Portal provides registration # to STR Registry
• [ ] The registration # could be in any status
• [ ] If the registration # can be found in the STR Registry, show the data elements collected from application form as well as registration information including registration #, status (active, expired, cancelled, suspended), Date of registration, and Date of Expiration.
• [ ] If the registration # cannot be found in the STR Registry, xxx
• [ ] Match the registration # provided by Data Portal to our registration # in the system by stripping out any symbols that are not a a letter or digit (i.e., #,-) or spaces from both numbers and seeking an exact match between the two values. (Rationale: the registration number is provided by the hosts through platforms, we do not know if hosts enter the exact number and format listed on the certificate)
• [ ] If API fails (i.e., due to outage or other reasons), Data Portal will receive an error message.

Data Elements STRR Collected

This is for host registration form only, excluding property manager registers on behalf of their clients.

DOB, SIN and Business (GST) number are collected per request by FIN and they will share this info with CRA. Therefore, we should not display this information to LG but can still collect it from STR registry and share it with FIN via API.

Property Host

• First name, middle name and last name (either pulled from BC Service Card or input by users)
• Preferred name (optional)
• Date of birth
• Social Insurance Number
• Business (GST) number (optional)
• Phone number
• Extension (optional)
• Fax number (optional)
• Email address
• Mailing address (integrated with Canada Post Address Complete)
• Country
• Address Line 1
• Address Line 2 (optional)
• City
• Province
• Postal Code
• Business legal name (if register as a business)
• Role in the business (if register as a business)

Secondary Contact Information (optional)

• First name, middle name(optional) and last name

• Preferred name (optional)

• Date of birth (optional)

• Social Insurance Number (optional)  

• Business (GST) number (optional)

• Phone number

• Extension (optional)

• Fax number (optional)

• Email address

• Mailing address (integrated with Canada Post Address Complete)

• Country

• Address Line 1

• Address Line 2 (optional)

• City

• Province

• Postal Code

• Role in the business (if register as a business)

  STR Property

• Nickname (optional)

• Rental unit address

• PID (optional)

• Local government business licence (optional)

• Local Government business licence expiry date (required if LG BL # is provided)

• Ownership type (Rent, Own, Co-own)

• The property I am offering for short-term rental is Entire Home or Shared Accommodation

• If entire home, what type of entire home are you renting? (picklist)

• If shared accommodation, what type of space is being shared? (picklist)

• Platform URL(s) (optional and can be multiple)

Principal Residence Requirement

This is the page where we ask hosts if their STR units has PR requirement or exempted. If their STR units has PR requirement applied, they need to upload supporting documents to prove their PR status. If they STR units are exempted, they need to provide reasons for exemptions.

• Reasons for exemption (picklist including Located in exempt community, Eligible strata hotel or motel, Farm land (BCA Farm Class 9), Other exempt accommodation service providers)
• If “Other exempt accommodation service providers is selected“, choose category including §  timeshare, fractional ownership, home exchange, lodge (operator of outdoor recreational activity), educational institution accommodation (student or employee), strata corporation guest suite.

Registration Details

• Registration #, status (active, expired, cancelled, suspended), Date of registration, and Date of Expiration.

[mbertucci]

Hi Stefanie,

We will review ​docx icon 23330 Data Portal API.docx with dev team on Thursday’s backlog refinement meeting. Can you review this user story and let us know if you want any additional information from us? My proposal is to give you all application data (what hosts provide in the application) and registration data (including date of registration, expiry date, registration status and registration #). One thing to consider is what happens when we cannot find the registration # provided by platform in our system? Maybe we just send a message to indicate no registration # match can be found in our system and Data Portal can flag it for enforcement.

Our application data includes DOB, SIN and Business/GST number (optional) as requested by FIN who will share this information with CRA. We can give you this information and you can hide them from Local Government view but share this information to the FIN via API. Just my thoughts…

Later we may need an update to the API because:

We don’t support property manager to register on behalf of their clients now. Once we have this functionality built, we can give you supplier host information. We don’t support hosts/examiners to update hosts’ contact information or other key information after submission. Therefore, the information may not be up to date. We have a feature in the roadmap that key information can be updated in the backend after submission and registration is issued.

Thanks,

Fiona

[shaangill025]

2 APIs needed:

• GET endpoint to return list of registration number for all active registrations
• GET endpoint to return registration data/info for the provided registration number

[jdyck-fw]

They will provide a specially provided security token when accessing our API.

[thorwolpert]

It should use the same pattern of access as all our APIs. You decide to publish, or not, the OAS to our developer's site.