Overview
The Measurements PDF provides a detailed, printable report of a property's measurements. This endpoint facilitates retrieving that report for a designated model.
The model ID is typically retrieved in a couple of ways:
- When a model-related webhook event is triggered the
model_idwill be included in the event payload sent to a registered webhook. The measurement PDF is not available until a model has been successfully reconstructed. - Using the List Jobs or Show Job Details endpoint will return
model_id(s) associated with a parent job. Additionally, this endpoint returns a link to thisGETrequest within anartifactsobject.
The Measurement PDF is available for all deliverable types . Successfully using this endpoint will result in a 200 OK response and you'll be redirected to the file that's stored in Hover.
Storage Considerations
Hover generally recommends storing a link to the Measurements PDF in your system of record rather than storing the entire file. This approach is more efficient as PDF file sizes can be substantial, depending on the property's complexity and deliverable type.
-
When to Store a Link:
If all users in your system who need to view the PDF also have appropriate access to the corresponding job within Hover, storing just the link is the ideal solution. When a user clicks this link, they will be redirected directly to the PDF file, leveraging Hover's hosting and access controls. -
When to Store the File:
If there are users in your system who require access to the Measurements PDF but do not have direct access to the job in Hover, then you will need to download and store the PDF file directly within your own system. This ensures they can view the document without needing Hover login or permissions.