Program Details

Inspect the response fields that describe each program and the corresponding application state.

JSON Example

1{
2  "applicationId": "a3Qxx0000001XYZEA2",
3  "applicationStatus": "In Review",
4  "businessSector": "Residential",
5  "defaultImageComment": "Program hero image",
6  "defaultImageUrl": "https://example.my.site.com/images/program-default.png",
7  "isActive": true,
8  "isRegulatoryProgram": false,
9  "name": "Residential Heat Pump Rebate",
10  "programDeliveryType": "Rebate",
11  "programId": "a1Bxx0000008abcEAA",
12  "programManagerId": "005xx00000123AbAAI",
13  "programType": "Energy Efficiency",
14  "regulatoryProgramName": "Clean Energy Rebate Program",
15  "shortForm": "HER",
16  "summary": "Provides rebates for qualifying residential heat pump installations."
17}

Properties

Property Name	Type	Description	Required or Optional	Available Version
`applicationId`	String	Record ID that identifies the application associated with the program.	Optional	60.0
`applicationStatus`	String	Current status of the program application.	Optional	60.0
`businessSector`	String	Business sector that the program is intended for.	Optional	60.0
`defaultImageComment`	String	Alternative text for the default image associated with the program.	Optional	60.0
`defaultImageUrl`	String	Default image URL associated with the program.	Optional	60.0
`isActive`	Boolean	Indicates whether the program is currently active.	Optional	60.0
`isRegulatoryProgram`	Boolean	Indicates whether this is categorized as a regulatory program.	Optional	60.0
`name`	String	Display name of the program.	Optional	60.0
`programDeliveryType`	String	Delivery model used by the program, such as rebate or incentive.	Optional	60.0
`programId`	String	Record ID that identifies the program.	Optional	60.0
`programManagerId`	String	User ID of the manager responsible for the program.	Optional	60.0
`programType`	String	Program category used for classification.	Optional	60.0
`regulatoryProgramName`	String	Regulator-provided name for the program when applicable.	Optional	60.0
`shortForm`	String	Acronym or short label for the program.	Optional	60.0
`summary`	String	Short summary describing the program.	Optional	60.0