The Project Object
| Object Property | Required | Object Type | Description | Max Character Length |
|---|
| ProjectName | Yes | String | Name Of Project | 600 |
| AccountClientId | Yes | Integer | Client Id Of Project | 10 |
| AccountProjectId | No | Integer | Id Of Project | 10 |
| AccountProjectTypeId | No | Integer | Type Id Of Project | 10 |
| ProjectBillingTypeId | No | Integer | Billing Type Id Of Project | 10 |
| ProjectDescription | No | String | ProjectDescription Of Project | 4000 |
| StartDate | No | Date Time | StartDate Of Project | 19 |
| AccountMilestoneId | No | Integer | Milestone Id Of Project | 10 |
| Deadline | No | Date Time | Deadline Date Of Project | 19 |
| LeaderEmployeeId | No | Integer | Leader Employee Id Of Project | 10 |
| ProjectManagerEmployeeId | No | Integer | Project Manager Employee Id Of Project | 10 |
| EstimatedTime | No | Date Time | Estimated Time Of Project | 19 |
| EstimatedDuration | No | Float | Estimated Duration Of Project | 10 |
| EstimatedDurationUnit | No | String | Estimated Duration Unit Of Project | 20 |
| ProjectCode | No | String | Code Of Project | 100 |
| DefaultBillingRate | No | Decimal | Default Billing Rate Of Project | 10 |
| ProjectStatusId | No | Integer | Status Id Of Project | 10 |
| TimeSheetApprovalTypeId | No | Integer | TimeSheet Approval Type Id Of Project | 10 |
| ExpenseApprovalTypeId | No | Integer | Expense Approval Type Id Of Project | 10 |
| ProjectBillingRateTypeId | No | Integer | Billing Rate Type Id Of Project | 10 |
| AccountClientContactId | No | Integer | Project Contact Id Of Project | 10 |
| AccountClientDepartmentId | No | Integer | Project Department Id Of Project | 10 |
| IsDisabled | No | Boolean | Disabled Status Of Project | 1 |
| IsTemplate | No | Boolean | Template Status Of Project | 1 |
| IsProject | No | Boolean | Is This a Project | 1 |
| AccountProjectTemplateId | No | Integer | Project Template Id Of Project | 10 |
| Completed | No | Boolean | Completed Status Of Project | 1 |
| CustomField1 | No | String | CustomField 1 Of Project | 2000 |
| CustomField2 | No | String | CustomField 2 Of Project | 2000 |
| CustomField3 | No | String | CustomField 3 Of Project | 2000 |
| CustomField4 | No | String | CustomField 4 Of Project | 2000 |
| CustomField5 | No | String | CustomField 5 Of Project | 2000 |
| CustomField6 | No | String | CustomField 6 Of Project | 2000 |
| CustomField7 | No | String | CustomField 7 Of Project | 2000 |
| CustomField8 | No | String | CustomField 8 Of Project | 2000 |
| CustomField9 | No | String | CustomField 9 Of Project | 2000 |
| CustomField10 | No | String | CustomField 10 Of Project | 2000 |
| CustomField11 | No | String | CustomField 11 Of Project | 2000 |
| CustomField12 | No | String | CustomField 12 Of Project | 2000 |
| CustomField13 | No | String | CustomField 13 Of Project | 2000 |
| CustomField14 | No | String | CustomField 14 Of Project | 2000 |
| CustomField15 | No | String | CustomField 15 Of Project | 2000 |
| ProjectPrefix | No | String | Prefix Of Project | 100 |
| ProjectEstimatedCost | No | Float | Estimated Cost Of Project | 10 |
| IsForAllClientProject | No | Boolean | Project is for all Clients | 1 |
| FixedCost | No | Float | Fixed Cost Of Project | 10 |
List All Projects
Returns a list of your all Projects in your UNItekTIME account.
GET /API/Projects
Example Request
curl "https://demo.unitektime.com/api/Projects" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountProjectId": 00001,
"ProjectName": "Demo Project",
"StartDate": null,
"ProjectCode": null,
"AccountClientName": "Demo Client",
"LeaderName": "Employee 1",
"ProjectManagerName": "Employee 2",
"Deadline": "2018-07-20T13:52:00+00:00",
"EstimatedDuration": null,
"EstimatedDurationUnit": null,
"ProjectEstimatedCost": 0.0,
"Status": "Started",
"ProjectDescription": " ",
"CreatedOn": "2018-06-20T13:52:21.957+00:00",
"ModifiedOn": "2018-06-20T13:52:21.957+00:00",
"ProjectType": "Technology",
"CustomField1": null,
"CustomField2": null,
"CustomField3": null,
"CustomField4": null,
"CustomField5": null,
"CustomField6": null,
"CustomField7": null,
"CustomField8": null,
"CustomField9": null,
"CustomField10": null,
"CustomField11": null,
"CustomField12": null,
"CustomField13": null,
"CustomField14": null,
"CustomField15": null,
"Completed": "No"
}
]
Retrieve a Project
Retrieves the Project with the given ID. Returns a Project object and a 200 OK response code if a valid identifier was provided.
GET /API/Projects/{Project_ID}
Example Request
curl "https://demo.unitektime.com/api/Projects/00001" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "Content-Type: application/json" \
-H "User-Agent: MyApp (yourname@example.com)"
Example Response
[
{
"AccountProjectId": 00001,
"ProjectName": "Demo Project",
"StartDate": null,
"ProjectCode": null,
"AccountClientName": "Demo Client",
"LeaderName": "Employee 1",
"ProjectManagerName": "Employee 2",
"Deadline": "2018-07-20T13:52:00+00:00",
"EstimatedDuration": null,
"EstimatedDurationUnit": null,
"ProjectEstimatedCost": 0.0,
"Status": "Started",
"ProjectDescription": " ",
"CreatedOn": "2018-06-20T13:52:21.957+00:00",
"ModifiedOn": "2018-06-20T13:52:21.957+00:00",
"ProjectType": "Technology",
"CustomField1": null,
"CustomField2": null,
"CustomField3": null,
"CustomField4": null,
"CustomField5": null,
"CustomField6": null,
"CustomField7": null,
"CustomField8": null,
"CustomField9": null,
"CustomField10": null,
"CustomField11": null,
"CustomField12": null,
"CustomField13": null,
"CustomField14": null,
"CustomField15": null,
"Completed": "No"
}
]
Create a Project
Creates a new Project. Returns Response message and a 201 Created response code if the call succeeded.
POST /API/Projects
| Object Property | Required | Object Type | Description | Max Character Length |
|---|
| ProjectName | Yes | String | Name Of Project | 600 |
| AccountClientId | Yes | Integer | Client Id Of Project | 10 |
Example Request
curl "https://demo.unitektime.com/api/Projects" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json" \
-d "{'AccountClientId':00001,'Projectname':'LEGO'}"
Example Response
[
{
"id": "00003",
"message": "Project Added Successfully"
}
]
Update a Project
Updates the specific Project by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Returns Response message and a 200 OK response code if the call succeeded.
POST /API/Projects/{Project_id}
Example Request
curl "https://demo.unitektime.com/api/Projects/00003" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json" \
-d "{'ProjectDescription':'Demo Description of Project'}"
Example Response
[
{
"id": "00003",
"message": "Project Updated Successfully"
}
]
Delete a Project
Delete a Project. Returns a 200 OK response code if the call succeeded.
DELETE /API/Projects/{Project_ID}
Example Request
curl "https://demo.unitektime.com/api/Projects/00003" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X DELETE \
-H "Content-Type: application/json"
Example Response
[
{
"id": "00003",
"message": "Project Deleted Successfully"
}
]
Add Employee in a Project
Adds an Employee in a Project. Returns a 200 OK response code if the call succeeded.
POST /API/Projects/AddProjectEmployee/{Project_ID}/{Employee_ID}
Example Request
curl "https://demo.unitektime.com/api/Projects/AddProjectEmployee/2153/65415" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X POST \
-H "Content-Type: application/json"
Example Response
[
{
"Message": "Employee with Id '65415' is Successfully added to project"
}
]
Remove Employee in a Project
Removes an Employee in a Project. Returns a 200 OK response code if the call succeeded.
DELETE /API/Projects/RemoveProjectEmployee/{Project_ID}/{Employee_ID}
Example Request
curl "https://demo.unitektime.com/api/Projects/RemoveProjectEmployee/2153/65415" \
-H "APIKey: {Your API Key}" \
-H "AuthToken: {Your Authentication Token}" \
-H "User-Agent: MyApp (yourname@example.com)" \
-X DELETE \
-H "Content-Type: application/json"
Example Response
[
{
"Message": "Employee with Id '65415' is Successfully Removed from project"
}
]