# MyDataMyConsent\DataProcessingAgreementsApi
All URIs are relative to https://api.mydatamyconsent.com.
| Method | HTTP request | Description |
|---|---|---|
| createDataProcessingAgreement() | POST /v1/data-agreements | Create a data processing agreement. |
| deleteDataProcessingAgreementById() | DELETE /v1/data-agreements/{id} | Delete a data processing agreement. This will not delete a published or a agreement in use with consents. |
| getDataProcessingAgreementById() | GET /v1/data-agreements/{id} | Get data processing agreement by id. |
| getDataProcessingAgreements() | GET /v1/data-agreements | Get paginated data processing agreements. |
| terminateDataProcessingAgreementById() | PUT /v1/data-agreements/{id}/terminate | Terminate a data processing agreement. |
| updateDataProcessingAgreement() | PUT /v1/data-agreements/{id} | Update a data processing agreement. |
# createDataProcessingAgreement()
createDataProcessingAgreement($create_data_processing_agreement): \MyDataMyConsent\Model\DataProcessingAgreement
1
Create a data processing agreement.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataProcessingAgreementsApi(
// 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()
);
$create_data_processing_agreement = new \MyDataMyConsent\Model\CreateDataProcessingAgreement(); // \MyDataMyConsent\Model\CreateDataProcessingAgreement | Create data processing agreement payload
try {
$result = $apiInstance->createDataProcessingAgreement($create_data_processing_agreement);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataProcessingAgreementsApi->createDataProcessingAgreement: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| create_data_processing_agreement | \MyDataMyConsent\Model\CreateDataProcessingAgreement | Create data processing agreement payload |
# Return type
\MyDataMyConsent\Model\DataProcessingAgreement
# Authorization
No authorization required
# HTTP request headers
- Content-Type:
application/json - Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# deleteDataProcessingAgreementById()
deleteDataProcessingAgreementById($id)
1
Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataProcessingAgreementsApi(
// 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()
);
$id = 'id_example'; // string | Agreement id.
try {
$apiInstance->deleteDataProcessingAgreementById($id);
} catch (Exception $e) {
echo 'Exception when calling DataProcessingAgreementsApi->deleteDataProcessingAgreementById: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Agreement id. |
# Return type
void (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getDataProcessingAgreementById()
getDataProcessingAgreementById($id): \MyDataMyConsent\Model\DataProcessingAgreement
1
Get data processing agreement by id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataProcessingAgreementsApi(
// 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()
);
$id = 'id_example'; // string | Agreement id.
try {
$result = $apiInstance->getDataProcessingAgreementById($id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataProcessingAgreementsApi->getDataProcessingAgreementById: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Agreement id. |
# Return type
\MyDataMyConsent\Model\DataProcessingAgreement
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# getDataProcessingAgreements()
getDataProcessingAgreements($page_no, $page_size): \MyDataMyConsent\Model\DataProcessingAgreementPaginatedList
1
Get paginated data processing agreements.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataProcessingAgreementsApi(
// 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()
);
$page_no = 1; // int | Page number.
$page_size = 25; // int | Number of items to return.
try {
$result = $apiInstance->getDataProcessingAgreements($page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataProcessingAgreementsApi->getDataProcessingAgreements: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page_no | int | Page number. | [optional] [default to 1] |
| page_size | int | Number of items to return. | [optional] [default to 25] |
# Return type
\MyDataMyConsent\Model\DataProcessingAgreementPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# terminateDataProcessingAgreementById()
terminateDataProcessingAgreementById($id)
1
Terminate a data processing agreement.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataProcessingAgreementsApi(
// 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()
);
$id = 'id_example'; // string | Agreement id.
try {
$apiInstance->terminateDataProcessingAgreementById($id);
} catch (Exception $e) {
echo 'Exception when calling DataProcessingAgreementsApi->terminateDataProcessingAgreementById: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Agreement id. |
# Return type
void (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# updateDataProcessingAgreement()
updateDataProcessingAgreement($id, $update_data_processing_agreement): \MyDataMyConsent\Model\DataProcessingAgreement
1
Update a data processing agreement.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataProcessingAgreementsApi(
// 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()
);
$id = 'id_example'; // string | Agreement id.
$update_data_processing_agreement = new \MyDataMyConsent\Model\UpdateDataProcessingAgreement(); // \MyDataMyConsent\Model\UpdateDataProcessingAgreement | Update data processing agreement payload
try {
$result = $apiInstance->updateDataProcessingAgreement($id, $update_data_processing_agreement);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataProcessingAgreementsApi->updateDataProcessingAgreement: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Agreement id. | |
| update_data_processing_agreement | \MyDataMyConsent\Model\UpdateDataProcessingAgreement | Update data processing agreement payload |
# Return type
\MyDataMyConsent\Model\DataProcessingAgreement
# Authorization
No authorization required
# HTTP request headers
- Content-Type:
application/json - Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]