Procore.Api.CoreProjectLocations (procore_sdk v0.3.0)

API calls for all endpoints tagged CoreProjectLocations.

Summary

Functions

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

List locations Return a list of Locations associated with a Project.

rest_v10_locations_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

Delete location Delete the specified Location.

rest_v10_locations_id_get(connection, procore_company_id, id, project_id, opts \\ [])

Show location Show detail on the specified Location.

rest_v10_locations_id_patch(connection, procore_company_id, id, body71, opts \\ [])

Update Location Update the specified Location.

rest_v10_locations_post(connection, procore_company_id, body70, opts \\ [])

Create location Create a new Location for the specified Project.

rest_v10_projects_project_id_locations_find_or_create_by_path_post(connection, procore_company_id, project_id, body73, opts \\ [])

Find or Create Location(s) by Path Retrieves a Location corresponding to the provided path, or creates Location(s) representing the path.

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

List Project Locations Return a list of Locations associated with a Project.

rest_v10_projects_project_id_locations_location_id_delete(connection, procore_company_id, project_id, location_id, opts \\ [])

Delete Project Location Deletes a specified Location.

rest_v10_projects_project_id_locations_location_id_get(connection, procore_company_id, project_id, location_id, opts \\ [])

Show Project Location Retrieves a Location for a specified project.

rest_v10_projects_project_id_locations_location_id_patch(connection, procore_company_id, project_id, location_id, body72, opts \\ [])

Update Project Location Update the specified Location.

rest_v10_projects_project_id_locations_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_locations_post_request, opts \\ [])

Create Location (Admin) Create a new Location for the specified Project. Note: This endpoint requires Project Admin permissions and does not respect the "Disable Dynamic Location Creation" project configuration.

rest_v11_projects_project_id_locations_location_id_delete(connection, procore_company_id, project_id, location_id, opts \\ [])

Delete Project Location Deletes a specified Location.

Functions

Link to this function

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

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

List locations Return a list of Locations associated with a Project.

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
    • :page (integer()): Page
    • :per_page (integer()): Elements per page

Returns

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

rest_v10_locations_id_delete(connection, procore_company_id, id, project_id, opts \\ [])

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

Delete location Delete the specified Location.

Parameters

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

Returns

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

rest_v10_locations_id_get(connection, procore_company_id, id, project_id, opts \\ [])

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

Show location Show detail on the specified Location.

Parameters

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

Returns

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

rest_v10_locations_id_patch(connection, procore_company_id, id, body71, opts \\ [])

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

Update Location Update the specified Location.

Parameters

  • connection (Procore.Connection): Connection to server
  • procore_company_id (integer()): Unique company identifier associated with the Procore User Account.
  • id (integer()): ID of the location
  • body71 (Body71):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_locations_post(connection, procore_company_id, body70, opts \\ [])

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

Create location Create a new Location for the specified Project.

Parameters

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

Returns

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

rest_v10_projects_project_id_locations_find_or_create_by_path_post(connection, procore_company_id, project_id, body73, opts \\ [])

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

Find or Create Location(s) by Path Retrieves a Location corresponding to the provided path, or creates Location(s) representing the path.

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.
  • body73 (Body73):
  • opts (keyword): Optional parameters

Returns

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

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

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

List Project Locations Return a list of Locations associated with a Project.

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
    • :"filters[id]" ([integer()]): Return item(s) with the specified IDs.
    • :"filters[parent_id]" (integer()): Return location(s) with the specified parent_ids.
    • :"filters[code]" ([String.t]): Return location(s) matching any of the specified codes in the search term.
    • :"filters[search]" (String.t): Returns item(s) matching the specified search query string.
    • :"filters[search_with_code]" (String.t): Return item(s) where the location code or the location name match the search term
    • :"filters[superlocations_for]" (integer()): Return superlocations (ancestors) of the specified location ids.
    • :"filters[sublocations_for]" (integer()): Return sublocations (descendants) of the specified location ids.
    • :"filters[updated_at]" (Date.t): Return item(s) last updated within the specified ISO 8601 datetime range. Formats: YYYY-MM-DD...YYYY-MM-DD - Date YYYY-MM-DDTHH:MM:SSZ...YYYY-MM-DDTHH:MM:SSZ - DateTime with UTC Offset YYYY-MM-DDTHH:MM:SS+XX:00...YYYY-MM-DDTHH:MM:SS+XX:00 - Datetime with Custom Offset
    • :sort (String.t):
    • :page (integer()): Page
    • :per_page (integer()): Elements per page
    • :"filters[depth_range]" (String.t): Return item(s) with a tree depth within the specified range. Examples: 0...1 - Parents and children 0...2 - Parents, children, and grandchildren 1...2 - Children and grandchildren

Returns

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

rest_v10_projects_project_id_locations_location_id_delete(connection, procore_company_id, project_id, location_id, opts \\ [])

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

Delete Project Location Deletes a specified Location.

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.
  • location_id (integer()): ID of the location
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_locations_location_id_get(connection, procore_company_id, project_id, location_id, opts \\ [])

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

Show Project Location Retrieves a Location for a specified project.

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.
  • location_id (integer()): ID of the location
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_locations_location_id_patch(connection, procore_company_id, project_id, location_id, body72, opts \\ [])

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

Update Project Location Update the specified Location.

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.
  • location_id (integer()): ID of the location
  • body72 (Body72):
  • opts (keyword): Optional parameters

Returns

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

rest_v10_projects_project_id_locations_post(connection, procore_company_id, project_id, rest_v10_projects_project_id_locations_post_request, opts \\ [])

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

Create Location (Admin) Create a new Location for the specified Project. Note: This endpoint requires Project Admin permissions and does not respect the "Disable Dynamic Location Creation" project configuration.

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.
  • rest_v10_projects_project_id_locations_post_request (RestV10ProjectsProjectIdLocationsPostRequest):
  • opts (keyword): Optional parameters

Returns

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

rest_v11_projects_project_id_locations_location_id_delete(connection, procore_company_id, project_id, location_id, opts \\ [])

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

Delete Project Location Deletes a specified Location.

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.
  • location_id (integer()): ID of the location
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure