latestOpenAPI 3.0.12026-08-23113673.3 KB

acb20cfa91b9

EagleView

Get eagle view order report

This service will return information about a single report.

get/v1/eagleview/order/report/{reportId}

Path parameters

reportIdinteger required

The unique identifier for the report

Response

successful operation

If failed, return messageCode, refer to API Response Message Code.

Example

{ "messageCode": "1001", "message": "Validation exception" }

isPrivateboolean

This report is private report

ProductPrimaryId99 | 31 | 32 | 13 | 14 | 84 | 102 | 46 | 47 | 11 | 12 | 62 | 63 | 90 | 91 | 85 | 86 | 35

Provides more details on the order's progress through the fulfilment process. ReportSubStatus under ‘Pending’ ReportStatus may require action from the user to complete the order.

  • 99 - Full House™
  • 31 - Premium - Residential
  • 32 - Premium - Commercial
  • 13 - Claims Ready - Residential
  • 14 - Claims Ready - Commercial
  • 84 - Bid Perfect™
  • 102 - Bid Perfect™ - Commercial
  • 46 - Gutter - Residential
  • 47 - Gutter - Commercial
  • 11 - EagleView Inform Essentials+ (for residential)
  • 12 - EagleView Inform Essentials+ for Commercial
  • 62 - EagleView Inform Advanced
  • 63 - EagleView Inform Advanced for Commercial
  • 90 - TrueDesign™ for Sales
  • 91 - TrueDesign™ for Planning
  • 85 - Walls, Windows, & Doors
  • 86 - Walls
  • 35 - Commercial - Walls Only
ProductPrimary'Full House™' | 'Full House™' | 'Premium - Residential' | 'Premium - Commercial' | 'Claims Ready - Residential' | 'Claims Ready - Commercial' | 'Bid Perfect™' | 'Bid Perfect™ - Commercial' | 'Gutter - Residential' | 'Gutter - Commercial' | 'EagleView Inform Essentials+ (for residential)' | 'EagleView Inform Essentials+ for Commercial' | 'EagleView Inform Advanced' | 'EagleView Inform Advanced for Commercial' | 'TrueDesign™ for Sales' | 'TrueDesign™ for Planning' | 'Walls, Windows, & Doors' | 'Walls'

Provides more details on the order's progress through the fulfilment process. ReportSubStatus under ‘Pending’ ReportStatus may require action from the user to complete the order.

  • 99 - Full House™
  • 31 - Premium - Residential
  • 32 - Premium - Commercial
  • 13 - Claims Ready - Residential
  • 14 - Claims Ready - Commercial
  • 84 - Bid Perfect™
  • 102 - Bid Perfect™ - Commercial
  • 46 - Gutter - Residential
  • 47 - Gutter - Commercial
  • 11 - EagleView Inform Essentials+ (for residential)
  • 12 - EagleView Inform Essentials+ for Commercial
  • 62 - EagleView Inform Advanced
  • 63 - EagleView Inform Advanced for Commercial
  • 90 - TrueDesign™ for Sales
  • 91 - TrueDesign™ for Planning
  • 85 - Walls, Windows, & Doors
  • 86 - Walls
  • 35 - Commercial - Walls Only
ProductDeliveryId4 | 7 | 8 | 45

Available DeliveryProductId

  • 4 - ExpressDelivery
  • 7 - ThreeHourDelivery
  • 8 - RegularDelivery
  • 45 - QuickDelivery
ProductDelivery'ExpressDelivery' | 'ThreeHourDelivery' | 'RegularDelivery' | 'QuickDelivery'

Available DeliveryProductId

  • 4 - ExpressDelivery
  • 7 - ThreeHourDelivery
  • 8 - RegularDelivery
  • 45 - QuickDelivery
StatusId1 | 2 | 3 | 4 | 5

Shows the high level status of the report that has been ordered.

  • 1 - Created - The order has been created within the EagleView system.
  • 2 - InProcess - The report has been created and is progressing through the steps of our workflow.
  • 3 - Pending - Awaiting customer response.
  • 4 - Closed - The report is closed.
  • 5 - Completed - The report has been delivered.
SubStatusId5 | 6 | 8 | 9

Provides more details on the order's progress through the fulfilment process. ReportSubStatus under ‘Pending’ ReportStatus may require action from the user to complete the order.

  • 5 - UnderReview - Images for the report are being reviewed.
  • 6 - ProcessStarted - The measuring process has been started.
  • 8 - NeedToID - The order is on hold and is pending structure and/or address identification by the customer. Request is sent by email and requires the customer to either 1) identify which structures should be measured or, 2) verify the address.
  • 9 - Duplicate - The order has been closed because two identical orders were placed by the customer. An email is also
DisplayStatus'Created' | 'In Process' | 'Pending' | 'Closed' | 'Completed'

Provides more details on the order's progress through the fulfilment process. ReportSubStatus under ‘Pending’ ReportStatus may require action from the user to complete the order.

  • Created - 1 - The order has been created within the EagleView system.
  • In Process - 2 - The report has been created and is progressing through the steps of our workflow.
  • Pending - 3 - Awaiting customer response.
  • Closed - 4 - The report is closed.
  • Completed - 5 - The report has been delivered.
DateOfLossstring

Custom date of loss field.

AdditionalRecipientsstring

Comma separated list of emails to be added as delivery recipients.

TotalCostnumber float

Total cost of the report.

PaymentTypestring

Payment method/how the report was charged.

PrimaryProductDisplayNamestring

Primary Product

TypeOfStructure0 | 1 | 2 | 3

Provides more details on the order's progress through the fulfilment process. ReportSubStatus under ‘Pending’ ReportStatus may require action from the user to complete the order.

  • 0 - NotSet - No structure type has been set.
  • 1 - Residential - Structure defined as single family or duplex residences.
  • 2 - Commercial - Structure type defines as non residential. e.g. Hospitals, schools, office buildings, etc
  • 3 - MultiFamily - Structure defined as larger than a duplex used for residential housing.
ReportIdinteger

Unique id generated by EagleView when an order is placed.

Streetstring

Street address of report.

BuildingIdstring

When there are multiple structures at the same address, each structure is identified by giving an ID. This ID is known as the BuildingId.

Citystring

City of report.

Statestring

State of report.

Zipstring

Zip of report.

Latitudeinteger

Latitude of report.

Longitudeinteger

Longitude of report.

ClaimNumberstring

Claim Number of report.

ClaimInfostring

Claim information of report.

BatchIdstring

Batch Id of report.

CatIdstring

Custom catastrophe ID field.

DatePlacedstring date-time

Date and time report was placed.

DateCompletedstring date-time

Date and time report was completed. Null if not completed.

PONumberstring

PO number for report.

Commentsstring

Customer comments from report.

ReferenceIdstring

ReferenceId for report.

InsuredNamestring

Insured name for report.

MeasurementRequestType1 | 2 | 3 | 4 | 5

Available MeasurementRequestTypes

  • 1 - PrimaryPlusDetachedGarage
  • 2 - PrimaryStructureOnly
  • 3 - AllStructuresOnParcel
  • 4 - CommercialComplex
  • 5 - Other
ReportDownloadLinkstring

URL to download latest report PDF.

EligibleForUpgradeboolean

Indicates if report can be upgraded from QuickSquares to a Premium Report.

Statusstring

Status of report.

Areastring

Total area of report.

Pitchstring

Primary pitch of report.

LengthRidgestring

Total length of all ridges for report.

LengthValleystring

Total length of all valleys for report.

LengthEavestring

Total length of all eaves for report.

LengthRakestring

Total length of all rakes for report.

AddOnProductIds'Commercial - Walls Only' | 'Walls, windows & doors' | 'Walls'

Shows the high level status of the report that has been ordered.

  • 35 - Commercial - Walls Only
  • 87 - Walls, windows & doors
  • 88 - Walls
AllowsUserSubmittedPhotosboolean

Indicates if user submitted photos will appear on report if uploaded by user.

LengthHipstring

Total length of all hips for report.

ProfileIdinteger

For EagleView internal use only.

UserNamestring

For EagleView internal use only.

SubstituteFromProductstring

Previous product name if substitution was made.

SubstituteToProductstring

Current product name if substitution was made.

CanCancelReportboolean

Determines if the report can be canceled based on its current status.

TotalRoofFacetsstring

Total number of roof facets

PitchEditorURLstring

PitchEditor URL for 2D reports