20.03.05 Projects

Root Folder > UNItekTIME Documentation > 20 TimeLive API > 20.03 API

20.03.05 Projects

The Project Object

Object PropertyRequiredObject TypeDescriptionMax Character Length
ProjectNameYesStringName Of Project600
AccountClientIdYesIntegerClient Id Of Project10
AccountProjectIdNoIntegerId Of Project10
AccountProjectTypeIdNoIntegerType Id Of Project10
ProjectBillingTypeIdNoIntegerBilling Type Id Of Project10
ProjectDescriptionNoStringProjectDescription Of Project4000
StartDateNoDate TimeStartDate Of Project19
AccountMilestoneIdNoIntegerMilestone Id Of Project10
DeadlineNoDate TimeDeadline Date Of Project19
LeaderEmployeeIdNoIntegerLeader Employee Id Of Project10
ProjectManagerEmployeeIdNoIntegerProject Manager Employee Id Of Project10
EstimatedTimeNoDate TimeEstimated Time Of Project19
EstimatedDurationNoFloatEstimated Duration Of Project10
EstimatedDurationUnitNoStringEstimated Duration Unit Of Project20
ProjectCodeNoStringCode Of Project100
DefaultBillingRateNoDecimalDefault Billing Rate Of Project10
ProjectStatusIdNoIntegerStatus Id Of Project10
TimeSheetApprovalTypeIdNoIntegerTimeSheet Approval Type Id Of Project10
ExpenseApprovalTypeIdNoIntegerExpense Approval Type Id Of Project10
ProjectBillingRateTypeIdNoIntegerBilling Rate Type Id Of Project10
AccountClientContactIdNoIntegerProject Contact Id Of Project10
AccountClientDepartmentIdNoIntegerProject Department Id Of Project10
IsDisabledNoBooleanDisabled Status Of Project1
IsTemplateNoBooleanTemplate Status Of Project1
IsProjectNoBooleanIs This a Project1
AccountProjectTemplateIdNoIntegerProject Template Id Of Project10
CompletedNoBooleanCompleted Status Of Project1
CustomField1NoStringCustomField 1 Of Project2000
CustomField2NoStringCustomField 2 Of Project2000
CustomField3NoStringCustomField 3 Of Project2000
CustomField4NoStringCustomField 4 Of Project2000
CustomField5NoStringCustomField 5 Of Project2000
CustomField6NoStringCustomField 6 Of Project2000
CustomField7NoStringCustomField 7 Of Project2000
CustomField8NoStringCustomField 8 Of Project2000
CustomField9NoStringCustomField 9 Of Project2000
CustomField10NoStringCustomField 10 Of Project2000
CustomField11NoStringCustomField 11 Of Project2000
CustomField12NoStringCustomField 12 Of Project2000
CustomField13NoStringCustomField 13 Of Project2000
CustomField14NoStringCustomField 14 Of Project2000
CustomField15NoStringCustomField 15 Of Project2000
ProjectPrefixNoStringPrefix Of Project100
ProjectEstimatedCostNoFloatEstimated Cost Of Project10
IsForAllClientProjectNoBooleanProject is for all Clients1
FixedCostNoFloatFixed Cost Of Project10

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 PropertyRequiredObject TypeDescriptionMax Character Length
ProjectNameYesStringName Of Project600
AccountClientIdYesIntegerClient Id Of Project10

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"
  }
]
Article ID: 109, , Modified: 3/23/2021 at 8:06 PM

Was this article helpful?

Share this article