-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: short term rental registry (platform) (#180)
* docs: short-term rental registry (platform) * updated the name of the product, minor text changes, added the temporary GW Url
- Loading branch information
1 parent
ac3a43e
commit e685946
Showing
6 changed files
with
771 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,11 @@ | ||
export enum ProductNames { | ||
MHR = 'Manufactured Home Registry', | ||
PPR = 'Personal Property Registry', | ||
BN = 'Business Number', | ||
PAY = 'Pay', | ||
RS = 'Registry Search', | ||
BR = 'Business Registry', | ||
CONNECT = 'SBC Connect', | ||
MHR = 'Manufactured Home Registry', | ||
NR = 'Names Request', | ||
CONNECT = 'SBC Connect' | ||
PAY = 'Pay', | ||
PPR = 'Personal Property Registry', | ||
RS = 'Registry Search', | ||
STRR = 'Short-Term Rental Registry', | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# Used to populate product card components | ||
name: Short-Term Rental Registry (Platform) | ||
description: Validate the registration and key elements of listing details against Short-Term Rental Registrations. | ||
badge: BETA | ||
bulletPoints: | ||
- Validate a single permit. | ||
- Validate permits in batches | ||
- Retrieve the requirements for a single address. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
--- | ||
title: 'Overview' | ||
description: 'Short-Term Rental Registry API (Platform)' | ||
--- | ||
|
||
# Short-Term Rental Registry API (Platform) | ||
|
||
--- | ||
|
||
## Overview | ||
|
||
The Short-Term Rental Registry contains all of the Hosts, Strata Title Hotels and Motels, and Platforms that can operate in the Province of British Columbia. | ||
|
||
<p> | ||
This API is used to validate a permit against the Short-Term Rental Registry. | ||
It is also used to determine the requirements of an address in the Province of BC. For example, an address may be in an area that requires a business permit, or may be entirely exempt from being required to register. | ||
</p> | ||
|
||
<br> | ||
|
||
::ButtonDownloadSpec{href="https://okagqp-test-bcregistryapis.apigee.io/portals/api/sites/okagqp-test-bcregistryapis/liveportal/apis/strrproxy/download_spec"} | ||
:: | ||
|
||
<br> | ||
|
||
**Note:** All requests must include a **BC Registries issued API key** and an **Account ID**. | ||
|
||
--- | ||
|
||
## View the API | ||
|
||
View the definition and select a path to try it out. To submit a request you will need an API key and an account ID, which are obtained as part of completing an [access request](/products/get-started/api-access-request). To set your session API key, click on the top, right AUTHORIZE button and under API Key Auth enter your key value. Click on AUTHORIZE, then OK. | ||
|
||
<a href="https://okagqp-test-bcregistryapis.apigee.io/docs/strrproxy/1/overview" target="_blank">> View the API</a> | ||
|
||
--- | ||
|
||
## Fees | ||
|
||
There are no fees to use the API. | ||
<br> | ||
Only registered platforms in good standing can access the API. | ||
|
||
--- | ||
|
||
## API Quick Reference | ||
|
||
Please refer to the online spec. | ||
|
||
This section will get populated once the release-candidate / sandbox is available. | ||
|
||
--- | ||
|
||
## Date and Date Time Formats | ||
|
||
Dates, without a time are considered a fixed date regardless of timezone. For regulatory purposes all dates are acted upon in 'Pacific' time. | ||
|
||
All data with times are in UTC, both submitted and retrieved via the API. These can be displayed in local time for end users. For legal purposes the effective and legal dates are in the 'Pacific' timezone. | ||
|
||
--- | ||
|
||
## API Version History | ||
|
||
<table> | ||
<tr> | ||
<th>Date</th> | ||
<th>Version</th> | ||
<th>Description</th> | ||
</tr> | ||
<tr> | ||
<td>2025-01-20</td> | ||
<td>0.1.0</td> | ||
<td>Pre-Release</td> | ||
</tr> | ||
</table> | ||
|
||
--- | ||
|
||
## Additional Resources | ||
|
||
- Refer to the <a href="https://www.bcregistry.gov.bc.ca/" target="_blank">BC Registry site</a> to open an account and see all the Registry services. | ||
|
||
- Refer to the <a href="https://discourse.onebc.ca/" target="_blank">Discourse Community site</a> to answer any API and service related questions. | ||
|
||
--- | ||
|
||
## Page History | ||
|
||
Updates of note to this page are recorded here. | ||
|
||
<table> | ||
<tr> | ||
<th>Date</th> | ||
<th>Description</th> | ||
</tr> | ||
<tr> | ||
<td></td> | ||
<td></td> | ||
</tr> | ||
</table> |
Oops, something went wrong.