Beacon Roofing Supply Get Eagle View Order Report V3 API

openapi: 3.2.0
info:
  title: Beacon Rest Services Get Eagle View Order Report V3 API
  description: 'A combination of all methods in the beacon-api


    [ BASE URL: https://beaconproplus.com


    Beacon ProPlus


    Version 1: https://beaconproplus.com/v1/rest/com/becn


    Version 2: https://beaconproplus.com/v2/rest/com/becn


    Version 3: https://beaconproplus.com/v3/rest/com/becn


    Beacon Stack


    [ BASE URL: https://beacon-api-x7xzzdp35a-uk.a.run.app


    Version 1: https://beacon-api-x7xzzdp35a-uk.a.run.app/v1/rest/com/becn/


    Version 2: https://beacon-api-x7xzzdp35a-uk.a.run.app/v2/rest/com/becn/


    Version 3: https://beacon-api-x7xzzdp35a-uk.a.run.app/v3/rest/com/becn/


    API Site ID

    Show... Most of the APIs supports the apiSiteId parameter in the following locations, the parsing priority is higher to lower. For example, if this parameter appears both in request parameter and request body, will get the one in the request parameter, any other locations will be ignored. apiSiteId in Request Parameter/URL/Query String e.g. example.com/?apiSiteId=XYZ... example.com/?...&apiSiteId=XYZ... apiSiteId in Request Body/Payload e.g. { ... "apiSiteId": "XYZ", ... }


    Please be noted, only support when apiSiteId is the root element of request body. For example, the apiSiteId in the following request body is the second element, so this property will be ignored:


    { ... "foo": { "apiSiteId": "XYZ", } ... }


    apiSiteId related OAuth Token in Request Header e.g. Authorization Bearer atdy9au5qtg0ofkxdewwr3169... In this case, the apiSiteId will be parsed via the OAuth Token. For example, if one token is generated by the client id "nigu0zjtyih7lb36l2...", then this client related api site id(pre-defined and stored in the server database) will be the value of apiSiteId


    API Uniform Format

    Show... Response

    { "success":true, "messages":[ { "key":null, "code":null, "type":"success", "value":"" } ], "result": }

    Explanation


    If the response example value of one endpoint /foo is:

    { "name":"bar", "age":123 }

    Then the actual response value of this endpoint is: (replace the value of "result" element in API Uniform Format with example response)

    { "success":true, "messages":[ { "code":null, "type":"success", "value":"" } ], "result":{ "name":"bar", "age":123 } }


    API Response Message Code

    Show... Code Group


    Code


    Comments


    1XXX:

    common request param error 1001 Param is required. 1002 Repository item not found via request


    1003 Param max length is invalid. 1004 Param min length is invalid. 1005 Param regular expression is invalid. 1006 Request param requestBody is not a valid


    1007 Request param caused validation exception


    1008 Request param caused form error


    2XXX:

    current profile error 2001 Current profile in request is empty


    2002 Current profile type/instance in request is empty


    2003 Current profile in request do not have available accounts


    2004 Current profile is unauthorized


    2005 Current profile is already authorized


    2006 Current profile is permission denied


    3XXX:

    specified request param error 3001 Request param account id is not available/not belong to current profile


    3002 Request param product id is not available to current region of current profile


    3003 Request param profile id is not equal to current profile


    3004 Request param profile id is not found


    3005 Request param site id is not equal to current site


    3006 Request param sku id is not available to current region of current profile


    3007 Request param shipping is invalid to current region of current profile


    4XXX:

    system level common error 4001 System error


    4002 Mincron error


    4003 ATG Order version invalid error


    5XXX:

    specified response error 5001 Submit order failed response


    5002 Submit order failed with integration exception message returned


    5003 Query order detail not match with current


    5004 No result is returned to order history


    5005 Template name invalid


    5006 Need change account


    5007 Account no longer available for current user


    5008 Illegal data


    5009 Account token invalid


    5010 No current Order


    5011 Quote order account not match


    Glossary

    Show...'
  version: '1.0'
  contact: {}
servers: []
tags:
- name: GetEagleViewOrderReportV3
paths:
  /getEagleViewOrderReportV3:
    get:
      operationId: V2Controller_getEagleViewOrderReportV3
      summary: Returns information for an Eagle View report
      description: Returns information about a single Eagle View report including measurements and product substitutions.
      parameters:
      - name: reportId
        required: false
        in: path
        description: Report Id.
        schema:
          type: string
      responses:
        '200':
          description: successful operation<br><br>refer to the <i>API Uniform Format</i> dropdown above
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getEagleViewOrderReportV3Response'
        '400':
          description: Bad Request, accountId is invalid.
        '401':
          description: Unauthorized, the authorization bearer token is invalid.
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception.
      tags:
      - GetEagleViewOrderReportV3
components:
  schemas:
    DeliveryFilesAvailable:
      type: object
      properties:
        DeliveryFileTypeId:
          type: number
        EffectiveDate:
          type: string
      required:
      - DeliveryFileTypeId
      - EffectiveDate
    ProductSubstitution:
      type: object
      properties:
        From:
          $ref: '#/components/schemas/From'
        To:
          $ref: '#/components/schemas/From'
      required:
      - From
      - To
    ReportImage:
      type: object
      properties:
        sequenceNumber:
          type: number
        imageId:
          type: number
        ProductId:
          type: number
        ProductDeliveryId:
          type: number
        AddOnProductIds:
          type: array
          items:
            type: number
        AdditionalEmails:
          type: string
        ClaimNumber:
          type: string
        ClaimInfo:
          type: string
        PONumber:
          type: string
        DateOfLoss:
          type: string
        CatId:
          type: string
      required:
      - sequenceNumber
      - imageId
      - ProductId
      - ProductDeliveryId
      - AddOnProductIds
      - AdditionalEmails
      - ClaimNumber
      - ClaimInfo
      - PONumber
      - DateOfLoss
      - CatId
    getEagleViewOrderReportV3Response:
      type: object
      properties:
        ReportId:
          type: number
        Street:
          type: string
        BuildingId:
          type: string
        City:
          type: string
        State:
          type: string
        Zip:
          type: string
        Latitude:
          type: number
        Longitude:
          type: number
        ClaimNumber:
          type: string
        ClaimInfo:
          type: string
        BatchId:
          type: string
        CatId:
          type: string
        DatePlaced:
          type: string
        DateCompleted:
          type: string
        PONumber:
          type: string
        Comments:
          type: string
        ReportImage:
          type: array
          items:
            $ref: '#/components/schemas/ReportImage'
        ReferenceId:
          type: string
        InsuredName:
          type: string
        MeasurementRequestTypeId:
          type: number
        ReportDownloadLink:
          type: string
        EligibleForUpgrade:
          type: boolean
        Status:
          type: string
        Area:
          type: string
        Pitch:
          type: string
        LengthRidge:
          type: string
        LengthValley:
          type: string
        LengthEave:
          type: string
        LengthRake:
          type: string
        ProductPrimaryId:
          type: number
        ProductPrimary:
          type: string
        ProductDeliveryId:
          type: number
        ProductDelivery:
          type: string
        AddOnProductIds:
          type: string
        AllowsUserSubmittedPhotos:
          type: boolean
        LengthHip:
          type: string
        SubstituteFromProduct:
          type: number
        SubstituteToProduct:
          type: string
        CanCancelReport:
          type: string
        StatusId:
          type: number
        SubStatusId:
          type: number
        DisplayStatus:
          type: string
        DateOfLoss:
          type: string
        DeliveryFilesAvailable:
          type: array
          items:
            $ref: '#/components/schemas/DeliveryFilesAvailable'
        AdditionalRecipients:
          type: string
        TotalCost:
          type: number
        PaymentType:
          type: string
        MeasurementByStructure:
          type: array
          items:
            $ref: '#/components/schemas/MeasurementByStructure'
        PrimaryProductDisplayName:
          type: string
        AddOnProducts:
          type: array
          items:
            $ref: '#/components/schemas/AddOnProduct'
        TypeOfStructure:
          type: number
        ProductSubstitution:
          $ref: '#/components/schemas/ProductSubstitution'
        TotalMeasurements:
          $ref: '#/components/schemas/MeasurementByStructure'
        JobName:
          type: string
        CanEditReportInformation:
          type: boolean
        SuggestedWasteFactorAvailable:
          type: boolean
      required:
      - ReportId
      - Street
      - BuildingId
      - City
      - State
      - Zip
      - Latitude
      - Longitude
      - ClaimNumber
      - ClaimInfo
      - BatchId
      - CatId
      - DatePlaced
      - DateCompleted
      - PONumber
      - Comments
      - ReportImage
      - ReferenceId
      - InsuredName
      - MeasurementRequestTypeId
      - ReportDownloadLink
      - EligibleForUpgrade
      - Status
      - Area
      - Pitch
      - LengthRidge
      - LengthValley
      - LengthEave
      - LengthRake
      - ProductPrimaryId
      - ProductPrimary
      - ProductDeliveryId
      - ProductDelivery
      - AddOnProductIds
      - AllowsUserSubmittedPhotos
      - LengthHip
      - SubstituteFromProduct
      - SubstituteToProduct
      - CanCancelReport
      - StatusId
      - SubStatusId
      - DisplayStatus
      - DateOfLoss
      - DeliveryFilesAvailable
      - AdditionalRecipients
      - TotalCost
      - PaymentType
      - MeasurementByStructure
      - PrimaryProductDisplayName
      - AddOnProducts
      - TypeOfStructure
      - ProductSubstitution
      - TotalMeasurements
      - JobName
      - CanEditReportInformation
      - SuggestedWasteFactorAvailable
    MeasurementByStructure:
      type: object
      properties:
        BuildingName:
          type: string
        Area:
          type: string
        PrimaryPitch:
          type: string
        LengthRidge:
          type: string
        LengthValley:
          type: string
        LengthEave:
          type: string
        LengthRake:
          type: string
        LengthHip:
          type: string
      required:
      - BuildingName
      - Area
      - PrimaryPitch
      - LengthRidge
      - LengthValley
      - LengthEave
      - LengthRake
      - LengthHip
    From:
      type: object
      properties:
        PrimaryProductId:
          type: number
        PrimaryProductDisplayName:
          type: string
        TypeOfStructure:
          type: number
      required:
      - PrimaryProductId
      - PrimaryProductDisplayName
      - TypeOfStructure
    AddOnProduct:
      type: object
      properties:
        DisplayName:
          type: string
        ProductId:
          type: number
      required:
      - DisplayName
      - ProductId