People - GetBric/API GitHub Wiki

People are your workers, who you will assign to projects. This could be an employee or a contractor.

People Index

• Route: /people
• Method: GET
• Expected Response:

{
  "people": [
    {
      "id": 1062390218,
      "link": "https://api.getbric.com/v1/people/1062390218",
      "first_name": "Glenn",
      "last_name": "Quagmire",
      "email": "[email protected]",
      "billing_rate": "80.0",
      "billable_hours": 32,
      "cost": 50.0,
      "previous_costs": null,
      "person_role": null,
      "time_blocks": [
        {
          "id": 980191001,
          "link": "https://api.getbric.com/v1/time_blocks/980191001",
          "start_date": "2016-03-24",
          "end_date": "2016-03-26"
        }
      ],
      "created_at": "2016-02-12T17:44:58.783-05:00",
      "updated_at": "2016-02-12T17:56:57.915-05:00"
    },
    {
      "id": 1062390216,
      "link": "https://api.getbric.com/v1/people/1062390216",
      "first_name": "Sean",
      "last_name": "Connery",
      "email": "[email protected]",
      "billing_rate": "65.0",
      "billable_hours": 30,
      "cost": "50.0",
      "previous_costs": {
      "2016-04-14": "45.0"
    },
      "person_role": {
        "id": 374648174,
        "link": "https://api.getbric.com/v1/person_roles/374648174",
        "name": "Engagement Manager"
      },
      "time_blocks": [
        {
          "id": 980190968,
          "link": "https://api.getbric.com/v1/time_blocks/980190968",
          "start_date": "2016-03-29",
          "end_date": "2016-03-29"
        },
        {
          "id": 980190969,
          "link": "https://api.getbric.com/v1/time_blocks/980190969",
          "start_date": "2016-03-28",
          "end_date": "2016-03-28"
        }
      ],
      "created_at": "2015-11-19T16:27:15.124-05:00",
      "updated_at": "2016-01-19T12:27:16.280-05:00"
    }
  ]
}

Person Create

• Route: /people
• Method: POST
• Required Fields:
  • first_name
  • last_name
• Allowed Fields:
  • email
  • person_role (Allowed parameters: You can enter either a person role's name or id.)
  • billing_rate (per hour, what you bill their work out at)
  • billable_hours (per week)
  • cost (per hour, what you pay this person)
• Expected Response:

{
  "people": {
    "id": 1062390230,
    "link": "https://api.getbric.com/v1/people/1062390230",
    "first_name": "Michael",
    "last_name": "Jordan",
    "email": "[email protected]",
    "billing_rate": "200.0",
    "billable_hours": 40,
    "cost": "100.0",
    "previous_costs": null,
    "person_role": {
      "id": 374648174,
      "link": "https://api.getbric.com/v1/person_roles/374648174",
      "name": "Engagement Manager"
    },
    "time_blocks": [],
    "created_at": "2016-04-14T15:27:35.692-04:00",
    "updated_at": "2016-04-14T15:27:35.692-04:00"
  }
}

Person Show

• Route: /people/id
• Method: GET
• Expected Response:

{
  "people": {
    "id": 1062390216,
    "link": "https://api.getbric.com/v1/people/1062390216",
    "first_name": "Sean",
    "last_name": "Connery",
    "email": "[email protected]",
    "billing_rate": "65.0",
    "billable_hours": 30,
    "cost": "50.0",
    "previous_costs": {
    "2016-04-14": "45.0"
    },
    "person_role": {
      "id": 374648174,
      "link": "https://api.getbric.com/v1/person_roles/374648174",
      "name": "Engagement Manager"
    },
    "time_blocks": [
      {
        "id": 980190968,
        "link": "https://api.getbric.com/v1/time_blocks/980190968",
        "start_date": "2016-03-29",
        "end_date": "2016-03-29"
      },
      {
        "id": 980190969,
        "link": "https://api.getbric.com/v1/time_blocks/980190969",
        "start_date": "2016-03-28",
        "end_date": "2016-03-28"
      }
    ],
    "created_at": "2015-11-19T16:27:15.124-05:00",
    "updated_at": "2016-04-14T14:50:00.822-04:00"
  }
}

Person Update

• Route: /people/id
• Method: PATCH
• Allowed Fields:
  • first_name
  • last_name
  • email
  • person_role (Allowed parameters: You can enter either a person role's name or id.)
  • billing_rate (per hour, what you bill their work out at)
  • billable_hours (per week)
  • cost (per hour, what you pay this person)
• Expected Response:

{
  "people": {
    "id": 1062390230,
    "link": "https://api.getbric.com/v1/people/1062390230",
    "first_name": "Michael",
    "last_name": "Jordan",
    "email": "[email protected]",
    "billing_rate": "200.0",
    "billable_hours": 40,
    "cost": "125.0",
    "previous_costs": {
      "2016-04-14": "100.0"
    },
    "person_role": {
      "id": 374648174,
      "link": "https://api.getbric.com/v1/person_roles/374648174",
      "name": "Engagement Manager"
    },
    "time_blocks": [],
    "created_at": "2016-04-14T15:27:35.692-04:00",
    "updated_at": "2016-04-14T15:29:13.545-04:00"
  }
}

Person Destroy

• Route: /people/id
• Method: DELETE
• Expected Response:

{
  "people": {
    "id": 1062390230,
    "link": "https://api.getbric.com/v1/people/1062390230",
    "first_name": "Michael",
    "last_name": "Jordan",
    "email": "[email protected]",
    "billing_rate": "200.0",
    "billable_hours": 40,
    "cost": "125.0",
    "previous_costs": {
      "2016-04-14": "100.0"
    },
    "person_role": {
      "id": 374648174,
      "link": "https://api.getbric.com/v1/person_roles/374648174",
      "name": "Engagement Manager"
    },
    "time_blocks": [],
    "created_at": "2016-04-14T15:27:35.692-04:00",
    "updated_at": "2016-04-14T15:29:13.545-04:00"
  }
}