EagleView Order Status API

openapi: 3.2.0
info:
  description: '# Endpoint

    The endpoint for the sandbox integrations environment is: https://sandbox.apicenter.eagleview.com.'
  version: 1.0.0
  title: Measurement Orders Order Status API
servers:
- url: https://sandbox.apicenter.eagleview.com/
tags:
- name: Order Status
  description: Once the report has been created in the Ordering stage, it is possible to query the status of the order via Order Status API methods.
paths:
  /v3/Report/GetReport:
    get:
      description: The GetReport call will return information about a single report. Notable pieces of information include Status, ReportDownloadLink, and measurement totals.
      operationId: GET/v3/Report/GetReport
      tags:
      - Order Status
      summary: GetReport
      parameters:
      - name: reportId
        description: Unique id generated by EagleView when an order is placed.
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V3GetReportResponseBody'
        '204':
          description: No data available for this report ID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportNocontentResponseBody'
        '401':
          description: Invalid ReportID or unauthorized user. Please try again with valid reportID or authorized user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportUnAuthorizedResponseBody'
      security:
      - bearerAuth: []
      x-operation-id-source: normalized
      x-operation-id-original: GET /v3/Report/GetReport
  /v3/Report/GetReports:
    post:
      description: The GetReports method will return specific pieces of data for a range of reports. This method is generally used as a means of searching reports on the authenticated user's account.
      operationId: POST/v3/Report/GetReports
      tags:
      - Order Status
      summary: GetReports
      parameters:
      - name: page
        description: Page number.
        in: query
        required: true
        schema:
          type: integer
      - name: count
        description: Count of reports to return.
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/V3GetReportsResponseBody'
        '401':
          description: Authorization has been denied for this request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportsUnAuthorizedResponseBody'
      security:
      - bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V3GetReports'
        required: true
      x-operation-id-source: normalized
      x-operation-id-original: POST /v3/Report/GetReports
  /OrderStatusUpdate:
    get:
      description: 'Receive order status updates to your webhook from EagleView. Configure the Webhook Endpoint URL field within the application you create through this developer portal. Please note: when you are setting up the webhook on your side, your endpoint should end with "/OrderStatusUpdate".'
      operationId: GET/OrderStatusUpdate
      tags:
      - Order Status
      summary: OrderStatusUpdate
      parameters:
      - name: StatusId
        description: Status Ids
        in: query
        required: true
        schema:
          type: integer
      - name: SubStatusId
        description: SubStatus Ids
        in: query
        required: true
        schema:
          type: integer
      - name: RefId
        description: Unique Id that was passed as a reference by the client/partner when the order was placed with EagleView.
        in: query
        required: true
        schema:
          type: string
      - name: ReportId
        description: Unique id generated by EagleView when an order is placed.
        in: query
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: A successful response is expected if the status update is received.
      x-operation-id-source: normalized
      x-operation-id-original: GET /OrderStatusUpdate
  /NeedToId:
    get:
      description: If the report is NPA (Not Parcel Accurate) then EagleView can notify an integration partner's hosted endpoint. Please note that the URL should end with "NeedToId".
      operationId: GET/NeedToId
      tags:
      - Order Status
      summary: NeedToId
      parameters:
      - name: RefId
        description: Unique Id that was passed as a reference by the client/partner when the order was placed with EagleView.
        in: query
        required: true
        schema:
          type: string
      - name: ReportId
        description: Unique id generated by EagleView when an order is placed.
        in: query
        required: true
        schema:
          type: integer
      - name: VerifyId
        description: URL Encoded NPA Link.
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A successful response is required if the notification is successfully received.
      x-operation-id-source: normalized
      x-operation-id-original: GET /NeedToId
  /v1/reports/{reportId}/structure-waste-measurements:
    get:
      description: The structure-waste-measurements call will return the Suggested Waste Factor data for each structure on an existing report
      operationId: GET/v1/reports/{reportId}/structure-waste-measurements
      tags:
      - Order Status
      summary: structure-waste-measurements
      parameters:
      - name: reportId
        description: Unique id generated by EagleView when an order is placed.
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/structure-waste-measurementsResponseBody'
        '204':
          description: No measurements found for the report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StructureWasteNoContentResponseBody'
        '401':
          description: Invalid ReportID or unauthorized user. Please try again with valid reportID or authorized user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StructureWasteUnAuthorizedResponseBody'
        '403':
          description: Not The Report Owner
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StructureWasteNForbiddenResponseBody'
      security:
      - bearerAuth: []
      x-operation-id-source: normalized
      x-operation-id-original: GET /v1/reports/{reportId}/structure-waste-measurements
components:
  schemas:
    From:
      type: object
      properties:
        PrimaryProductId:
          type: integer
          description: Primary Product Id
        PrimaryProductDisplayName:
          type: string
          description: Product Name
        TypeOfStructure:
          type: integer
          description: Structure Type
    To:
      type: object
      properties:
        PrimaryProductId:
          type: integer
          description: Primary Product Id
        PrimaryProductDisplayName:
          type: string
          description: Product Name
        TypeOfStructure:
          type: integer
          description: Structure Type
    StructureWasteUnAuthorizedResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Invalid ReportID or unauthorized user. Please try again with valid reportID or authorized user
    StructureWasteNForbiddenResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Not The Report Owner or Product not supported for per structure waste measurements or Caller has SWF disabled
    GetReportNocontentResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: No data available for this report ID
    MeasurementByStructure:
      type: object
      properties:
        BuildingName:
          type: string
          description: Name of the building.
        Area:
          type: string
          description: Total area of the building.
        PrimaryPitch:
          type: string
          description: Primary pitch of the building.
        LengthRidge:
          type: string
          description: Total length of the building's ridges.
        LengthValley:
          type: string
          description: Total length of the building's valleys.
        LengthEave:
          type: string
          description: Total length of the building's eaves.
        LengthRake:
          type: string
          description: Total length of the building's rakes.
        LengthHip:
          type: string
          description: Total length of the building's hips.
        LengthFlashing:
          type: string
          description: Total length of the flashings.
        LengthStepFlashing:
          type: string
          description: Total length of the step flashings.
        LengthParapets:
          type: string
          description: Total length of the parapets.
        LengthOther:
          type: string
          description: Total length of the other.
        WallsSidingArea:
          type: string
          description: Total Siding Area of the building. Only present in Walls, Windows & Doors and Walls reports.
        WallsMasonryArea:
          type: string
          description: Total Masonry Area of the building. Only present in Walls, Windows & Doors and Walls reports.
        AreaValue:
          type: number
          format: float
          description: Area of the roof of the building.
        PitchValue:
          type: number
          format: float
          description: Slope of the roof of the building.
        TotalRoofFacets:
          type: string
          description: Total number of roof facets.
        PitchTable:
          $ref: '#/components/schemas/PitchTable'
    ReportStatus:
      type: object
      properties:
        StatusId:
          type: integer
          description: Status Id
        Status:
          type: string
          description: Report Status
        SubStatusId:
          type: integer
          description: SubStatus Id
        SubStatus:
          type: string
          description: Report SubStatus
        DisplayStatus:
          type: string
          description: Report Status
    ReportImage:
      type: object
      properties:
        SequenceNumber:
          type: integer
          description: Sequence number of report image.
        ImageId:
          type: integer
          description: ImageId for report image.
    PitchTable:
      type: object
      properties:
        Pitch:
          type: string
          description: Slope of roof of the building
        RoofArea:
          type: string
          description: Total roof area for the corresponding pitch
        PercentageRoofArea:
          type: string
          description: Total percentage of the roof area covered by the corresponding pitch
    StructureWasteNoContentResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: No measurements found for the report
    V3GetReportResponseBody:
      type: object
      properties:
        StatusId:
          type: integer
          description: Status Id
        SubStatusId:
          type: integer
          description: SubStatus Id
        DisplayStatus:
          type: string
          description: Report Status
        DateOfLoss:
          type: string
          description: Custom date of loss field.
        DeliveryFilesAvailable:
          $ref: '#/components/schemas/DeliveryFilesAvailable'
        AdditionalRecipients:
          type: string
          description: Comma separated list of emails to be added as delivery recipients.
        TotalCost:
          type: number
          format: float
          description: Total cost of the report.
        PaymentType:
          type: string
          description: Payment method/how the report was charged.
        MeasurementByStructure:
          $ref: '#/components/schemas/MeasurementByStructure'
        PrimaryProductDisplayName:
          type: string
          description: Primary Product
        AddOnProducts:
          $ref: '#/components/schemas/AddOnProducts'
        TypeOfStructure:
          type: integer
          description: Structure Type
        ProductSubstitution:
          $ref: '#/components/schemas/ProductSubstitution'
        TotalMeasurements:
          $ref: '#/components/schemas/TotalMeasurements'
        ReportId:
          type: integer
          description: Unique id generated by EagleView when an order is placed.
        Street:
          type: string
          description: Street address of report.
        BuildingId:
          type: string
          description: When there are multiple structures at the same address, each structure is identified by giving an ID. This ID is known as the BuildingId.
        City:
          type: string
          description: City of report.
        State:
          type: string
          description: State of report.
        Zip:
          type: string
          description: Zip of report.
        Latitude:
          type: number
          format: float
          description: Latitude of report.
        Longitude:
          type: number
          format: float
          description: Longitude of report.
        ClaimNumber:
          type: string
          description: Customer provided claim number for this report.
        ClaimInfo:
          type: string
          description: Customer provided claim information for this report.
        BatchId:
          type: string
          description: Custom batch Id for this report.
        CatId:
          type: string
          description: Custom catastrophe ID field.
        DatePlaced:
          type: string
          format: date-time
          description: Date and time report was placed.
        DateCompleted:
          type: string
          format: date-time
          description: Date and time report was completed. Null if not completed.
        PONumber:
          type: string
          description: Customer provided PO number for this report.
        Comments:
          type: string
          description: Customer comments from report.
        ReportImage:
          $ref: '#/components/schemas/ReportImage'
        ReferenceId:
          type: string
          description: Customer provided referenceId used for returning data to customer APIs.
        InsuredName:
          type: string
          description: Customer provided insured name for this report.
        MeasurementRequestType:
          type: integer
          description: Measurement Instruction Type
        ReportDownloadLink:
          type: string
          description: URL to download latest report PDF.
        EligibleForUpgrade:
          type: boolean
          description: Indicates if report can be upgraded from QuickSquares to a Premium Report.
        Status:
          type: string
          description: Status of report.
        Area:
          type: string
          description: Total area of report.
        Pitch:
          type: string
          description: Primary pitch of report.
        LengthRidge:
          type: string
          description: Total length of all ridges for report.
        LengthValley:
          type: string
          description: Total length of all valleys for report.
        LengthEave:
          type: string
          description: Total length of all eaves for report.
        LengthRake:
          type: string
          description: Total length of all rakes for report.
        ProductPrimaryId:
          type: integer
          description: Primary Product Id
        ProductPrimary:
          type: string
          description: Product Name
        ProductDeliveryId:
          type: integer
          description: Delivery Product Id
        ProductDelivery:
          type: string
          description: Delivery Product Name
        AddOnProductIds:
          type: string
          description: Add-On Product Ids
        AllowsUserSubmittedPhotos:
          type: boolean
          description: Indicates if user submitted photos will appear on report if uploaded by user.
        LengthHip:
          type: string
          description: Total length of all hips for report.
        ProfileId:
          type: integer
          description: For EagleView internal use only.
        UserName:
          type: string
          description: For EagleView internal use only.
        SubstituteFromProduct:
          type: string
          description: Previous product name if substitution was made.
        SubstituteToProduct:
          type: string
          description: Current product name if substitution was made.
        CanCancelReport:
          type: boolean
          description: Determines if the report can be canceled based on its current status.
        TotalRoofFacets:
          type: string
          description: Total number of roof facets
        PitchTable:
          $ref: '#/components/schemas/PitchTable'
        PitchEditorURL:
          type: string
          description: PitchEditor URL for 2D reports
    V3GetReports:
      type: object
      properties:
        productsToFiterBy:
          type: array
          items:
            type: integer
          description: Primary Product Id
        statusesToFilterBy:
          type: string
          description: Report Status
        sortBy:
          type: string
          description: Sort By Fields
        sortAscending:
          type: boolean
          description: Indicates if the sort can be ascending or descending.
        subStatusToFilterBy:
          type: string
          description: Report SubStatus
        fieldsToFilterBy:
          type: array
          items:
            type: string
          description: Fields To Filter By
        textToFilterBy:
          type: string
          description: Value to apply to the specified key in fieldsToFilterBy.
        referenceId:
          type: string
          description: Include all reports that have this referenceId set at the time of order creation.
        emailCC:
          type: string
          description: Include all reports that match this CC email address.
        fromDate:
          type: string
          description: 'Include all reports ordered after this date (Format: yyyy-MM-dd).'
        toDate:
          type: string
          description: 'Include all reports ordered before this date (Format: yyyy-MM-dd).'
      required:
      - productsToFiterBy
    TotalMeasurements:
      type: object
      properties:
        BuildingName:
          type: string
          description: Name of the building.
        Area:
          type: string
          description: Total area of the building.
        PrimaryPitch:
          type: string
          description: Primary pitch of the building.
        LengthRidge:
          type: string
          description: Total length of the building's ridges.
        LengthValley:
          type: string
          description: Total length of the building's valleys.
        LengthEave:
          type: string
          description: Total length of the building's eaves.
        LengthRake:
          type: string
          description: Total length of the building's rakes.
        LengthHip:
          type: string
          description: Total length of the building's hips.
        LengthFlashing:
          type: string
          description: Total length of the flashings.
        LengthStepFlashing:
          type: string
          description: Total length of the step flashings.
        LengthParapets:
          type: string
          description: Total length of the parapets.
        LengthOther:
          type: string
          description: Total length of the other.
        WallsSidingArea:
          type: string
          description: Total Siding Area of the building. Only present in Walls, Windows & Doors and Walls reports.
        WallsMasonryArea:
          type: string
          description: Total Masonry Area of the building. Only present in Walls, Windows & Doors and Walls reports.
        AreaValue:
          type: number
          format: float
          description: Area of the roof of the building.
        PitchValue:
          type: number
          format: float
          description: Slope of the roof of the building.
        TotalRoofFacets:
          type: string
          description: Total number of roof facets.
        PitchTable:
          $ref: '#/components/schemas/PitchTable'
        GutterMeasurements:
          $ref: '#/components/schemas/GutterMeasurements'
    ReportList:
      type: object
      properties:
        Id:
          type: integer
          description: Report ID. Unique identifier generated by EagleView when a report is ordered
        Street1:
          type: string
          description: First line of the street address for the ordered report.
        Street2:
          type: string
          description: ''
        City:
          type: string
          description: Name of the city for the ordered report.
        State:
          type: string
          description: State Abbreviations
        Zip:
          type: string
          description: Zip code of the property for the ordered report.
        Latitude:
          type: number
          format: float
          description: Lattitude of the property for the ordered report.
        Longitude:
          type: number
          format: float
          description: Longitude of the property for the ordered report.
        ClaimNumber:
          type: string
          description: Customer provided claim number for this report.
        ClaimInfo:
          type: string
          description: Customer provided claim information for this report.
        BatchId:
          type: string
          description: Custom batch Id for this report.
        CatId:
          type: string
          description: Custom catastrophe Id field.
        DatePlaced:
          type: string
          format: date-time
          description: The date and time of when the report was ordered.
        DateCompleted:
          type: string
          format: date-time
          description: The date and time of when the report was completed. If the report is not complete, the value 'null' is returned.
        ReportProducts:
          $ref: '#/components/schemas/ReportProducts'
        ReportStatus:
          $ref: '#/components/schemas/ReportStatus'
        ReportDownloadLink:
          type: string
          description: URL to download EagleView generated PDF report.
        EligibleForUpgrade:
          type: boolean
          description: Indicates if this report is eligible for an upgrade or not.
        numberOfImages:
          type: integer
          description: ''
        addOns:
          $ref: '#/components/schemas/addOns'
        AllowsUserSubmittedPhotos:
          type: boolean
          description: Indicates if user submitted photos will appear on report if uploaded by user.
        CanCancelReport:
          type: boolean
          description: Determines if the report can be canceled based on its current status.
        EmailCC:
          type: string
          description: CC email address.
        ReferenceId:
          type: string
          description: Customer provided referenceId used for returning data to customer APIs.
    StructureWasteTable:
      type: object
      properties:
        Waste %:
          type: string
          description: Returns “0%” with no suggested waste, and three suggested waste % values. The middle one is the suggested factor, however you can also use the slightly higher or lower value.
        Area (sq ft):
          type: string
          description: Returns Area in Sq Ft for all “Waste %” values (0%, as well as the three suggested values).
        Squares *:
          type: string
          description: Returns count of Squares for all “Waste %” values (0%, as well as the three suggested values).
        Measured:
          type: string
          description: If AllPitchesUnderThreshold is True, will return the Measured Area in Sq Ft and count of Squares.
    GetReportUnAuthorizedResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Invalid ReportID or unauthorized user. Please try again with valid reportID or authorized user
    ReportProducts:
      type: object
      properties:
        ProductPrimaryId:
          type: integer
          description: Primary Product Id
        ProductPrimary:
          type: string
          description: Product Name
        ProductDelivery:
          type: string
          description: Delivery Product Name
        ProductDeliveryId:
          type: integer
          description: Delivery Product Id
    GutterMeasurements:
      type: object
      properties:
        DownspoutCountEstimate:
          type: string
          description: Estimated number of downspouts
        StoriesNorth:
          type: string
          description: Number of North-facing stories
        StoriesSouth:
          type: string
          description: Number of South-facing stories
        StoriesEast:
          type: string
          description: Number of East-facing stories
        StoriesWest:
          type: string
          description: Number of West-facing stories
        MiterCountInside:
          type: string
          description: Number of interior right-angle wall corners
        MiterCountOutside:
          type: string
          description: Number of exterior right-angle wall corners
        MiterCountNon90:
          type: string
          description: Number of non-right-angle wall corners
    addOns:
      type: object
      properties:
        productID:
          type: integer
          description: Add-On Product Id
        name:
          type: string
          description: Add-On Product Name
        description:
          type: string
          description: Add-on Product Description
    GetReportsUnAuthorizedResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Authorization has been denied for this request
    V3GetReportsResponseBody:
      type: object
      properties:
        ReportList:
          $ref: '#/components/schemas/ReportList'
        TotalOfReports:
          type: integer
          description: Total number of reports.
    structure-waste-measurementsResponseBody:
      type: object
      properties:
        StructureWasteTables:
          $ref: '#/components/schemas/StructureWasteTables'
    StructureWasteTables:
      type: object
      properties:
        Complexity:
          type: string
          description: Text descriptor of complexity. (Simple, Normal, Complex)
        StructureNumber:
          type: integer
          description: Identification number for each structure in the report.  Starts at 1.
        ModelId:
          type: string
          description: Identification number for each model for that structure. Default is Null
        AllPitchesUnderThreshold:
          type: boolean
          description: T/F. Suggested Waste Factor is only calculated for pitches > 3/12. If all pitches are under the 3/12 Threshold, will return True. In that case all suggested waste measurements will return as dashes, and the Measured Column will only return the actual measured Area in Sq Ft and Squares.
        StructureWasteTable:
          $ref: '#/components/schemas/StructureWasteTable'
    ProductSubstitution:
      type: object
      properties:
        From:
          $ref: '#/components/schemas/From'
        To:
          $ref: '#/components/schemas/To'
    DeliveryFilesAvailable:
      type: object
      properties:
        DeliveryFileTypeId:
          type: integer
          description: File Type
        EffectiveDate:
          type: string
          format: date-time
          description: Date and time which the file was generated.
    AddOnProducts:
      type: object
      properties:
        DisplayName:
          type: string
          description: Add-On Product Name
        ProductId:
          type: integer
          description: Add-On Product Id
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header
    basicAuth:
      type: http
      scheme: basic
      description: Unique identifier and secret provided by EagleView Integration team.
externalDocs:
  description: Find out more about Swagger
  url: http://swagger.io