Procore.Api.CoreCompanyCompanyOffices (procore_sdk v0.3.0)
API calls for all endpoints tagged CoreCompanyCompanyOffices.
Summary
Functions
List company offices Returns a collection of Offices associated to a Company
Delete a company office Deletes an Office associated to a Company.
Show company office Returns information about an Office associated to a Company.
Update company office
Updates an Office associated to a Company. #### Uploading logo To upload an office logo you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with office[logo] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.
Create company office
Creates an Office associated to a Company. #### Uploading logo To upload an office logo you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with office[logo] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.
Functions
rest_v10_offices_get(connection, procore_company_id, company_id, opts \\ [])
@spec rest_v10_offices_get(Tesla.Env.client(), integer(), integer(), keyword()) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, [Procore.Model.Office1.t()]} | {:error, Tesla.Env.t()}
List company offices Returns a collection of Offices associated to a Company
Parameters
connection(Procore.Connection): Connection to serverprocore_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:view(String.t): The view determines which fields are returned. 'normal' returns id, address, city, country_code, division, fax, logo, name, phone, state_code, and zip. 'extended' additionally returns main_office.
Returns
{:ok, [%Office1{}, ...]}on success{:error, Tesla.Env.t}on failure
rest_v10_offices_id_delete(connection, procore_company_id, id, company_id, opts \\ [])
@spec rest_v10_offices_id_delete( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, nil} | {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:error, Tesla.Env.t()}
Delete a company office Deletes an Office associated to a Company.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.id(integer()): ID of the officecompany_id(integer()): Unique identifier for the company.opts(keyword): Optional parameters
Returns
{:ok, nil}on success{:error, Tesla.Env.t}on failure
rest_v10_offices_id_get(connection, procore_company_id, id, company_id, opts \\ [])
@spec rest_v10_offices_id_get( Tesla.Env.client(), integer(), integer(), integer(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Office1.t()} | {:error, Tesla.Env.t()}
Show company office Returns information about an Office associated to a Company.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.id(integer()): ID of the officecompany_id(integer()): Unique identifier for the company.opts(keyword): Optional parameters:view(String.t): Response schema to use
Returns
{:ok, Procore.Model.Office1.t}on success{:error, Tesla.Env.t}on failure
rest_v10_offices_id_patch(connection, procore_company_id, id, body113, opts \\ [])
@spec rest_v10_offices_id_patch( Tesla.Env.client(), integer(), integer(), Procore.Model.Body113.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Office1.t()} | {:error, Tesla.Env.t()}
Update company office
Updates an Office associated to a Company. #### Uploading logo To upload an office logo you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with office[logo] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.id(integer()): ID of the officebody113(Body113):opts(keyword): Optional parameters
Returns
{:ok, Procore.Model.Office1.t}on success{:error, Tesla.Env.t}on failure
rest_v10_offices_post(connection, procore_company_id, body113, opts \\ [])
@spec rest_v10_offices_post( Tesla.Env.client(), integer(), Procore.Model.Body113.t(), keyword() ) :: {:ok, Procore.Model.RestV10CompaniesCompanyIdWorkflowPermanentLogsGet401Response.t()} | {:ok, Procore.Model.Office1.t()} | {:error, Tesla.Env.t()}
Create company office
Creates an Office associated to a Company. #### Uploading logo To upload an office logo you must upload whole payload as multipart/form-data content-type and specify each parameter as form-data together with office[logo] as file. #### Country and State codes The country_code and state_code parameter values must conform to the ISO-3166 Alpha-2 specification. See Working with Country Codes for additional information.
Parameters
connection(Procore.Connection): Connection to serverprocore_company_id(integer()): Unique company identifier associated with the Procore User Account.body113(Body113):opts(keyword): Optional parameters
Returns
{:ok, Procore.Model.Office1.t}on success{:error, Tesla.Env.t}on failure