# Generators search

Endpoint: POST /generators/action/search
Version: 1.0.0-beta
Security: bearerToken

## Query parameters:

  - `page` (integer)

  - `size` (integer)

## Request fields (application/json):

  - `upn` (string)

  - `name` (string)

  - `program` (string)
    Ref.Data.REC_PROGRAM_TYPE

  - `registryAssignedIds` (array)

  - `hostCountry` (string)

  - `fuelType` (string)

  - `state` (string)

  - `registryAssignedId` (string)

## Response 200 fields (application/json):

  - `page` (integer, required)

  - `size` (integer, required)

  - `totalPages` (integer, required)

  - `totalElements` (integer, required)

  - `content` (array)

  - `content.id` (integer)
    The unique XC db identifier for the project or generator.

  - `content.upn` (string)
    Universal Project Identifier. The unique identifier assigned by Xpansiv Connect to every resource across all registries that  have integrated with the Xpansiv Connect platform.

  - `content.name` (string, required)
    The registry assigned name of the project or generator.

  - `content.program` (string)
    The registry the generator is registered on.

  - `content.registryAssignedId` (string)
    The registry assigned identifier for the generator.

  - `content.status` (string)
    The status of the generator in the registry.
    Enum: "ACTIVE", "INACTIVE"

  - `content.siteCode` (string)
    The Site Code of the generator if provided by the registry.

  - `content.unitName` (string)
    The Unit Name of the generator in the registry.

  - `content.controlArea` (string)
    The Control Area that the generator is located in.

  - `content.parentCompanyName` (string)
    The Parent Company Name of the generator if provided by the registry.

  - `content.powerCompanyName` (string)
    The Power Company Name of the generator if provided by the registry.

  - `content.powerCompanyCode` (string)
    The Power Company Code of the generator if provided by the registry.

  - `content.ownerName` (string)
    The Owner Name of the generator if provided by the registry

  - `content.ownershipType` (string)
    The Ownership Type of the generator if provided by the registry.

  - `content.countyName` (string)
    The County Name locatio of the generator if provided by the registry.

  - `content.stateProvince` (string)
    The State or Province location of the generator.

  - `content.country` (string)
    The Country location of the generator.

  - `content.contactInfo` (string)
    Contact Information for the generator if provided by the registry.

  - `content.registryAcctHolderName` (string)
    The Registry Account Holder name of the generator if provided by the registry.

  - `content.commencedDt` (string)
    The Commenced Operation Date of the generator if provided by the registry.

  - `content.nameplateCapacity` (number)
    The Nameplate Capacity of the generator if provided by the registry.

  - `content.facNoncompetitiveCertData` (string)

  - `content.fuelTypes` (array)
    Additional information about a generator if it is multi-fuel. Optional property. Use include param.

  - `content.fuelTypes.fuelType` (object, required)

  - `content.fuelTypes.fuelType.name` (string)
    The fuel type associated with the underlying asset.

  - `content.fuelTypes.fuelType.type` (string)
    The registry fuel type.

  - `content.fuelTypes.fuelType.fuelSource` (string)
    The registry fuel source associated with the fuel type (registry-dependent).

  - `content.fuelTypes.stateEligibilities` (array)

  - `content.fuelTypes.stateEligibilities.name` (string)
    Name of the state eligibility.

  - `content.fuelTypes.stateEligibilities.type` (string)
    The state eligibilities associated with the additional fuel types.
    Enum: "ALBERTA", "ARIZONA", "BRITISH_COLUMBIA", "CALIFORNIA", "COLORADO", "NEW_MEXICO", "NEVADA", "OREGON", "TEXAS", "UTAH", "WASHINGTON", "CONNECTICUT_CEO", "CONNECTICUT_CLASS_I", "CONNECTICUT_CLASS_II", "CONNECTICUT_CLASS_III", "ELIGIBLE_MASSACHUSETTS_NOX_ALLOWANCES", "MA_SOLAR_CARVE-OUT_UNIT", "MA_SOLAR_CARVE-OUT_UNIT_II", "MA_AUCTION_SOLAR_CARVE-OUT_UNIT", "MA_AUCTION_SOLAR_CARVE-OUT_UNIT_II", "MASSACHUSETTS_APS_ALTERNATIVE_GENERATION_UNIT", "MASSACHUSETTS_RPS_CLASS_I_RENEWABLE_GENERATION_UNIT", "MASSACHUSETTS_RPS_CLASS_II_RENEWABLE_GENERATION_UNIT", "MASSACHUSETTS_RPS_CLASS_II_WASTE_ENERGY_GENERATION_UNIT", "ME_COMMUNITY-BASED_RENEW_ENERGY", "ME_TREC", "MAINE_CLASS_I", "MAINE_CLASS_IA", "MAINE_CLASS_II", "MAINE_CO2_NETTING", "MAINE_REN/EFF_ENERGY_SOURCE", "NEW_HAMPSHIRE_CLASS_I", "NEW_HAMPSHIRE_CLASS_II", "NEW_HAMPSHIRE_CLASS_III", "NEW_HAMPSHIRE_CLASS_IV", "NH_CLASS_I_THERMAL", "RHODE_ISLAND_EXISTING_RENEWABLE_RESOURCE", "RHODE_ISLAND_NEW_RENEWABLE_RESOURCE", "IOWA", "ILLINOIS", "ILLINOIS_SOLAR", "ILLINOIS_ARES", "MANITOBA", "MINNESOTA", "MONTANA", "NORTH_DAKOTA", "SOUTH_DAKOTA", "MICHIGAN", "NEW_JERSEY", "MARYLAND", "DISTRICT_OF_COLUMBIA", "PENNSYLVANIA", "DELAWARE", "OHIO", "WISCONSIN_RPS", "WISCONSIN_RRC", "IOWA_AEP", "MINNESOTA_SES_SMALL_SOLAR", "MINNESOTA_CBED", "NEWJERSEY_CLASS1", "NEWJERSEY_CLASS2", "NEWJERSEY_SOLAR", "NEWJERSEY_TRANSITION", "NEWJERSEY_SREC2", "PENNSYLVANIA_CLASS1", "PENNSYLVANIA_CLASS2", "PENNSYLVANIA_SOLAR", "MARYLAND_TIER1", "MARYLAND_TIER2", "MARYLAND_SOLAR", "MARYLAND_GEO", "MARYLAND_GEO_LI", "MARYLAND_BT", "DC_TIER1", "DC_TIER2", "DC_SOLAR", "DELAWARE_NEW", "OHIO_RES", "OHIO_SOLAR_RES", "CONNECTICUT_CLM", "CONNECTICUT_CHP", "MISSOURI", "DELAWARE_SOLAR", "NORTH_CAROLINA", "NC_IN-STATE", "NC_NEW", "NC_S886_10", "NC_S886_20", "NC_S886_N", "NEW_YORK", "KANSAS", "WV_RENEWABLE_ENERGY_RESOURCE", "WV_ALTERNATIVE_ENERGY_RESOURCE", "VIRGINIA", "VIRGINIA_DISTRIBUTED", "NYGATS_ZEC", "NYGATS_TIER_1", "NYGATS_IMPORT_TYPE_EDD", "NYGATS_IMPORT_TYPE_NA", "NYGATS_IMPORT_TYPE_BUN", "NYGATS_IMPORT_TYPE_UNB", "VERMONT_TIER1", "VERMONT_TIER2", "VERMONT_TIER4", "CT_CLASS_I_FERC", "MA_CES", "MA_CES_E", "NH_CLASS_I_BIODIESEL_PRODUCER"

  - `content.fuelTypes.stateEligibilities.stateIdentifier` (string)
    This is the identifier of the eligibility from the registry

  - `content.fuelTypes.voluntaryEligibilities` (array)

  - `content.fuelTypes.voluntaryEligibilities.name` (string)
    The name of the registry voluntary eligibility.

  - `content.fuelTypes.voluntaryEligibilities.type` (string)
    The type, as compliance or voluntary.
    Enum: "GREEN_E_CLIMATE", "GREEN_E_ENERGY_ELIGIBLE", "ECOLOGO_CERTIFIED", "LOW_IMPACT_HYDRO_INSTITUTE_CERTIFIED", "SMUD_ELIGIBLE", "US_EPA_GPP_ELIGIBLE", "EFEC_ELIGIBLE", "IOWA_VOLUNTARY_GREEN", "ZEC", "FEED_IN_TARIFF"

  - `content.fuelTypes.voluntaryEligibilities.effectiveDate` (string)
    The effective date of the eligibility.

  - `content.fuelTypes.voluntaryEligibilities.expirationDate` (string)
    the expiration date of the eligibility.

## Response 400 fields (application/json):

  - `code` (string)
    Enum: "INVALID_REQUEST", "INVALID_PROGRAM", "INVALID_MARKET_SEARCH_TYPE", "INVALID_FUEL_TYPE", "INVALID_STATE", "INVALID_COUNTRY", "INVALID_PAGE_SIZE", "INVALID_PAGE_NUMBER"

  - `message` (string)

## Response 401 fields (application/json):

  - `message` (string)

## Response 500 fields (application/json):

  - `message` (string)