find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/eagleview:eagleview-retrieving-files-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

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 Retrieving Files API
servers:
- url: https://sandbox.apicenter.eagleview.com/
tags:
- name: Retrieving Files
  description: Once a report has completed processing, it is possible to retrieve it via Retrieving Files API methods.
paths:
  /v1/File/GetReportFile:
    get:
      description: The GetReportFile method allows the authenticating user to retrieve files generated for a report. Please note that a report file can only be retrieved if it has been generated. If the user makes a request for a fileType and fileFormat that has not been generated, then the call will fail. Please reach out to the Integrations team to have a specific fileType and fileFormat generated.
      operationId: GET/v1/File/GetReportFile
      tags:
      - Retrieving Files
      summary: GetReportFile
      parameters:
      - name: reportId
        description: Unique id generated by EagleView when an order is placed.
        in: query
        required: false
        schema:
          type: integer
      - name: fileType
        description: File Type
        in: query
        required: false
        schema:
          type: integer
      - name: fileFormat
        description: File Format
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: A byte array is returned of the file.
          content:
            application/json:
              schema:
                type: string
                format: byte
        '204':
          description: Requested file does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportFileNoContentResponseBody'
        '400':
          description: Invalid reportID. Please try again with a valid reportID
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportFileBadRequestResponseBody'
        '500':
          description: Report is still in progress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetReportFileInternalServerErrorResponseBody'
      security:
      - bearerAuth: []
      x-operation-id-source: normalized
      x-operation-id-original: GET /v1/File/GetReportFile
  /v1/File/GetReportFileAnyFormat:
    get:
      description: The GetReportFileAnyFormat method allows the authenticating user to retrieve files generated for a report. Please note that a report file can only be retrieved if it has been generated. If the user makes a request for a fileType that has not been generated, then the call will fail. Please reach out to the Integrations team to have a specific fileType generated.
      operationId: GET/v1/File/GetReportFileAnyFormat
      tags:
      - Retrieving Files
      summary: GetReportFileAnyFormat
      parameters:
      - name: reportId
        description: Unique id generated by EagleView when an order is placed.
        in: query
        required: false
        schema:
          type: integer
      - name: fileType
        description: File Type
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: A byte array is returned of the file.
          content:
            application/json:
              schema:
                type: string
                format: byte
      security:
      - bearerAuth: []
      x-operation-id-source: normalized
      x-operation-id-original: GET /v1/File/GetReportFileAnyFormat
  /FileDelivery:
    post:
      description: 'Receive completed order files 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 "/FileDelivery".'
      operationId: POST/FileDelivery
      tags:
      - Retrieving Files
      summary: FileDelivery
      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: FileFormatId
        description: File Format
        in: query
        required: true
        schema:
          type: integer
      - name: FileTypeId
        description: File Type
        in: query
        required: true
        schema:
          type: integer
      - name: StructureID
        description: EagleView’s unique structure id for the order.
        in: query
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: A successful response is required if the file has been delivered successfully.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileDelivery'
        required: true
      x-operation-id-source: normalized
      x-operation-id-original: POST /FileDelivery
  /FileDeliveryConfirmation:
    get:
      description: Upon delivering the files associated with a particular order, EagleView will make this call to confirm all the files are delivered. Please note that the URL should end with "FileDeliveryConfirmation".
      operationId: GET/FileDeliveryConfirmation
      tags:
      - Retrieving Files
      summary: FileDeliveryConfirmation
      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
      responses:
        '200':
          description: A successful response is required if all files have been delivered successfully.
      x-operation-id-source: normalized
      x-operation-id-original: GET /FileDeliveryConfirmation
  /v3/Report/{reportId}/file-links:
    get:
      description: The File-Links method allows the authenticating user to retrieve file download links generated for Solar Products such as Inform Reports and TrueDesign measurement data. Please note that a report file download link can only be retrieved if the files are available. Link will contain URL to referenced file for download.
      operationId: GET/v3/Report/{reportId}/file-links
      tags:
      - Retrieving Files
      summary: File-Links
      parameters:
      - name: reportId
        description: Report Id.
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/File-LinksResponseBody'
        '204':
          description: No Content
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    enum:
                    - Deliverables not generated for this report
        '401':
          description: Only authorized report owner can make this request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileLinksUnAuthorisedResponseBody'
      security:
      - bearerAuth: []
      x-operation-id-source: normalized
      x-operation-id-original: GET /v3/Report/{reportId}/file-links
components:
  schemas:
    FileLinksUnAuthorisedResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Only authorized report owner can make this request
    GetReportFileInternalServerErrorResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Report is still in progress
    GetReportFileNoContentResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Requested file does not exist
    GetReportFileBadRequestResponseBody:
      type: object
      properties:
        Message:
          type: string
          description: Invalid reportID. Please try again with a valid reportID
    Links:
      type: object
      properties:
        Link:
          type: string
          description: Signed URL for file download.
        ExpireTimestamp:
          type: string
          format: date-time
          description: DateTime in UTC, after which access to the signed URL will expire.
        FileType:
          type: string
          description: FileType extension of the given file
    FileDelivery:
      type: object
      properties:
        File Content:
          type: string
          format: byte
          description: Base64 encoded byte stream
    File-LinksResponseBody:
      type: object
      properties:
        Links:
          $ref: '#/components/schemas/Links'
  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