GetPrograms

Retrieves a list of programs associated that are read-accessible to the user.

HTTP verb: GET

Query string parameters
Name	Data Type	Required/Optional	Description
Agency	String	Optional	If the optional “Agency” parameter is set, then only programs of that respective agency will be retrieved.
Filter	String	Optional	If the optional “Filter” parameter is set only programs that meet the filter criteria will be retrieved.

Filter	Content
Production	Production programs will be retrieved
Test	Test environment programs will be retrieved

URL Format

Format: https://{BaseURL}/Programs&Filter={Filter}
Sample: https://{BaseURL}/Programs
https://{BaseURL}/Programs?Filter=Test
https://{BaseURL}/Programs?Filter=Production

Response


<ProgramsResponse>
 <Programs>
  <Program ProgramId="A43FN6BR" AgencyId="7JWS463" ProgramName="Residential Solar Interconnection Program" AgencyName="Figment Light and Power" />
  <Program ProgramId="1HF29X4P" AgencyId="7JWS463" ProgramName="Commercial Solar Interconnection Program" AgencyName="Figment Light and Power" />
 </Programs>
</ProgramsResponse>


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://service.powerclerk.com/api/v1/">
  <xs:element name="ProgramsResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Programs">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Program" maxOccurs="unbounded" minOccurs="0">
                <xs:complexType>
                  <xs:simpleContent>
                    <xs:extension base="xs:string">
                      <xs:attribute type="xs:string" name="ProgramId" use="required"/>
                        <xs:attribute type="xs:string" name="AgencyId" use="required"/>
                        <xs:attribute type="xs:string" name="ProgramName" use="required"/>
                        <xs:attribute type="xs:string" name="AgencyName" use="required"/>
                      </xs:extension>
                    </xs:simpleContent>
                  </xs:complexType>
                </xs:element>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:sequence>
      <xs:attribute type="xs:float" name="SchemaVersion"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Response XML Attributes

ProgramId – Unique identifier for the program
AgencyId – Unique identifier for the agency
ProgramName – Program name
AgencyName – Agency name

Sample Code


// Retrieves info about all programs in a given agency.
// Returns a list of <ProgramId, ProgramName> pairs, one for each program in the list.

public List<Tuple<string, string>> GetProgramInfo(string agencyId, string username, string password, string apiKey)
{
    string url = "/Programs?Agency=" + agencyId;
    XDocument xmlResponse = MakeGetRequest(BaseUrl + url, username, password, apiKey);

    XNamespace ns = "http://service.powerclerk.com/api/v1/";
    List<XElement> programElements = xmlResponse.Descendants(ns + "Program").ToList();

    List<Tuple<string, string>> programs = new List<Tuple<string, string>>();
    foreach (XElement programElement in programElements)
    {
        string programId = programElement.Attribute("ProgramId").Value;
        string programName = programElement.Attribute("ProgramName").Value;
        programs.Add(new Tuple<string,string>(programId, programName));
    }
    return programs;
}


function getPrograms(agencyId) {
    // Use $.ajax jQuery method to execute the API call
    $.ajax({
        type: "GET",
        url: "https://{BaseURL}/Programs?Agency=" + agencyId,
        dataType: "xml",
        beforeSend: function (xhr) {
            xhr.setRequestHeader("Authorization", "Basic " + hashedCredentials);
            xhr.setRequestHeader("X-ApiKey", apiKey);
        },
        success: function (xml) {
        // Display data
        },
        error: function (xhr) {
        // Display error
        }
    });
}

See Chapter Code Samples for MakeGetRequest sample code.

What’s Next?

Cookie	Duration	Description
CloudFlare CDN	4 weeks	This cookie is set by CloudFare to identify individual clients behind a shared IP address and apply security settings on a per-client basis. It does not correspond to any user ID in the web application and does not store any personally identifiable information.
CookieLawInfo Checkbox Necessary	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category ‘Strictly Necessary’.
CookieLawInfo Checkbox Performance	11 months	This cookie is set by GDPR Cookie Consent plugin. The purpose of this cookie is to check whether or not the user has given the consent to the usage of cookies under the category ‘Performance’.
CookieLawInfo Checkbox Personalization	11 months	This cookie is set by GDPR Cookie Consent plugin. The purpose of this cookie is to check whether or not the user has given the consent to the usage of cookies under the category ‘Enhancements & Personalization’.
Viewed Cookie Policy	1 hour	This cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.
Website Search Interaction	Session	This cookie is set by Site Search 360, our search engine for all Clean Power Research websites, to record search session preferences and performance.
Website Search Session ID	11 months	This cookie is set by Site Search 360, our search engine for all Clean Power Research websites, to record search session preferences.

Cookie	Duration	Description
Google Analytics Data Limiter	1 minute	This cookie is installed by Google Universal Analytics to throttle the request rate to limit the colllection of data on high traffic sites.
Google Analytics Page Visits	1 day	This cookie is installed by Google Analytics. The cookie is used to store information of how visitors use a website and helps in creating an analytics report of how the wbsite is doing. The data collected including the number visitors, the source where they have come from, and the pages visted in an anonymous form.
Google Analytics Random Identifier	2 years	This cookie is installed by Google Analytics. The cookie is used to calculate visitor, session, campaign data and keep track of site usage for the site’s analytics report. The cookie stores information anonymously and assigns a randomly generated number to identify unique visitors.
Marketo Tracking	2 years	This cookie is associated with an email marketing service provided by Marketo. This tracking cookie allows the website to link visitor behavior to the recipient of an email marketing campaign, to measure campaign effectiveness.

Cookie	Duration	Description
Wistia Videos	11 months	Set by Wistia to support video functionality that may be found throughout the website. In addition to keeping track of the website visitor's position in a video should playback be interrupted, this cookie also notes user behavior regarding the video itself.
Wistia Videos Data	10 months	This cookie collects visitor interaction data regarding Wistia video content so that such content can be made more relevant to the visitor.

Application & Process Automation

GetPrograms

URL Format

Response

Response XML Attributes

Sample Code

GetForms