Skip to content

Latest commit

 

History

History
855 lines (611 loc) · 27.8 KB

BuildingApi.md

File metadata and controls

855 lines (611 loc) · 27.8 KB

Infoplus\BuildingApi

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

Method HTTP request Description
addBuilding POST /beta/building Create a building
addBuildingAudit PUT /beta/building/{buildingId}/audit/{buildingAudit} Add new audit for a building
addBuildingFile POST /beta/building/{buildingId}/file/{fileName} Attach a file to a building
addBuildingFileByURL POST /beta/building/{buildingId}/file Attach a file to a building by URL.
addBuildingTag PUT /beta/building/{buildingId}/tag/{buildingTag} Add new tags for a building.
deleteBuilding DELETE /beta/building/{buildingId} Delete a building
deleteBuildingFile DELETE /beta/building/{buildingId}/file/{fileId} Delete a file for a building.
deleteBuildingTag DELETE /beta/building/{buildingId}/tag/{buildingTag} Delete a tag for a building.
getBuildingByFilter GET /beta/building/search Search buildings by filter
getBuildingById GET /beta/building/{buildingId} Get a building by id
getBuildingFiles GET /beta/building/{buildingId}/file Get the files for a building.
getBuildingTags GET /beta/building/{buildingId}/tag Get the tags for a building.
getDuplicateBuildingById GET /beta/building/duplicate/{buildingId} Get a duplicated a building by id
updateBuilding PUT /beta/building Update a building
updateBuildingCustomFields PUT /beta/building/customFields Update a building custom fields

addBuilding

\Infoplus\Infoplus\Model\Building addBuilding($body)

Create a building

Inserts a new building 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\BuildingApi(
    // 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\Building(); // \Infoplus\Infoplus\Model\Building | Building to be inserted.

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

Parameters

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

Return type

\Infoplus\Infoplus\Model\Building

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]

addBuildingAudit

addBuildingAudit($building_id, $building_audit)

Add new audit for a building

Adds an audit to an existing building.

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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to add an audit to
$building_audit = "building_audit_example"; // string | The audit to add

try {
    $apiInstance->addBuildingAudit($building_id, $building_audit);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->addBuildingAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building to add an audit to
building_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]

addBuildingFile

addBuildingFile($building_id, $file_name)

Attach a file to a building

Adds a file to an existing building.

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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to add a file to
$file_name = "file_name_example"; // string | Name of file

try {
    $apiInstance->addBuildingFile($building_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->addBuildingFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building 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]

addBuildingFileByURL

addBuildingFileByURL($body, $building_id)

Attach a file to a building by URL.

Adds a file to an existing building 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\BuildingApi(
    // 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.
$building_id = 56; // int | Id of the building to add an file to

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

Parameters

Name Type Description Notes
body \Infoplus\Infoplus\Model\RecordFile The url and optionly fileName to be used.
building_id int Id of the building 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]

addBuildingTag

addBuildingTag($building_id, $building_tag)

Add new tags for a building.

Adds a tag to an existing building.

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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to add a tag to
$building_tag = "building_tag_example"; // string | The tag to add

try {
    $apiInstance->addBuildingTag($building_id, $building_tag);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->addBuildingTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building to add a tag to
building_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]

deleteBuilding

deleteBuilding($building_id)

Delete a building

Deletes the building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to be deleted.

try {
    $apiInstance->deleteBuilding($building_id);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->deleteBuilding: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building 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]

deleteBuildingFile

deleteBuildingFile($building_id, $file_id)

Delete a file for a building.

Deletes an existing building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to remove file from
$file_id = 56; // int | Id of the file to delete

try {
    $apiInstance->deleteBuildingFile($building_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->deleteBuildingFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building 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]

deleteBuildingTag

deleteBuildingTag($building_id, $building_tag)

Delete a tag for a building.

Deletes an existing building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to remove tag from
$building_tag = "building_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteBuildingTag($building_id, $building_tag);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->deleteBuildingTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building to remove tag from
building_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]

getBuildingByFilter

\Infoplus\Infoplus\Model\Building[] getBuildingByFilter($filter, $page, $limit, $sort)

Search buildings by filter

Returns the list of buildings 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\BuildingApi(
    // 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->getBuildingByFilter($filter, $page, $limit, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->getBuildingByFilter: ', $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\Building[]

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]

getBuildingById

\Infoplus\Infoplus\Model\Building getBuildingById($building_id)

Get a building by id

Returns the building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to be returned.

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

Parameters

Name Type Description Notes
building_id int Id of the building to be returned.

Return type

\Infoplus\Infoplus\Model\Building

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]

getBuildingFiles

getBuildingFiles($building_id)

Get the files for a building.

Get all existing building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to get files for

try {
    $apiInstance->getBuildingFiles($building_id);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->getBuildingFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building 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]

getBuildingTags

getBuildingTags($building_id)

Get the tags for a building.

Get all existing building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to get tags for

try {
    $apiInstance->getBuildingTags($building_id);
} catch (Exception $e) {
    echo 'Exception when calling BuildingApi->getBuildingTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
building_id int Id of the building 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]

getDuplicateBuildingById

\Infoplus\Infoplus\Model\Building getDuplicateBuildingById($building_id)

Get a duplicated a building by id

Returns a duplicated building 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\BuildingApi(
    // 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
);
$building_id = 56; // int | Id of the building to be duplicated.

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

Parameters

Name Type Description Notes
building_id int Id of the building to be duplicated.

Return type

\Infoplus\Infoplus\Model\Building

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]

updateBuilding

updateBuilding($body)

Update a building

Updates an existing building 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\BuildingApi(
    // 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\Building(); // \Infoplus\Infoplus\Model\Building | Building to be updated.

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

Parameters

Name Type Description Notes
body \Infoplus\Infoplus\Model\Building Building 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]

updateBuildingCustomFields

updateBuildingCustomFields($body)

Update a building custom fields

Updates an existing building 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\BuildingApi(
    // 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\Building(); // \Infoplus\Infoplus\Model\Building | Building to be updated.

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

Parameters

Name Type Description Notes
body \Infoplus\Infoplus\Model\Building Building 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]