DTC-705 Support additional RentCafe API parameter#395
Conversation
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
There was a problem hiding this comment.
Code Review
This pull request updates the RentCafe availability slots documentation by adding a description for the noOfDays parameter and updating the example request. Feedback was provided to improve consistency with other API documentation, including refining the terminology and adding an introductory sentence to the parameters section.
| ### Parameters | ||
|
|
||
| | Parameter | Required | Description | | ||
| |---|---|---| | ||
| |`noOfDays`| No | The number of days in the future for which available appointment slots will be returned. For example, a value of `1` will return available appointments for today and tomorrow. Value cannot be greater than 90. If left blank, returns available timeslots for the next 90 days. If the property is configured to display fewer days than requested, the property's configured maximum will be used instead. | |
There was a problem hiding this comment.
For consistency with other API documentation files in this repository (e.g., _rentcafe_apartment_availability.md), consider adding an introductory sentence for the parameters section. Additionally, using "omitted" is more precise than "left blank" for optional API parameters, and using consistent terminology like "appointment slots" instead of mixing it with "timeslots" improves clarity.
| ### Parameters | |
| | Parameter | Required | Description | | |
| |---|---|---| | |
| |`noOfDays`| No | The number of days in the future for which available appointment slots will be returned. For example, a value of `1` will return available appointments for today and tomorrow. Value cannot be greater than 90. If left blank, returns available timeslots for the next 90 days. If the property is configured to display fewer days than requested, the property's configured maximum will be used instead. | | |
| ### Parameters | |
| When using the GET index method, the results will be filtered using these parameters: | |
| | Parameter | Required | Description | | |
| |---|---|---| | |
| |`noOfDays`| No | The number of days in the future for which available appointment slots will be returned. For example, a value of `1` will return available appointment slots for today and tomorrow. The value cannot exceed 90. If omitted, the API returns available appointment slots for the next 90 days. If the property is configured to display fewer days than requested, the property's configured maximum will be used instead. | |
References: DTC-705
Code PR: https://github.com/GannettDigital/rentcafe/pull/34