Projjex API

Summary Information Methods
Overview

The summary information methods allow you to get aggregate information for your projects.

Methods
Projects Summary
URL: http://api.projjex.com/projects/summary/
Overview
Returns the current status of all your active projects. Each project will contain that status of the project deadlines and how project resource and financial budgets are doing. The 2 parameters are given a status of green, yellow or red - corresponding to the indicators shown on your Projjex™ Dashboard, along with a text description.
Parameters
Name Description Required
Session Session token received when logging in. Yes
Example
http://api.projjex.com/projects/summary/?Session=UJ0X23LRZPR1AFX5YKF4
Sample XML Response
<Projects>
    <Project ProjectID="1234" Name="Hamilton Paving">
        <Deadlines Status="red" Description="This project has 2 overdue items.
            1 overdue item is assigned to me."/>
        <Resources Status="green" Description="This project is using 14%
            of its resource budget."/>
        <Financial Status="green" Description="This project is using 27%
            of its financial budget."/>
    </Project>
    <Project ProjectID="1235" Name="Northstar Awnings">
        <Deadlines Status="green" Description="This project does not have 
            any overdue items"/>
        <Resources Status="red" Description="This project is over its
            resource budget."/>
        <Financial Status="red" Description="This project is over its
            financial budget."/>
    </Project>
</Projects>
Sample JSON Response
handleProjjexData({ "Projects": { "Project": [ {"Deadlines": {"Description": "This project has 2 overdue items. 1 overdue item is assigned to me.", "Status": "red" }, "Financial": {"Description": "This project is using 27% of its financial budget.", "Status": "green" }, "Name": "Hamilton Paving", "ProjectID": "1234", "Resources": {"Description": "This project is using 14% of its resource budget.", "Status": "green" } }, {"Deadlines": {"Description": "This project does not have any overdue items", "Status": "green" }, "Financial": {"Description": "This project is over its financial budget.", "Status": "red" }, "Name": "Northstar Awnings", "ProjectID": "1235", "Resources": {"Description": "This project is over its resource budget.", "Status": "red" } } ] }});
Deadline Summary
URL: http://api.projjex.com/items/deadlinesummary/
Overview
Lists all items across all active projects that are either overdue, due today, or due within the specified number of days.
Parameters
Name Description Required
Session Session token received when logging in. Yes
Status One of the following values:
  • Overdue: Returns a list of all overdue items.
  • Today: Returns a list of all items due today.
  • Soon: Returns a list of all items due within the number of days specified by the Days parameter.
 Yes
Days This parameter is only applicable if the Status is "soon", and will specify the number of days. If no Days value is passed in, this will default to 14 days. No
Example
http://api.projjex.com/items/deadlinesummary/?Session=UJ0X23LRZPR1AFX5YKF4&Status=overdue
Sample XML Response
<Items>
    <Item ProjectID="1234" ProjectName="Hamilton Paving" ItemID="7"
      ItemType="Task" Name="Development:  Phase 1">
        <Resp Initials="BB">bill.bubbagum@gmail.com</Resp>
        <DueOn>2008-07-24</DueOn>
    </Item>
    <Item ProjectID="1235" ProjectName="Hamilton Paving" ItemID="6"
      ItemType="Task" Name="Project Supervision">
        <Resp Initials="AB">alex.bubbagum@gmail.com</Resp>
        <DueOn>2008-07-31</DueOn>
    </Item>
</Items>
Sample JSON Response
handleProjjexData({ "Items": { "Item": [ {"DueOn": "2008-07-24", "ItemID": "7", "ItemType": "Task", "Name": "Development: Phase 1", "ProjectID": "1234", "ProjectName": "Hamilton Paving", "Resp": {"Initials": "BB", "value": "bill.bubbagum@gmail.com" } }, {"DueOn": "2008-07-31", "ItemID": "6", "ItemType": "Task", "Name": "Project Supervision", "ProjectID": "1235", "ProjectName": "Hamilton Paving", "Resp": {"Initials": "AB", "value": "alex.bubbagum@gmail.com" } } ] }});
Recent Activity
URL: http://api.projjex.com/items/recentactivity/
Overview
Lists all the recent activity across your active projects. This is the equivalent list that shows up in the Recent Activity area of your Projjex™ Dashboard.
Parameters
Name Description Required
Session Session token received when logging in. Yes
Example
http://api.projjex.com/items/recentactivity/?Session=UJ0X23LRZPR1AFX5YKF4
Sample XML Response
<Activity>
    <Item ActivityID="252" ProjectID="1234" ProjectName="Hamilton Paving"
      ItemID="78" ItemType="Time" Name="Installation">
        <ActionDate>2008-09-04</ActionDate>
        <Action>ADDED</Action>
        <By>MB</By>
        <Resp>MB</Resp>
    </Item>
    <Item ActivityID="130" ProjectID="1325" ProjectName="Admin Time"
      ItemID="61" ItemType="Time" Name="General administration">
        <ActionDate>2008-09-04</ActionDate>
        <Action>REMOVED from project</Action>
        <By>MB</By>
    </Item>
</Activity>
Sample JSON Response
handleProjjexData({ "Activity": { "Item": [ {"Action": "ADDED", "ActionDate": "2008-09-04", "ActivityID": "252", "By": "MB", "ItemID": "78", "ItemType": "Time", "Name": "Installation", "ProjectID": "1324", "ProjectName": "Hamilton Paving", "Resp": "MB" }, {"Action": "REMOVED from project", "ActionDate": "2008-09-04", "ActivityID": "130", "By": "MB", "ItemID": "61", "ItemType": "Time", "Name": "General administration", "ProjectID": "1235", "ProjectName": "Admin Time" } ] }});
Mark Activity Read
URL: http://api.projjex.com/items/markactivityread/
Overview
This will mark an item from your Recent Activity list as read, which will remove the item from your recent activity list.
Parameters
Name Description Required
Session Session token received when logging in. Yes
ProjectID The unique identifier of the project. Yes
ActivityID The unique identifier of the recent activity item. The ActivityID is found in the data returned by the Recent Activity method. Yes
Example
http://api.projjex.com/items/markactivityread/?Session=UJ0X23LRZPR1AFX5YKF4&ProjectID=1234&ActivityID=252
Sample XML Response
<Activity ProjectID="1234" ProjectName="Hamilton Paving"
    ActivityID="252" Read="true"/>
Sample JSON Response
handleProjjexData({ "Activity": {"ActivityID": "252", "ProjectID": "1234", "ProjectName": "Hamilton Paving", "Read": "true" }});
Quick Links

Introduction

Projjex™ Basics

Authentication

Documentation

Using Remote JSON

Support

.NET developers can download our .NET API Wrapper. The wrapper simplifies using the Projjex™ API by returning .NET objects.

API Methods
Authentication Projects Items Documents Managed Documents Summary Information