GetProjectStatusHistory – Admin only

Get the status history associated with a given project. Returns a list of statuses entered by the project along with the timestamp of each status entry. If the project has entered a given status multiple times, one output line will be returned for each status entry (see example below).

Requires membership in an administrator role and read access to the program and project.

HTTP verb: GET
Required inputs: ProgramId, ProjectId

URL Format

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

Sample: https://{BaseURL}/Programs/A43FN6B/Projects/D4GJR65/StatusHistory?version=2

Version 2 Sample Response


<ProjectStatusHistoryResponse>
    <Project ProjectId="JC8SR659PV" ProgramId="1HF29X4P" ProjectNumber="TEST-00011">
        <StatusHistory>
            <Status StatusId="U2KE36T4" Name="Permission to Operate" ChangedBy="solar@cleanpower.com" Timestamp="2015-04-14T09:43:24-07:00"/>
            <Status StatusId="U11N9F91" Name="Application Review" ChangedBy="solar@cleanpower.com" Timestamp="2015-04-14T09:41:17-07:00"/>
            <Status StatusId="759NA6NH" Name="Inspection Pending" ChangedBy="solar@cleanpower.com" Timestamp="2015-04-14T09:39:40-07:00"/>
            <Status StatusId="U11N9F91" Name="Application Review" ChangedBy="solar@cleanpower.com" Timestamp="2015-04-08T11:10:29-07:00"/>
            <Status StatusId="3X8KK600" Name="Unsubmitted" ChangedBy="solar@cleanpower.com" Timestamp="2015-04-08T11:03:07-07:00"/>
        </StatusHistory>
    </Project>
</ProjectStatusHistoryResponse>


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://services.powerclerk.com/api/v1/">
  <xs:element name="ProjectStatusHistoryResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Project">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="StatusHistory">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="Status" maxOccurs="unbounded" minOccurs="0">
                      <xs:complexType>
                        <xs:simpleContent>
                          <xs:extension base="xs:string">
                            <xs:attribute type="xs:string" name="StatusId" use="required"/>
                            <xs:attribute type="xs:string" name="CustomId" use="optional"/>
                            <xs:attribute type="xs:string" name="Name" use="required"/>
                            <xs:attribute type="xs:string" name="ChangedBy" use="required"/>
                            <xs:attribute type="xs:dateTime" name="Timestamp" use="required"/>
                          </xs:extension>
                        </xs:simpleContent>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
            <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:complexType>
        </xs:element>
      </xs:sequence>
      <xs:attribute type="xs:float" name="SchemaVersion"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Response XML Attributes

<Project> Attributes

ProjectId – Unique identifier for the project
ProgramId – Unique identifier for the program
ProjectNumber – The project number. Projects are assigned a project number when they have been submitted.

<Status> Attributes

StatusId – Unique identifier for the status
CustomId – Custom, admin-provided, unique identifier for the status
Name – Status name
ChangedBy – Name of the user who initiated the status change
Timestamp – Timestamp of when the project entered the given status. Converted to user’s local timezone.

Version 1 Sample Response


<ProjectStatusHistoryResponse>
    <Project ProjectId="JC8SR659PV" ProgramId="1HF29X4P" ProjectNumber="TEST-00011">
        <StatusHistory>
            <Status StatusId="U2KE36T4" Name="Permission to Operate" Timestamp="2015-04-14T09:43:24-07:00"/>
            <Status StatusId="U11N9F91" Name="Application Review" Timestamp="2015-04-14T09:41:17-07:00"/>
            <Status StatusId="759NA6NH" Name="Inspection Pending" Timestamp="2015-04-14T09:39:40-07:00"/>
            <Status StatusId="U11N9F91" Name="Application Review" Timestamp="2015-04-08T11:10:29-07:00"/>
            <Status StatusId="3X8KK600" Name="Unsubmitted" Timestamp="2015-04-08T11:03:07-07:00"/>
        </StatusHistory>
    </Project>
</ProjectStatusHistoryResponse>


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://services.powerclerk.com/api/v1/">
  <xs:element name="ProjectStatusHistoryResponse">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Project">
          <xs:complexType>
            <xs:sequence>
              <xs:element name="StatusHistory">
                <xs:complexType>
                  <xs:sequence>
                    <xs:element name="Status" maxOccurs="unbounded" minOccurs="0">
                      <xs:complexType>
                        <xs:simpleContent>
                          <xs:extension base="xs:string">
                            <xs:attribute type="xs:string" name="StatusId" use="required"/>
                            <xs:attribute type="xs:string" name="CustomId" use="optional"/>
                            <xs:attribute type="xs:string" name="Name" use="required"/>
                            <xs:attribute type="xs:dateTime" name="Timestamp" use="required"/>
                          </xs:extension>
                        </xs:simpleContent>
                      </xs:complexType>
                    </xs:element>
                  </xs:sequence>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
            <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:complexType>
        </xs:element>
      </xs:sequence>
      <xs:attribute type="xs:float" name="SchemaVersion"/>
    </xs:complexType>
  </xs:element>
</xs:schema>

Response XML Attributes

<Project> Attributes

<Status> Attributes

StatusId – Unique identifier for the status
CustomId – Custom, admin-provided, unique identifier for the status
Name – Status name
Timestamp – Timestamp of when the project entered the given status. Converted to user’s local timezone.

Sample Code


// Retrieve the status history for the given project.
// Returns a list of <StatusId, StatusName, Timestamp> tuples, one for each status change.

public List<Tuple<string, string, string>> GetStatusHistory(string programId, string projectId, string username, string password, string apiKey)
{
    string url = "/Programs/" + programId + "/Projects/" + projectId + "/StatusHistory";
    XDocument xmlResponse = MakeGetRequest(BaseUrl + url, username, password, apiKey);

    XNamespace ns = "http://services.powerclerk.com/api/v1/";
    List<XElement> statusElements = xmlResponse.Descendants(ns + "Status").ToList();

    List<Tuple<string, string, string>> statusInfo = new List<Tuple<string, string, string>>();
    foreach (XElement element in statusElements)
    {
        string statusId = element.Attribute("StatusId").Value;
        string statusName = element.Attribute("Name").Value;
        string timestamp = element.Attribute("Timestamp").Value;
        statusInfo.Add(new Tuple<string, string, string>(statusId, statusName, timestamp));
    }
    return statusInfo;
}


function getStatusHistory(programId, projectId) {
    // Use $.ajax jQuery method to execute the API call
    $.ajax({
        type: "GET",
        url: "https://{BaseURL}/Programs/" + programId + "/Projects/" + projectId + "/StatusHistory",
        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?

SetProjectStatus – Admin only

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

GetProjectStatusHistory – Admin only

URL Format

Version 2 Sample Response

Response XML Attributes

<Project> Attributes

<Status> Attributes

Version 1 Sample Response

Response XML Attributes

<Project> Attributes

<Status> Attributes

Sample Code

SetProjectStatus – Admin only