--- title: "Get specific pieces of data for a range of reports." method: POST path: "/v1/eagleview/order/report-search" tags: ["EagleView"] --- # Get specific pieces of data for a range of reports. `POST /v1/eagleview/order/report-search` This service is generally used as a means of searching reports on the authenticated user's account. ## Query parameters - `page` integer, required - `count` integer, required ## Request body - EagleviewOrderSearchDTO - `productsToFiterBy` integer[], 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 - `statusesToFilterBy` integer[] — > The primary status Id for the report. * `1` - PrimaryPlusDetachedGarage * `2` - PrimaryStructureOnly * `3` - AllStructuresOnParcel * `4` - CommercialComplex * `5` - Other - `subStatusToFilterBy` 5 | 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 - `fieldsToFilterBy` string[] — > The FilterBy for the report. * `ID` - Unique identifier generated by EagleView. * `ClaimNumber` - Customer provided claim number. * `CatID` - Customer provided catastrophe ID. * `Address` - Street address. - `textToFilterBy` string — 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. - `sortAscending` boolean — Indicates if the sort can be ascending or descending. - `referenceId` string - `emailCC` string - `fromDate` string, date - `toDate` string, date ## Response `200` successful operation If failed, return messageCode, refer to *API Response Message Code*. Example { "messageCode": "1001", "message": "Validation exception" } - EagleViewOrderReportListDTO - `TotalOfReports` integer — Total number of reports. - `ReportList` EagleViewReportEntityDTO[] - `numberOfImages` integer - `addOns` EagleViewAddOn[] - `productID` 99 | 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 - `name` '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 - `description` string - `privateOrGlobal` string — the value is private or global - `Id` integer — Report ID. Unique identifier generated by EagleView when a report is ordered - `Street1` string — First line of the street address for the ordered report. - `Street2` string - `City` string — Name of the city for the ordered report. - `State` string — State of report. - `Zip` string — Zip of report. - `Latitude` number, double — Latitude of report. - `Longitude` number, double — Longitude of report. - `ClaimNumber` string — Claim Number of report. - `ClaimInfo` string — Claim information of report. - `BatchId` string — Batch Id of report. - `CatId` string — Custom catastrophe ID field. - `DatePlaced` string, date-time — Date and time report was placed. - `DateCompleted` string, date-time — Date and time report was completed. Null if not completed. - `ReportProducts` BaseEagleViewReportProduct - `ProductPrimaryId` 99 | 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 - `ProductDeliveryId` 4 | 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 - `ReportStatus` BaseEagleViewReportStatus - `StatusId` 1 | 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. - `Status` 'Created' | 'InProcess' | 'Pending' | 'Closed' | 'Completed' — > 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. - `SubStatusId` 5 | 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 - `SubStatus` 'UnderReview' | 'ProcessStarted' | 'NeedToID' | 'Duplicate' | 'CanceledByClient' | 'PoorImages' | 'NoID' | 'ReportTypeChange' | 'NoImages' | 'Other' | 'CardRejected' | 'Sent' | 'Sent' | 'CustomerResponse' | 'WrongHouse' | 'CreditCardFailure' | 'Processing' | 'MeasurementData' | 'UnsupportedStructure' | 'ReadyToCapturePayment' — > 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 - `DisplayStatus` '5' | '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. * `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. - `ReportDownloadLink` string — URL to download latest report PDF. - `EligibleForUpgrade` boolean — Indicates if report can be upgraded from QuickSquares to a Premium Report. - `AllowsUserSubmittedPhotos` boolean — Indicates if user submitted photos will appear on report if uploaded by user. - `EmailCC` string — CC email address. - `ReferenceId` string — ReferenceId for report. ## Other responses - `400` — Bad Request, accountId is invalid - `401` — Unauthorized, user do not login - `403` — Invalid token - `405` — Method not allowed, the request method is not valid for this API or this API is not available. - `500` — Internal exception --- [API](https://skmtc.net/beaconproplus/apis/eagleview-api.md) · [All operations](https://skmtc.net/beaconproplus/apis/eagleview-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beaconproplus/eagleview-api/revisions/acb20cfa91b9/schema)