Procore.Api.CoreProjectDepartments (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectDepartments.

Summary

Functions

rest_v10_departments_get(connection, procore_company_id, company_id, opts \\ [])

List Departments Return a list of Departments.

rest_v10_departments_id_delete(connection, procore_company_id, id, company_id, opts \\ [])

Delete Department Delete a Department.

rest_v10_departments_id_get(connection, procore_company_id, id, company_id, opts \\ [])

Show Department Return details for a Department.

rest_v10_departments_id_patch(connection, procore_company_id, id, department_body, opts \\ [])

Update Department Update a Department.

rest_v10_departments_post(connection, procore_company_id, department_body, opts \\ [])

Create Department Create a new Department.

Functions

Link to this function

rest_v10_departments_get(connection, procore_company_id, company_id, opts \\ [])

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

List Departments Return a list of Departments.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_departments_id_delete(connection, procore_company_id, id, company_id, opts \\ [])

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

Delete Department Delete a Department.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Department ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_departments_id_get(connection, procore_company_id, id, company_id, opts \\ [])

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

Show Department Return details for a Department.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Department ID
  • company_id (integer()): Unique identifier for the company.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_departments_id_patch(connection, procore_company_id, id, department_body, opts \\ [])

@spec rest_v10_departments_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  Procore.Model.DepartmentBody.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.Department.t()}
  | {:error, Tesla.Env.t()}

Update Department Update a Department.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): Department ID
  • department_body (DepartmentBody):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_departments_post(connection, procore_company_id, department_body, opts \\ [])

@spec rest_v10_departments_post(
  Tesla.Env.client(),
  integer(),
  Procore.Model.DepartmentBody.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()}
  | {:ok, Procore.Model.Department.t()}
  | {:error, Tesla.Env.t()}

Create Department Create a new Department.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • department_body (DepartmentBody):
  • opts (keyword): Optional parameters

Returns

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