Infoplus\LocationFootprintApi

All URIs are relative to https://kingsrook.localhost-testsubdomain1.infopluswms.com:8443/infoplus-wms/api

Method	HTTP request	Description
addLocationFootprint	POST /beta/locationFootprint	Create a locationFootprint
addLocationFootprintAudit	PUT /beta/locationFootprint/{locationFootprintId}/audit/{locationFootprintAudit}	Add new audit for a locationFootprint
addLocationFootprintFile	POST /beta/locationFootprint/{locationFootprintId}/file/{fileName}	Attach a file to a locationFootprint
addLocationFootprintFileByURL	POST /beta/locationFootprint/{locationFootprintId}/file	Attach a file to a locationFootprint by URL.
addLocationFootprintTag	PUT /beta/locationFootprint/{locationFootprintId}/tag/{locationFootprintTag}	Add new tags for a locationFootprint.
deleteLocationFootprint	DELETE /beta/locationFootprint/{locationFootprintId}	Delete a locationFootprint
deleteLocationFootprintFile	DELETE /beta/locationFootprint/{locationFootprintId}/file/{fileId}	Delete a file for a locationFootprint.
deleteLocationFootprintTag	DELETE /beta/locationFootprint/{locationFootprintId}/tag/{locationFootprintTag}	Delete a tag for a locationFootprint.
getDuplicateLocationFootprintById	GET /beta/locationFootprint/duplicate/{locationFootprintId}	Get a duplicated a locationFootprint by id
getLocationFootprintByFilter	GET /beta/locationFootprint/search	Search locationFootprints by filter
getLocationFootprintById	GET /beta/locationFootprint/{locationFootprintId}	Get a locationFootprint by id
getLocationFootprintFiles	GET /beta/locationFootprint/{locationFootprintId}/file	Get the files for a locationFootprint.
getLocationFootprintTags	GET /beta/locationFootprint/{locationFootprintId}/tag	Get the tags for a locationFootprint.
updateLocationFootprint	PUT /beta/locationFootprint	Update a locationFootprint
updateLocationFootprintCustomFields	PUT /beta/locationFootprint/customFields	Update a locationFootprint custom fields

addLocationFootprint

\Infoplus\Infoplus\Model\LocationFootprint addLocationFootprint($body)

Create a locationFootprint

Inserts a new locationFootprint using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Infoplus\Infoplus\Model\LocationFootprint(); // \Infoplus\Infoplus\Model\LocationFootprint | LocationFootprint to be inserted.

try {
    $result = $apiInstance->addLocationFootprint($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->addLocationFootprint: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\LocationFootprint	LocationFootprint to be inserted.

Return type

\Infoplus\Infoplus\Model\LocationFootprint

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addLocationFootprintAudit

addLocationFootprintAudit($location_footprint_id, $location_footprint_audit)

Add new audit for a locationFootprint

Adds an audit to an existing locationFootprint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to add an audit to
$location_footprint_audit = "location_footprint_audit_example"; // string | The audit to add

try {
    $apiInstance->addLocationFootprintAudit($location_footprint_id, $location_footprint_audit);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->addLocationFootprintAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to add an audit to
location_footprint_audit	string	The audit to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addLocationFootprintFile

addLocationFootprintFile($location_footprint_id, $file_name)

Attach a file to a locationFootprint

Adds a file to an existing locationFootprint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to add a file to
$file_name = "file_name_example"; // string | Name of file

try {
    $apiInstance->addLocationFootprintFile($location_footprint_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->addLocationFootprintFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to add a file to
file_name	string	Name of file

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addLocationFootprintFileByURL

addLocationFootprintFileByURL($body, $location_footprint_id)

Attach a file to a locationFootprint by URL.

Adds a file to an existing locationFootprint by URL.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Infoplus\Infoplus\Model\RecordFile(); // \Infoplus\Infoplus\Model\RecordFile | The url and optionly fileName to be used.
$location_footprint_id = 56; // int | Id of the locationFootprint to add an file to

try {
    $apiInstance->addLocationFootprintFileByURL($body, $location_footprint_id);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->addLocationFootprintFileByURL: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\RecordFile	The url and optionly fileName to be used.
location_footprint_id	int	Id of the locationFootprint to add an file to

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addLocationFootprintTag

addLocationFootprintTag($location_footprint_id, $location_footprint_tag)

Add new tags for a locationFootprint.

Adds a tag to an existing locationFootprint.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to add a tag to
$location_footprint_tag = "location_footprint_tag_example"; // string | The tag to add

try {
    $apiInstance->addLocationFootprintTag($location_footprint_id, $location_footprint_tag);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->addLocationFootprintTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to add a tag to
location_footprint_tag	string	The tag to add

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteLocationFootprint

deleteLocationFootprint($location_footprint_id)

Delete a locationFootprint

Deletes the locationFootprint identified by the specified id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to be deleted.

try {
    $apiInstance->deleteLocationFootprint($location_footprint_id);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->deleteLocationFootprint: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to be deleted.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteLocationFootprintFile

deleteLocationFootprintFile($location_footprint_id, $file_id)

Delete a file for a locationFootprint.

Deletes an existing locationFootprint file using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to remove file from
$file_id = 56; // int | Id of the file to delete

try {
    $apiInstance->deleteLocationFootprintFile($location_footprint_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->deleteLocationFootprintFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to remove file from
file_id	int	Id of the file to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteLocationFootprintTag

deleteLocationFootprintTag($location_footprint_id, $location_footprint_tag)

Delete a tag for a locationFootprint.

Deletes an existing locationFootprint tag using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to remove tag from
$location_footprint_tag = "location_footprint_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteLocationFootprintTag($location_footprint_id, $location_footprint_tag);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->deleteLocationFootprintTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to remove tag from
location_footprint_tag	string	The tag to delete

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDuplicateLocationFootprintById

\Infoplus\Infoplus\Model\LocationFootprint getDuplicateLocationFootprintById($location_footprint_id)

Get a duplicated a locationFootprint by id

Returns a duplicated locationFootprint identified by the specified id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to be duplicated.

try {
    $result = $apiInstance->getDuplicateLocationFootprintById($location_footprint_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->getDuplicateLocationFootprintById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to be duplicated.

Return type

\Infoplus\Infoplus\Model\LocationFootprint

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocationFootprintByFilter

\Infoplus\Infoplus\Model\LocationFootprint[] getLocationFootprintByFilter($filter, $page, $limit, $sort)

Search locationFootprints by filter

Returns the list of locationFootprints that match the given filter.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$filter = "filter_example"; // string | Query string, used to filter results.
$page = 56; // int | Result page number.  Defaults to 1.
$limit = 56; // int | Maximum results per page.  Defaults to 20.  Max allowed value is 250.
$sort = "sort_example"; // string | Sort results by specified field.

try {
    $result = $apiInstance->getLocationFootprintByFilter($filter, $page, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->getLocationFootprintByFilter: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
filter	string	Query string, used to filter results.	[optional]
page	int	Result page number. Defaults to 1.	[optional]
limit	int	Maximum results per page. Defaults to 20. Max allowed value is 250.	[optional]
sort	string	Sort results by specified field.	[optional]

Return type

\Infoplus\Infoplus\Model\LocationFootprint[]

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocationFootprintById

\Infoplus\Infoplus\Model\LocationFootprint getLocationFootprintById($location_footprint_id)

Get a locationFootprint by id

Returns the locationFootprint identified by the specified id.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to be returned.

try {
    $result = $apiInstance->getLocationFootprintById($location_footprint_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->getLocationFootprintById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to be returned.

Return type

\Infoplus\Infoplus\Model\LocationFootprint

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocationFootprintFiles

getLocationFootprintFiles($location_footprint_id)

Get the files for a locationFootprint.

Get all existing locationFootprint files.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to get files for

try {
    $apiInstance->getLocationFootprintFiles($location_footprint_id);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->getLocationFootprintFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to get files for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLocationFootprintTags

getLocationFootprintTags($location_footprint_id)

Get the tags for a locationFootprint.

Get all existing locationFootprint tags.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$location_footprint_id = 56; // int | Id of the locationFootprint to get tags for

try {
    $apiInstance->getLocationFootprintTags($location_footprint_id);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->getLocationFootprintTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
location_footprint_id	int	Id of the locationFootprint to get tags for

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateLocationFootprint

updateLocationFootprint($body)

Update a locationFootprint

Updates an existing locationFootprint using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Infoplus\Infoplus\Model\LocationFootprint(); // \Infoplus\Infoplus\Model\LocationFootprint | LocationFootprint to be updated.

try {
    $apiInstance->updateLocationFootprint($body);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->updateLocationFootprint: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\LocationFootprint	LocationFootprint to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateLocationFootprintCustomFields

updateLocationFootprintCustomFields($body)

Update a locationFootprint custom fields

Updates an existing locationFootprint custom fields using the specified data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
$config = Infoplus\Configuration::getDefaultConfiguration()->setApiKey('API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Infoplus\Configuration::getDefaultConfiguration()->setApiKeyPrefix('API-Key', 'Bearer');

$apiInstance = new Infoplus\Api\LocationFootprintApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \Infoplus\Infoplus\Model\LocationFootprint(); // \Infoplus\Infoplus\Model\LocationFootprint | LocationFootprint to be updated.

try {
    $apiInstance->updateLocationFootprintCustomFields($body);
} catch (Exception $e) {
    echo 'Exception when calling LocationFootprintApi->updateLocationFootprintCustomFields: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	\Infoplus\Infoplus\Model\LocationFootprint	LocationFootprint to be updated.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

LocationFootprintApi.md

Latest commit

History

LocationFootprintApi.md

File metadata and controls

Infoplus\LocationFootprintApi

addLocationFootprint

Example

Parameters

Return type

Authorization

HTTP request headers

addLocationFootprintAudit

Example

Parameters

Return type

Authorization

HTTP request headers

addLocationFootprintFile

Example

Parameters

Return type

Authorization

HTTP request headers

addLocationFootprintFileByURL

Example

Parameters

Return type

Authorization

HTTP request headers

addLocationFootprintTag

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLocationFootprint

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLocationFootprintFile

Example

Parameters

Return type

Authorization

HTTP request headers

deleteLocationFootprintTag

Example

Parameters

Return type

Authorization

HTTP request headers

getDuplicateLocationFootprintById

Example

Parameters

Return type

Authorization

HTTP request headers

getLocationFootprintByFilter

Example

Parameters

Return type

Authorization

HTTP request headers

getLocationFootprintById

Example

Parameters

Return type

Authorization

HTTP request headers

getLocationFootprintFiles

Example

Parameters

Return type

Authorization

HTTP request headers

getLocationFootprintTags