Procore.Api.CoreProjectDirectoryProjectPeople (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectDirectoryProjectPeople.

Summary

Functions

rest_v10_projects_project_id_people_get(connection, procore_company_id, project_id, opts \\ [])

List Project People Return a list of People associated with a Project. Includes users in the directory and reference users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

rest_v10_projects_project_id_people_id_patch(connection, procore_company_id, project_id, id, project_person_body, opts \\ [])

Update project person Update the specified Project User.

rest_v10_projects_project_id_people_post(connection, procore_company_id, project_id, project_person_body, opts \\ [])

Create project Person Create a new Person in the specified Project. This endpoint can currently only create reference users. It cannot create a user who can login.

Functions

Link to this function

rest_v10_projects_project_id_people_get(connection, procore_company_id, project_id, opts \\ [])

@spec rest_v10_projects_project_id_people_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, [Procore.Model.RestV10ProjectsProjectIdPeopleGet200ResponseInner.t()]}
  | {:error, Tesla.Env.t()}

List Project People Return a list of People associated with a Project. Includes users in the directory and reference users. See Filtering on List Actions for information on using the filtering capabilities provided by this endpoint.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • opts (keyword): Optional parameters
    • :view (String.t): Specifies which view of the resource to return (which attributes should be present in the response). Users without read permissions to Directory are limited to the normal and extended views. If a valid view is not provided, it will default to normal.
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[is_employee]" (boolean()): If true, returns item(s) where is_employee value is true.
    • :"filters[reference_users_only]" (boolean()): If true, returns only people who are reference users.
    • :"filters[without_reference_users]" (boolean()): If true, returns only people who are not reference users.
    • :"filters[include_company_people]" (boolean()): If true, returns people in the Company not just the Project. This option only works if the user has permission to create people in the project directory or permission to read from the company directory.
    • :"filters[search]" (String.t): Returns item(s) matching the specified search query string.
    • :"filters[connected]" (boolean()): If true, returns only people who are connected users. If false, returns only people who are not connected users.
    • :"filters[vendor_id]" ([integer()]): Return item(s) with the specified Vendor IDs.
    • :"filters[job_title]" (String.t): Returns only people who have the specified job title.
    • :"filters[country_code]" (String.t): Returns only people who have the specified country code.
    • :"filters[state_code]" (String.t): Returns only people who have the specified state code.
    • :"filters[trade_id]" ([integer()]): Array of Trade IDs. Returns item(s) with the specified Trade IDs.
    • :"filters[permission_template_id]" ([integer()]): Array of Permission Template IDs. Returns item(s) with the specified Permission Template IDs.
    • :sort (String.t): Return items with the specified sort

Returns

  • {:ok, [%RestV10ProjectsProjectIdPeopleGet200ResponseInner{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_people_id_patch(connection, procore_company_id, project_id, id, project_person_body, opts \\ [])

@spec rest_v10_projects_project_id_people_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  Procore.Model.ProjectPersonBody.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.ProjectPerson1.t()}
  | {:error, Tesla.Env.t()}

Update project person Update the specified Project User.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): ID of the project
  • id (integer()): ID of the person
  • project_person_body (ProjectPersonBody):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.ProjectPerson1.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

rest_v10_projects_project_id_people_post(connection, procore_company_id, project_id, project_person_body, opts \\ [])

@spec rest_v10_projects_project_id_people_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.ProjectPersonBody.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.ProjectPerson1.t()}
  | {:error, Tesla.Env.t()}

Create project Person Create a new Person in the specified Project. This endpoint can currently only create reference users. It cannot create a user who can login.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • project_id (integer()): Unique identifier for the project.
  • project_person_body (ProjectPersonBody):
  • opts (keyword): Optional parameters

Returns

  • {:ok, Procore.Model.ProjectPerson1.t} on success
  • {:error, Tesla.Env.t} on failure