Skip to content

Latest commit

 

History

History
855 lines (611 loc) · 26.3 KB

AsnApi.md

File metadata and controls

855 lines (611 loc) · 26.3 KB

Infoplus\AsnApi

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

Method HTTP request Description
addAsn POST /beta/asn Create an asn
addAsnAudit PUT /beta/asn/{asnId}/audit/{asnAudit} Add new audit for an asn
addAsnFile POST /beta/asn/{asnId}/file/{fileName} Attach a file to an asn
addAsnFileByURL POST /beta/asn/{asnId}/file Attach a file to an asn by URL.
addAsnTag PUT /beta/asn/{asnId}/tag/{asnTag} Add new tags for an asn.
deleteAsn DELETE /beta/asn/{asnId} Delete an asn
deleteAsnFile DELETE /beta/asn/{asnId}/file/{fileId} Delete a file for an asn.
deleteAsnTag DELETE /beta/asn/{asnId}/tag/{asnTag} Delete a tag for an asn.
getAsnByFilter GET /beta/asn/search Search asns by filter
getAsnById GET /beta/asn/{asnId} Get an asn by id
getAsnFiles GET /beta/asn/{asnId}/file Get the files for an asn.
getAsnTags GET /beta/asn/{asnId}/tag Get the tags for an asn.
getDuplicateAsnById GET /beta/asn/duplicate/{asnId} Get a duplicated an asn by id
updateAsn PUT /beta/asn Update an asn
updateAsnCustomFields PUT /beta/asn/customFields Update an asn custom fields

addAsn

\Infoplus\Infoplus\Model\Asn addAsn($body)

Create an asn

Inserts a new asn 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\AsnApi(
    // 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\Asn(); // \Infoplus\Infoplus\Model\Asn | Asn to be inserted.

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

Parameters

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

Return type

\Infoplus\Infoplus\Model\Asn

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]

addAsnAudit

addAsnAudit($asn_id, $asn_audit)

Add new audit for an asn

Adds an audit to an existing asn.

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\AsnApi(
    // 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
);
$asn_id = 56; // int | Id of the asn to add an audit to
$asn_audit = "asn_audit_example"; // string | The audit to add

try {
    $apiInstance->addAsnAudit($asn_id, $asn_audit);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->addAsnAudit: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
asn_id int Id of the asn to add an audit to
asn_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]

addAsnFile

addAsnFile($asn_id, $file_name)

Attach a file to an asn

Adds a file to an existing asn.

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

try {
    $apiInstance->addAsnFile($asn_id, $file_name);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->addAsnFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

addAsnFileByURL

addAsnFileByURL($body, $asn_id)

Attach a file to an asn by URL.

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

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

Parameters

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

addAsnTag

addAsnTag($asn_id, $asn_tag)

Add new tags for an asn.

Adds a tag to an existing asn.

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\AsnApi(
    // 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
);
$asn_id = 56; // int | Id of the asn to add a tag to
$asn_tag = "asn_tag_example"; // string | The tag to add

try {
    $apiInstance->addAsnTag($asn_id, $asn_tag);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->addAsnTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
asn_id int Id of the asn to add a tag to
asn_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]

deleteAsn

deleteAsn($asn_id)

Delete an asn

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

try {
    $apiInstance->deleteAsn($asn_id);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->deleteAsn: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteAsnFile

deleteAsnFile($asn_id, $file_id)

Delete a file for an asn.

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

try {
    $apiInstance->deleteAsnFile($asn_id, $file_id);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->deleteAsnFile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

deleteAsnTag

deleteAsnTag($asn_id, $asn_tag)

Delete a tag for an asn.

Deletes an existing asn 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\AsnApi(
    // 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
);
$asn_id = 56; // int | Id of the asn to remove tag from
$asn_tag = "asn_tag_example"; // string | The tag to delete

try {
    $apiInstance->deleteAsnTag($asn_id, $asn_tag);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->deleteAsnTag: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
asn_id int Id of the asn to remove tag from
asn_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]

getAsnByFilter

\Infoplus\Infoplus\Model\Asn[] getAsnByFilter($filter, $page, $limit, $sort)

Search asns by filter

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

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]

getAsnById

\Infoplus\Infoplus\Model\Asn getAsnById($asn_id)

Get an asn by id

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

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

Parameters

Name Type Description Notes
asn_id int Id of the asn to be returned.

Return type

\Infoplus\Infoplus\Model\Asn

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]

getAsnFiles

getAsnFiles($asn_id)

Get the files for an asn.

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

try {
    $apiInstance->getAsnFiles($asn_id);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->getAsnFiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getAsnTags

getAsnTags($asn_id)

Get the tags for an asn.

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

try {
    $apiInstance->getAsnTags($asn_id);
} catch (Exception $e) {
    echo 'Exception when calling AsnApi->getAsnTags: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

getDuplicateAsnById

\Infoplus\Infoplus\Model\Asn getDuplicateAsnById($asn_id)

Get a duplicated an asn by id

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

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

Parameters

Name Type Description Notes
asn_id int Id of the asn to be duplicated.

Return type

\Infoplus\Infoplus\Model\Asn

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]

updateAsn

updateAsn($body)

Update an asn

Updates an existing asn 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\AsnApi(
    // 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\Asn(); // \Infoplus\Infoplus\Model\Asn | Asn to be updated.

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

Parameters

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

updateAsnCustomFields

updateAsnCustomFields($body)

Update an asn custom fields

Updates an existing asn 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\AsnApi(
    // 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\Asn(); // \Infoplus\Infoplus\Model\Asn | Asn to be updated.

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

Parameters

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