Procore.Api.WorkforceManagementWorkforcePlanningTimeOff (procore_sdk v0.3.0)

API calls for all endpoints tagged WorkforceManagementWorkforcePlanningTimeOff.

Summary

Functions

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_get(connection, procore_company_id, company_id, person_id, timezone, opts \\ [])

Get All Time Off for a Single Person Retrieves all Time Off entries for a specified Person within a company.

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_post(connection, procore_company_id, company_id, person_id, opts \\ [])

Create Time Off for a Person Creates a new Time Off entry for a specified Person within a given company.

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_delete(connection, procore_company_id, company_id, person_id, time_off_id, opts \\ [])

Delete a Time Off Record Deletes a Time Off record for a specified Person within a given company. The ID of the deleted record is returned upon successful deletion.

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_get(connection, procore_company_id, company_id, person_id, time_off_id, opts \\ [])

Get Single Time Off Record Retrieves a specific Time Off record by its ID.

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_patch(connection, procore_company_id, company_id, person_id, time_off_id, opts \\ [])

Update a Time Off Record Updates an existing Time Off record for a specified Person within a given company. Only specified properties in the request body will be updated.

Functions

Link to this function

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_get(connection, procore_company_id, company_id, person_id, timezone, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffGet200Response.t()}
  | {:error, Tesla.Env.t()}

Get All Time Off for a Single Person Retrieves all Time Off entries for a specified Person within a company.

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. NOTE - this is a Laborchart company ID
  • person_id (integer()): Unique identifier for the person
  • timezone (String.t): The timezone in which to order time off entries.
  • opts (keyword): Optional parameters
    • :limit (integer()): The number of time off records to be returned in a single request. Default is 40.
    • :start_after (String.t): Time off ID used for pagination.

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_post(connection, procore_company_id, company_id, person_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_post(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffGet200ResponseDataInner.t()}
  | {:error, Tesla.Env.t()}

Create Time Off for a Person Creates a new Time Off entry for a specified Person within a given company.

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. NOTE - this is a Laborchart company ID
  • person_id (integer()): Unique identifier for the person
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffPostRequest):

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_delete(connection, procore_company_id, company_id, person_id, time_off_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_delete(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffTimeOffIdDelete200Response.t()}
  | {:error, Tesla.Env.t()}

Delete a Time Off Record Deletes a Time Off record for a specified Person within a given company. The ID of the deleted record is returned upon successful deletion.

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. NOTE - this is a Laborchart company ID
  • person_id (integer()): Unique identifier for the person
  • time_off_id (String.t): The UUID of the Time Off record.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_get(connection, procore_company_id, company_id, person_id, time_off_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_get(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffGet200ResponseDataInner.t()}
  | {:error, Tesla.Env.t()}

Get Single Time Off Record Retrieves a specific Time Off record by its ID.

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. NOTE - this is a Laborchart company ID
  • person_id (integer()): Unique identifier for the person
  • time_off_id (String.t): The UUID of the Time Off record.
  • opts (keyword): Optional parameters

Returns

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

rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_patch(connection, procore_company_id, company_id, person_id, time_off_id, opts \\ [])

@spec rest_v10_workforce_planning_v2_companies_company_id_people_person_id_time_off_time_off_id_patch(
  Tesla.Env.client(),
  integer(),
  integer(),
  integer(),
  String.t(),
  keyword()
) ::
  {:ok,
   Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdGroupsGroupIdReportsLookAheadGet400Response.t()}
  | {:ok,
     Procore.Model.RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffGet200ResponseDataInner.t()}
  | {:error, Tesla.Env.t()}

Update a Time Off Record Updates an existing Time Off record for a specified Person within a given company. Only specified properties in the request body will be updated.

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. NOTE - this is a Laborchart company ID
  • person_id (integer()): Unique identifier for the person
  • time_off_id (String.t): The UUID of the Time Off record.
  • opts (keyword): Optional parameters
    • :body (RestV10WorkforcePlanningV2CompaniesCompanyIdPeoplePersonIdTimeOffTimeOffIdPatchRequest):

Returns

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