Person Roles - GetBric/API GitHub Wiki

Person Roles are the job titles that People do. Examples would be Developer, Project Manager, or Designer.

Person Role Index

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

{
  "person_roles": [
    {
      "id": 374648174,
      "link": "https://api.getbric.com/v1/person_roles/374648174",
      "name": "Engagement Manager",
      "description": "Engagement Manager",
      "billing_rate": "40.0",
      "billable_hours": 35,
      "people": [
        {
          "id": 1062390222,
          "link": "https://api.getbric.com/v1/people/1062390222",
          "first_name": "Guy",
          "last_name": "Fawkes",
          "email": "[email protected]"
        },
        {
          "id": 1062390230,
          "link": "https://api.getbric.com/v1/people/1062390230",
          "first_name": "Michael",
          "last_name": "Jordan",
          "email": "[email protected]"
        },
        {
          "id": 1062390216,
          "link": "https://api.getbric.com/v1/people/1062390216",
          "first_name": "Sean",
          "last_name": "Connery",
          "email": "[email protected]"
        }
      ],
      "created_at": "2015-11-19T01:26:01.000-05:00",
      "updated_at": "2016-03-08T12:51:03.372-05:00"
    },
    {
      "id": 51848956,
      "link": "https://api.getbric.com/v1/person_roles/51848956",
      "name": "JSE",
      "description": "JavaScript Engineer",
      "billing_rate": "65.0",
      "billable_hours": 32,
      "people": [],
      "created_at": "2015-11-19T01:26:01.000-05:00",
      "updated_at": "2015-11-19T01:26:01.000-05:00"
    }
  ]
}

Person Role Create

• Route: /person_roles
• Method: POST
• Required Fields:
  • name
• Allowed Fields:
  • description
  • billing_rate (per hour)
  • billable_hours (per week)
• Expected Response:

{
  "person_roles": {
    "id": 1018350822,
    "link": "https://api.getbric.com/v1/person_roles/1018350822",
    "name": "Jr. Developer",
    "description": "Riding the Rails",
    "billing_rate": "55.0",
    "billable_hours": 35,
    "people": [],
    "created_at": "2016-04-14T15:58:02.600-04:00",
    "updated_at": "2016-04-14T16:48:46.253-04:00"
  }
}

Person Role Show

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

{
  "person_roles": {
    "id": 374648174,
    "link": "https://api.getbric.com/v1/person_roles/374648174",
    "name": "Engagement Manager",
    "description": "Engagement Manager",
    "billing_rate": "40.0",
    "billable_hours": 35,
    "people": [
      {
        "id": 1062390222,
        "link": "https://api.getbric.com/v1/people/1062390222",
        "first_name": "Guy",
        "last_name": "Fawkes",
        "email": "[email protected]"
      },
      {
        "id": 1062390230,
        "link": "https://api.getbric.com/v1/people/1062390230",
        "first_name": "Michael",
        "last_name": "Jordan",
        "email": "[email protected]"
      },
      {
        "id": 1062390216,
        "link": "https://api.getbric.com/v1/people/1062390216",
        "first_name": "Sean",
        "last_name": "Connery",
        "email": "[email protected]"
      }
    ],
    "created_at": "2015-11-19T01:26:01.000-05:00",
    "updated_at": "2016-03-08T12:51:03.372-05:00"
  }
}

Person Role Update

• Route: /person_roles/id
• Method: PATCH
• Allowed Fields:
  • name
  • description
  • billing_rate (per hour)
  • billable_hours (per week)
• Expected Response:

{
  "person_roles": {
    "id": 1018350822,
    "link": "https://api.getbric.com/v1/person_roles/1018350822",
    "name": "Jr. Developer",
    "description": "Riding the Rails",
    "billing_rate": "55.0",
    "billable_hours": 35,
    "people": [],
    "created_at": "2016-04-14T15:58:02.600-04:00",
    "updated_at": "2016-04-14T16:48:46.253-04:00"
  }
}

Person Role Destroy

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

{
  "person_roles": {
    "id": 374648174,
    "link": "https://api.getbric.com/v1/person_roles/374648174",
    "name": "Engagement Manager",
    "description": "Engagement Manager",
    "billing_rate": "40.0",
    "billable_hours": 34,
    "people": [
      {
        "id": 1062390222,
        "link": "https://api.getbric.com/v1/people/1062390222",
        "first_name": "Guy",
        "last_name": "Fawkes",
        "email": "[email protected]"
      },
      {
        "id": 1062390230,
        "link": "https://api.getbric.com/v1/people/1062390230",
        "first_name": "Michael",
        "last_name": "Jordan",
        "email": "[email protected]"
      },
      {
        "id": 1062390216,
        "link": "https://api.getbric.com/v1/people/1062390216",
        "first_name": "Sean",
        "last_name": "Connery",
        "email": "[email protected]"
      }
    ],
    "created_at": "2015-11-19T01:26:01.000-05:00",
    "updated_at": "2016-03-08T12:51:03.372-05:00"
  }
}