BEbeaconproplus
EagleView

Get specific pieces of data for a range of reports.

Changed on

This service is generally used as a means of searching reports on the authenticated user's account.

post/v1/eagleview/order/report-search

Request

  • Base URL
    https://beaconproplus.com
  • Auth
    none declared

Query parameters

pageinteger
countinteger

Request body

productsToFiterByinteger[] required

Available ProductIds.

  • 1 - PremiumResidential
  • 2 - PremiumCommercial
  • 3 - StandardResidential
  • 9 - Images
  • 10 - ParkingLot
  • 11 - EagleView Inform Essentials+
  • 12 - EagleView Inform Essentials+ for Commercial
  • 13 - ClaimsReadyResidential
  • 14 - ClaimsReadyCommercial
  • 15 - AA2D
  • 16 - AA3DResidential
  • 17 - SketchOnly
  • 18 - AA3DCommercial
  • 20 - InstallerReport
  • 25 - EC3DResidential
  • 26 - EC3DCommercial
  • 27 - EC2DResidential
  • 28 - EC2DCommercial
  • 29 - PremiumAWResidential
  • 30 - PremiumAWCommercial
  • 31 - ECPremiumResidential
  • 32 - ECPremiumCommercial
  • 34 - PremiumResidentialWallonly
  • 35 - PremiumCommercialWallonly
  • 37 - RiskManagementResidential
  • 38 - RiskManagementCommercial
  • 39 - Estimate
  • 40 - RoofGeometryResidential
  • 41 - CarrierEstimate
  • 44 - QuickSquares
  • 46 - GutterResidential
  • 47 - GutterCommercial
  • 48 - DiagramResidential
  • 49 - DiagramCommercial
  • 51 - WallsLite
  • 55 - QuickSquares-Multi-Family
  • 62 - EagleView Inform Advanced
  • 63 - EagleView Inform Advanced for Commercial
statusesToFilterByinteger[]

The primary status Id for the report.

  • 1 - PrimaryPlusDetachedGarage
  • 2 - PrimaryStructureOnly
  • 3 - AllStructuresOnParcel
  • 4 - CommercialComplex
  • 5 - Other
subStatusToFilterBy5 | 6 | 8 | 9 | 10 | 11 | 12 | 14 | 15 | 16 | 18 | 19 | 20 | 21 | 24 | 27 | 31 | 32 | 38 | 43

The SubStatus Id for the report.

  • 5 - UnderReview
  • 6 - ProcessStarted
  • 8 - NeedToID
  • 9 - Duplicate
  • 10 - CanceledByClient
  • 11 - PoorImages
  • 12 - NoID
  • 14 - ReportTypeChange
  • 15 - NoImages
  • 16 - Other
  • 18 - CardRejected
  • 19 - Sent
  • 20 - Sent
  • 21 - CustomerResponse
  • 24 - WrongHouse
  • 27 - CreditCardFailure
  • 31 - Processing
  • 32 - MeasurementData
  • 38 - UnsupportedStructure
  • 43 - ReadyToCapturePayment
fieldsToFilterBystring[]

The FilterBy for the report.

  • ID - Unique identifier generated by EagleView.
  • ClaimNumber - Customer provided claim number.
  • CatID - Customer provided catastrophe ID.
  • Address - Street address.

ClaimNumber and CatID are accepted but not currently searchable, so on their own they match no reports.

textToFilterBystring

Text to apply in the field filter.

sortBy'ID' | 'ClaimNumber' | 'CatID' | 'Address'

Available SortByFields.

  • ID - Date the report was placed.
  • DatePlaced - Unique identifier generated by EagleView. Used by default.
sortAscendingboolean

Indicates if the sort can be ascending or descending.

referenceIdstring
emailCCstring
fromDatestring date
toDatestring date

Response

successful operation

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

Example

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

TotalOfReportsinteger

Total number of reports.

Changes

  • c57ef31b9706Revision changes
    • breaking

      added the pattern (?i)ID|ClaimNumber|CatID|Address to the request property /

    • warning

      for the query request parameter count, the max was set to 100.00

    • warning

      for the query request parameter page, the max was set to 100000.00

    • warning

      for the query request parameter count, the min was set to 1.00

    • warning

      for the query request parameter page, the min was set to 1.00

    • info

      the query request parameter count became optional

    • info

      the query request parameter page became optional