Hover Jobs Overview
What are Jobs?
Jobs are the core aspect of Hover's API. In their simplest form, jobs are individual structures or floors within a structure that you are requesting measurements for. They are the base unit on which much of Hover is conceptually built around.
Jobs can be created through the Hover API, the Hover mobile app (available on iOS and Android), or on the Hover website.
Consider this simplified representation of a Hover job object:
{
"name": "Hover Drive", //a user-facing name to identify the job
"deliverable_id": 3, //the type of measurement being ordered
"location_line_1": "123 Hover Drive", //the street address of the job
"location_city": "Carmel", //the city of the job
"location_region": "CA", //the state or region of the job
"location_postal_code": "46033", //the zipcode of the job
"id": 12345678, //the job's unique identifier, set by HOVER
"captured_user_id": 135318, //the id of the user who captured the job
"external_identifier": "EXAMPLE-ID-123", //a custom identifier users can attach to a job
"org_id": 100, //the id of the organization who created the job
}
Jobs represent the request and creation of a deliverable (type of measurement being ordered) and provide information such as the User who captured the job, the location of the job, and the Org (organization) that created the job. There are several types of deliverables that HOVER offers for various use cases, such as our Roof-Only reports for users who only need to obtain detailed measurements and information about the roof of a structure.
Scope of Jobs
For exterior-based captures, a HOVER job will be an individual structure on a property: common examples are a main structure (house), a detached garage, or a shed. Each of these structures will be represented as an individual HOVER job.
For interior-based captures, a Hover job will be an individual floor of the structure. Each room on a single floor can be contained within a single job, but individual stories within a structure are represented as unique jobs.
You may want to associate multiple jobs together for the purposes of your integration. For example, you may want to bring back the individual jobs for the main structure, garage, and shed associated with one customer back into your application. Please reference the Multi-Structure for Integrated Customers guide for various methods to accomplish this workflow.
Deliverable Types
All Jobs in Hover have a uniquejob_id
and deliverable type. The type of deliverable associated with this job is represented as a deliverable_id
.
To learn more about deliverable types please see our Deliverable Types guide here.
Note: Some deliverables can be upgraded or changed to another deliverable type. Supported deliverable changes are listed below, but more documentation about Deliverable Change Requests is available here.
Updated about 1 month ago