GetProjectsByNumber

Retrieves a list of projects associated with the given program that are read-accessible to the user that have a project number that matches a project number in the request body.

HTTP verb: POST
Required inputs: ProgramId

Why a POST request and not a GET request?

HTTP specifications say that GET responses can’t depend on a body and with a POST body the request is not restricted by URL length.

URL Format

Format: https://{BaseURL}/Programs/{ProgramId}/Projects/ByNumber?version={VersionNumber}

Samples: https://{BaseURL}/Programs/1HF29X4P/Projects/ByNumber?version=2

Please note: in the 1.1 version of the API this method had a different URL format. The earlier one is supported for backwards compatibility only, please use the documented format above for all new API integrations.

Version 1 Response


<ProjectsResponse RequestTimestamp="2014-10-24T17:00:15.6487539+00:00">
    <Projects>
        <Project ProjectId="R4NC48YU" ProgramId="1HF29X4P" ProjectNumber="TEST-00001" Status="Set Meter Request Pending" StatusTimestamp="2014-09-05T13:34:39-07:00" LastChangeTimestamp="2014-10-15T09:07:15-07:00"/>
        <Project ProjectId="AK6ZP5H9" ProgramId="1HF29X4P" ProjectNumber="TEST-00004" Status="Application in Process" StatusTimestamp="2014-10-10T14:15:04-07:00" LastChangeTimestamp="2014-10-10T14:15:23-07:00"/>
        <Project ProjectId="54X25DK7CB" ProgramId="1HF29X4P" ProjectNumber="TEST-00003" Status="Application in Process" StatusTimestamp="2014-10-03T16:22:09-07:00" LastChangeTimestamp="2014-10-03T16:22:08-07:00"/>
        <Project ProjectId="9RZ2BR69UP" ProgramId="1HF29X4P" Status="Unsubmitted" StatusTimestamp="2014-10-17T13:09:05-07:00" LastChangeTimestamp="2014-10-17T13:09:09-07:00"/>
        <Project ProjectId="F8ZK6BK2CU" ProgramId="1HF29X4P" Status="Unsubmitted" StatusTimestamp="2014-10-21T14:22:13-07:00" LastChangeTimestamp="2014-10-21T14:59:40-07:00"/>
    </Projects>
</ProjectsResponse>


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://service.powerclerk.com/api/v1/">
  <xs:element name="ProjectsResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Projects">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Project" maxOccurs="unbounded" minOccurs="0">
                <xs:complexType>
                  <xs:simpleContent>
                    <xs:extension base="xs:string">
                      <xs:attribute type="xs:string" name="ProjectId" use="required"/>
                      <xs:attribute type="xs:string" name="ProgramId" use="required"/>
                      <xs:attribute type="xs:string" name="ProjectNumber" use="optional"/>
                      <xs:attribute type="xs:string" name="Status" use="required"/>
                      <xs:attribute type="xs:dateTime" name="StatusTimestamp" use="required"/>
                      <xs:attribute type="xs:dateTime" name="LastChangeTimestamp" 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:attribute type="xs:dateTime" name="RequestTimestamp"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Version 2 Response


<ProjectsResponse RequestTimestamp="2014-10-24T17:00:15.6487539+00:00">
    <Projects>
        <Project ProjectId="R4NC48YU" ProgramId="1HF29X4P" ProjectNumber="TEST-00001" Status="Set Meter Request Pending" StatusTimestamp="2014-09-05T13:34:39-07:00" LastChangeTimestamp="2014-10-15T09:07:15-07:00" StatusPublicId=”93JH4U3Z”/>
        <Project ProjectId="AK6ZP5H9" ProgramId="1HF29X4P" ProjectNumber="TEST-00004" Status="Application in Process" StatusTimestamp="2014-10-10T14:15:04-07:00" LastChangeTimestamp="2014-10-10T14:15:23-07:00" StatusPublicId="SE0BU2DG" />
        <Project ProjectId="54X25DK7CB" ProgramId="1HF29X4P" ProjectNumber="TEST-00003" Status="Application in Process" StatusTimestamp="2014-10-03T16:22:09-07:00" LastChangeTimestamp="2014-10-03T16:22:08-07:00" StatusPublicId="SE0BU2DG" />
        <Project ProjectId="9RZ2BR69UP" ProgramId="1HF29X4P" Status="Unsubmitted" StatusTimestamp="2014-10-17T13:09:05-07:00" LastChangeTimestamp="2014-10-17T13:09:09-07:00" StatusCustomId="CustomStatusId" StatusPublicId="3X8KK600" />
        <Project ProjectId="F8ZK6BK2CU" ProgramId="1HF29X4P" Status="Unsubmitted" StatusTimestamp="2014-10-21T14:22:13-07:00" LastChangeTimestamp="2014-10-21T14:59:40-07:00" StatusCustomId="CustomStatusId" StatusPublicId="3X8KK600" />
    </Projects>
</ProjectsResponse>


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://service.powerclerk.com/api/v1/">
  <xs:element name="ProjectsResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Projects">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="Project" maxOccurs="unbounded" minOccurs="0">
                <xs:complexType>
                  <xs:simpleContent>
                    <xs:extension base="xs:string">
                      <xs:attribute type="xs:string" name="ProjectId" use="required"/>
                      <xs:attribute type="xs:string" name="ProgramId" use="required"/>
                      <xs:attribute type="xs:string" name="ProjectNumber" use="optional"/>
                      <xs:attribute type="xs:string" name="Status" use="required"/>
                      <xs:attribute type="xs:string" name="StatusCustomId" use="required"/>
                      <xs:attribute type="xs:string" name="StatusPublicId" use="required"/>
                      <xs:attribute type="xs:dateTime" name="StatusTimestamp" use="required"/>
                      <xs:attribute type="xs:dateTime" name="LastChangeTimestamp" 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:attribute type="xs:dateTime" name="RequestTimestamp"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Sample Request


Note: Request payloads must include the namespace “http://service.powerclerk.com/api/v1” (see below).

<ProjectByNumberRequest xmlns="http://service.powerclerk.com/api/v1/">
    <Project ProjectNumber="TEST-00001" />
    <Project ProjectNumber="TEST-00021" />
    <Project ProjectNumber="TEST-00035" />
    <Project ProjectNumber="TEST-00036" />
</ProjectByNumberRequest>


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://service.powerclerk.com/api/v1/">
  <xs:element name="ProjectByNumberRequest">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Project" maxOccurs="unbounded" minOccurs="0">
          <xs:complexType>
            <xs:attribute type="xs:string" name="ProjectNumber" use="required"/>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

Sample Code


// Retrieves a info about a select group of projects accessible in the given program
// Returns a list of <ProjectId, ProjectNumber> pairs corresponding to each project in the list.

public static List<Tuple<string, string>> GetProjectsByNumber(string programId, List<string> projectNumberIds, string username, string password, string apiKey)
{
    // Create an XML request payload that assigns first name and last name values to the
    // corresponding data fields
    XNamespace ns = "http://service.powerclerk.com/api/v1/";
    List<XElement> projectNumbers = projectNumberIds.Select(projectNumber => new XElement(ns + "Project", new XAttribute("ProjectNumber", projectNumber))).ToList();

    XDocument xDocument = new XDocument(
        new XElement(ns + "ProjectByNumberRequest",
            projectNumbers));

    XmlDocument requestPayload = new XmlDocument();
    using (XmlReader xmlReader = xDocument.CreateReader())
    {
        requestPayload.Load(xmlReader);
    }

    // Generate url and execute request with the XML payload we created earlier
    string url = "/Programs/" + programId+ "/Projects";
    XDocument xmlResponse =
        MakePostRequest(BaseUrl + url, username, password, apiKey, requestPayload);

    List<XElement> projectElements = xmlResponse.Descendants(ns + "Project").ToList();

    List<Tuple<string, string>> projects = new List<Tuple<string, string>>();
    foreach (XElement projectElement in projectElements)
    {
        string projectId = projectElement.Attribute("ProjectId").Value;
        string projectNumber = projectElement.Attribute("ProjectNumber") != null ?
        projectElement.Attribute("ProjectNumber").Value : String.Empty;
        projects.Add(new Tuple<string, string>(projectId, projectNumber));
    }
    return projects;
}

See Chapter Code Samples for MakePostRequest 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