API Version 2022.09

Aurora releases a new API version when we make backward-incompatible changes. To avoid disrupting your integration and breaking your code, we don’t change your version automatically. You can upgrade to the latest version using Versions API when you are ready. The following are breaking changes in version 2022.09 released today.

• Removed / (root) API endpoint.

• Removed /v2 from all API resource URLs. For example, /v2/tenants/{tenant_id}/projects/{id} is now /tenants/{tenant_id}/projects/{id}.

• Removed HMAC authentication. Use bearer token authentication instead.

• Replaced user_level with role_id and switched from the human-readable user level to role uuid in Create User, Invite User, Retrieve User, and Update User.

  JSON

  # in API version 2018.01
   "user": {
        "first_name": "Jessica",
        "last_name": "Solar",
        "user_level": "Team Member"
   }
  
  # in API version 2022.09
   "user": {
        "first_name": "Jessica",
        "last_name": "Solar",
        "role_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
   }
  
  

• Made messages in HTTP 4xx responses use a consistent format:

  JSON

  {
      "errors": [
          {"message": "something went wrong"},
          {"message": "something else went wrong"}
      ]
  }
  
  

• Made HTTP 404 Not Found response reference the resource that’s not found. For example, {"error": [{"message": "The project with id 12345343-5343-4345-3445-123456789012 could not be found"}]}

• Removed a previously deprecated system_size field from Retrieve Design Summary endpoint. Use system_size_ac ,system_size_ptc or system_size_stc instead.

• Reduced fields returned by List Financing to id, name, selected_in_sales_mode, and financing option. The rest of the fields are available via Retrieve Financing.

• Removed site_model_design_id and include_design query parameters from Create Design. Use the new Duplicate Design endpoint instead.

• For Run AutoDesigner:

  • Removed _meters suffix from the following input fields row_spacing_meters ,column_spacing_meters ,flat_face_row_spacing_meters ,flat_face_column_spacing_meters. The unit of measure (meters) is listed in API docs.

  • Removed a previously deprecated allow_filler_row field. Use filler_row_locations instead.

  • Restructured placement_options field:

    JSON

    # in API version 2018.01
    placement_options: {
          orientations,
          flat_face_orientations,
          filler_row_locations,
          min_sap,
          min_tsrf,
          pitched_face_tilt_threshold,
          column_spacing,
          row_spacing,
          min_contiguous_panels,
          panel_tilt,
          flat_face_column_spacing,
          flat_face_row_spacing,
          flat_face_panel_tilt,
          azimuth_min_deg,
          azimuth_max_deg
    }
    
    #in API version 2022.09
    placement_options: {
          pitched_face_tilt_threshold,
          orientations,
          column_spacing,
          row_spacing,
          panel_tilt
    }
    flat_face_placement_options: {
          flat_face_orientations,
          flat_face_column_spacing,
          flat_face_row_spacing,
          flat_face_panel_tilt
    }
    irradiance_constraints: {
          min_sap,
          min_tsrf
    }
    placement_constraints: {
          min_contiguous_panels,
          azimuth_min_deg,
          azimuth_max_deg,
          filler_row_locations
    }