Skip to content

DepartmentApi.md

Latest commit

 

History

History
357 lines (246 loc) · 11.4 KB

DepartmentApi.md

File metadata and controls

357 lines (246 loc) · 11.4 KB

SynergiTech\Iplicit\DepartmentApi

All URIs are relative to https://api.iplicit.com, except if the operation defines another base path.

Method HTTP request Description
createDepartment() POST /api/Department Create a department
getDepartment() GET /api/Department/{departmentRef} Get a department
getDepartments() GET /api/Department Get a list of departments with a search filter
lockDepartment() POST /api/Department/{departmentRef}/lock Lock a department
unlockDepartment() POST /api/Department/{departmentRef}/unlock Unlock a department
upateDepartment() PATCH /api/Department/{departmentRef} Update a department

createDepartment()

createDepartment($departmentCreate): string

Create a department

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\DepartmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$departmentCreate = new \SynergiTech\Iplicit\Model\DepartmentCreate(); // \SynergiTech\Iplicit\Model\DepartmentCreate |

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

Parameters

Name Type Description Notes
departmentCreate \SynergiTech\Iplicit\Model\DepartmentCreate [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

getDepartment()

getDepartment($departmentRef, $include): \SynergiTech\Iplicit\Model\DepartmentRead

Get a department

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\DepartmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$departmentRef = 'departmentRef_example'; // string | `Id` or `Code` of the department
$include = 'include_example'; // string | Comma separated list of detail to include: `resources`, `subDepartments`. If omitted, no additional detail will be included.

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

Parameters

Name Type Description Notes
departmentRef string `Id` or `Code` of the department
include string Comma separated list of detail to include: `resources`, `subDepartments`. If omitted, no additional detail will be included. [optional]

Return type

\SynergiTech\Iplicit\Model\DepartmentRead

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

getDepartments()

getDepartments($descriptionContains, $codeContains, $parentDepartment, $legalEntity, $managerResource, $isActive, $includeClosed, $take, $skip): \SynergiTech\Iplicit\Model\DepartmentSearch[]

Get a list of departments with a search filter

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\DepartmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$descriptionContains = 'descriptionContains_example'; // string | Use to only search department where the description contains the text
$codeContains = 'codeContains_example'; // string | Use to only search department where the code contains the text
$parentDepartment = 'parentDepartment_example'; // string | Use to only search department with the parent department. Accepts id or code.
$legalEntity = 'legalEntity_example'; // string | Use to only search department with the legal entity. Accepts id or code.
$managerResource = 'managerResource_example'; // string | Use to only search department with the manager resource.  Accepts id or code.
$isActive = True; // bool | Use to only search department with the active state
$includeClosed = True; // bool | Use to only search department with the open state
$take = 100; // int | The number of records to return
$skip = 0; // int | The number of records to skip

try {
    $result = $apiInstance->getDepartments($descriptionContains, $codeContains, $parentDepartment, $legalEntity, $managerResource, $isActive, $includeClosed, $take, $skip);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DepartmentApi->getDepartments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
descriptionContains string Use to only search department where the description contains the text [optional]
codeContains string Use to only search department where the code contains the text [optional]
parentDepartment string Use to only search department with the parent department. Accepts id or code. [optional]
legalEntity string Use to only search department with the legal entity. Accepts id or code. [optional]
managerResource string Use to only search department with the manager resource. Accepts id or code. [optional]
isActive bool Use to only search department with the active state [optional]
includeClosed bool Use to only search department with the open state [optional]
take int The number of records to return [optional] [default to 100]
skip int The number of records to skip [optional] [default to 0]

Return type

\SynergiTech\Iplicit\Model\DepartmentSearch[]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

lockDepartment()

lockDepartment($departmentRef): string

Lock a department

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\DepartmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$departmentRef = 'departmentRef_example'; // string | Id or code of the department

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

Parameters

Name Type Description Notes
departmentRef string Id or code of the department

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

unlockDepartment()

unlockDepartment($departmentRef): string

Unlock a department

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\DepartmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$departmentRef = 'departmentRef_example'; // string | Id or code of the department

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

Parameters

Name Type Description Notes
departmentRef string Id or code of the department

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

upateDepartment()

upateDepartment($departmentRef, $departmentUpdate): string

Update a department

Example

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



$apiInstance = new SynergiTech\Iplicit\Api\DepartmentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    config: $config
);
$departmentRef = 'departmentRef_example'; // string | Id or code of the department
$departmentUpdate = new \SynergiTech\Iplicit\Model\DepartmentUpdate(); // \SynergiTech\Iplicit\Model\DepartmentUpdate |

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

Parameters

Name Type Description Notes
departmentRef string Id or code of the department
departmentUpdate \SynergiTech\Iplicit\Model\DepartmentUpdate [optional]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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