Skip to content

Latest commit

 

History

History
417 lines (281 loc) · 12.5 KB

MovementApi.md

File metadata and controls

417 lines (281 loc) · 12.5 KB
Raw

Equisoft\SDK\EquisoftConnect\MovementApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method HTTP request Description
addMovement() POST /crm/api/v1/movements Add a movement
cancelMovement() POST /crm/api/v1/movements/{movementId}/cancel Cancel a movement.
deleteMovement() DELETE /crm/api/v1/movements/{movementId} Delete a movement.
getExecutedMovementIdMapping() POST /crm/api/v1/movements/executed/{executedMovementId}/idMapping Get the mappings for id and uuid between the source and destination databases, for a given entity type
getExecutedMovementInfo() GET /crm/api/v1/movements/executed/{executedMovementId}/info Get basic information about an executed movement
getMovementStatistic() GET /crm/api/v1/movements/statistic Get movement statistic
listMovements() GET /crm/api/v1/movements List all movements

addMovement()

addMovement($movementMovementPayload): \Equisoft\SDK\EquisoftConnect\Model\MovementAddMovementResponse

Add a movement

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);
$movementMovementPayload = new \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload(); // \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload

try {
    $result = $apiInstance->addMovement($movementMovementPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovementApi->addMovement: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
movementMovementPayload \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload

Return type

\Equisoft\SDK\EquisoftConnect\Model\MovementAddMovementResponse

Authorization

OAuth2

HTTP request headers

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

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

cancelMovement()

cancelMovement($movementId)

Cancel a movement.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);
$movementId = 56; // int | Movement identifier

try {
    $apiInstance->cancelMovement($movementId);
} catch (Exception $e) {
    echo 'Exception when calling MovementApi->cancelMovement: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
movementId int Movement identifier

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

deleteMovement()

deleteMovement($movementId)

Delete a movement.

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);
$movementId = 56; // int | Movement identifier

try {
    $apiInstance->deleteMovement($movementId);
} catch (Exception $e) {
    echo 'Exception when calling MovementApi->deleteMovement: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
movementId int Movement identifier

Return type

void (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getExecutedMovementIdMapping()

getExecutedMovementIdMapping($executedMovementId, $movementIdMappingRequest): \Equisoft\SDK\EquisoftConnect\Model\MovementIdMappingResponse

Get the mappings for id and uuid between the source and destination databases, for a given entity type

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);
$executedMovementId = 56; // int | Executed Movement identifier
$movementIdMappingRequest = new \Equisoft\SDK\EquisoftConnect\Model\MovementIdMappingRequest(); // \Equisoft\SDK\EquisoftConnect\Model\MovementIdMappingRequest

try {
    $result = $apiInstance->getExecutedMovementIdMapping($executedMovementId, $movementIdMappingRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovementApi->getExecutedMovementIdMapping: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
executedMovementId int Executed Movement identifier
movementIdMappingRequest \Equisoft\SDK\EquisoftConnect\Model\MovementIdMappingRequest

Return type

\Equisoft\SDK\EquisoftConnect\Model\MovementIdMappingResponse

Authorization

OAuth2

HTTP request headers

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

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

getExecutedMovementInfo()

getExecutedMovementInfo($executedMovementId): \Equisoft\SDK\EquisoftConnect\Model\MovementExecutedMovementInfoResponse

Get basic information about an executed movement

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);
$executedMovementId = 56; // int | Executed Movement identifier

try {
    $result = $apiInstance->getExecutedMovementInfo($executedMovementId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovementApi->getExecutedMovementInfo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
executedMovementId int Executed Movement identifier

Return type

\Equisoft\SDK\EquisoftConnect\Model\MovementExecutedMovementInfoResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

getMovementStatistic()

getMovementStatistic($movementMovementPayload): \Equisoft\SDK\EquisoftConnect\Model\MovementMovementStatisticResponse

Get movement statistic

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);
$movementMovementPayload = new \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload(); // \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload

try {
    $result = $apiInstance->getMovementStatistic($movementMovementPayload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MovementApi->getMovementStatistic: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
movementMovementPayload \Equisoft\SDK\EquisoftConnect\Model\MovementMovementPayload

Return type

\Equisoft\SDK\EquisoftConnect\Model\MovementMovementStatisticResponse

Authorization

OAuth2

HTTP request headers

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

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

listMovements()

listMovements(): \Equisoft\SDK\EquisoftConnect\Model\MovementListMovementResponse

List all movements

Example

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


// Configure OAuth2 access token for authorization: OAuth2
$config = Equisoft\SDK\EquisoftConnect\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Equisoft\SDK\EquisoftConnect\Api\MovementApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Equisoft\SDK\EquisoftConnect\Model\MovementListMovementResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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