Projects

  • Punch in to a project

    POST /api/1/projects/:id/punch_in.json
    Formats
    json jsonp

    Punch in to a project. Can take an activity_uuid. Punching in to a new projects will punch out of any running projects

    Errors
    • 401 Unauthorized
    • 403 Read Denied - if the user is not allowed to punch in to this project
    • 404 Record Not Found - returned if the company with the specified UUID is not found
    • 404 Record Not Found - returned if the project with the specified UUID is not found
    Example
    DELETE /api/1/projects/859d8679-b803-4f0d-bf00-4c522d829209/punch_in
    200
    {
      "response": {
        "active": "true",
        "company_uuid": "f18d8bdc-080c-4de3-b028-01e5087521f4",
        "default_tags": null,
        "hourly_rate": null,
        "hourly_rate_cents": null,
        "name": "sunt similique",
        "notes": null,
        "time_limit": null,
        "time_limit_string": null,
        "uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
        "visibility": "private",
        "activities": [
          {
            "name": "ratione eum",
            "project_uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
            "uuid": "7951280c-18fa-46a7-b34a-9032a17a6dd1"
          },
          {
            "name": "aperiam natus",
            "project_uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
            "uuid": "18991cdf-5e8a-4b6d-85cf-94c2cf0c4613"
          }
        ],
        "running": true,
        "grand_total": 0,
        "running_total": 0,
        "started_at": 1376633965,
        "current_shift": {
          "billable": true,
          "notes": null,
          "project_uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
          "start": "2013-08-16T06:19:25Z",
          "stop": null,
          "time_zone": "Australia/Perth",
          "time_zone_offset": null,
          "user_uuid": "0129a92a-5dd1-4da9-b4c6-ff5aeaf19d24",
          "uuid": "bd3aa18c-4b2a-46de-ad96-99708bd3cf9f",
          "activity_uuid": null,
          "tag_list": []
        },
        "shift_notes": null,
        "shift_tag_list": "",
        "shift_billable": true
      }
    }

    Punch in to a project belonging to a company

    POST /api/1/companies/:company_uuid/projects/:uuid/punch_in.json
    Formats
    json jsonp

    Punch in to a project. Can take an activity_uuid. Punching in to a new projects will punch out of any running projects

    Errors
    • 401 Unauthorized
    • 403 Read Denied - if the user is not allowed to punch in to this project
    • 404 Record Not Found - returned if the company with the specified UUID is not found
    • 404 Record Not Found - returned if the project with the specified UUID is not found
    Example
    DELETE /api/1/projects/859d8679-b803-4f0d-bf00-4c522d829209/punch_in
    200
    {
      "response": {
        "active": "true",
        "company_uuid": "f18d8bdc-080c-4de3-b028-01e5087521f4",
        "default_tags": null,
        "hourly_rate": null,
        "hourly_rate_cents": null,
        "name": "sunt similique",
        "notes": null,
        "time_limit": null,
        "time_limit_string": null,
        "uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
        "visibility": "private",
        "activities": [
          {
            "name": "ratione eum",
            "project_uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
            "uuid": "7951280c-18fa-46a7-b34a-9032a17a6dd1"
          },
          {
            "name": "aperiam natus",
            "project_uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
            "uuid": "18991cdf-5e8a-4b6d-85cf-94c2cf0c4613"
          }
        ],
        "running": true,
        "grand_total": 0,
        "running_total": 0,
        "started_at": 1376633965,
        "current_shift": {
          "billable": true,
          "notes": null,
          "project_uuid": "859d8679-b803-4f0d-bf00-4c522d829209",
          "start": "2013-08-16T06:19:25Z",
          "stop": null,
          "time_zone": "Australia/Perth",
          "time_zone_offset": null,
          "user_uuid": "0129a92a-5dd1-4da9-b4c6-ff5aeaf19d24",
          "uuid": "bd3aa18c-4b2a-46de-ad96-99708bd3cf9f",
          "activity_uuid": null,
          "tag_list": []
        },
        "shift_notes": null,
        "shift_tag_list": "",
        "shift_billable": true
      }
    }