supplyPointFieldDefinitions

Get the enrollment fields collected for a supply point in a given market, along with their choices and the rules controlling when they apply.

Arguments

marketName : SupplyPointMarketNameEnum!


            required

The market to return supply point enrollment fields for.

Returns

SupplyPointFieldDefinitionsType

The enrollment fields collected for supply points in one market.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query leads

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

query SupplyPointFieldDefinitions($marketName: SupplyPointMarketNameEnum!) {
  supplyPointFieldDefinitions(marketName: $marketName) {
    fields {
      ...SupplyPointFieldDefinitionTypeFragment
    }
    hasPayloadValidator
  }
}

{
  "marketName": "GBR_ELECTRIC_JUICE"
}

{
  "data": {
    "supplyPointFieldDefinitions": {
      "fields": [SupplyPointFieldDefinitionType],
      "hasPayloadValidator": true
    }
  }
}