# MyDataMyConsent::DataProcessingAgreementsApi
All URIs are relative to https://api.mydatamyconsent.com
| Method | HTTP request | Description |
|---|---|---|
| create_data_processing_agreement | POST /v1/data-agreements | Create a data processing agreement. |
| delete_data_processing_agreement_by_id | DELETE /v1/data-agreements/{id} | Delete a data processing agreement. This will not delete a published or a agreement in use with consents. |
| get_data_processing_agreement_by_id | GET /v1/data-agreements/{id} | Get data processing agreement by id. |
| get_data_processing_agreements | GET /v1/data-agreements | Get paginated data processing agreements. |
| terminate_data_processing_agreement_by_id | PUT /v1/data-agreements/{id}/terminate | Terminate a data processing agreement. |
| update_data_processing_agreement | PUT /v1/data-agreements/{id} | Update a data processing agreement. |
# create_data_processing_agreement
create_data_processing_agreement(create_data_processing_agreement)
Create a data processing agreement.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
create_data_processing_agreement = MyDataMyConsent::CreateDataProcessingAgreement.new({version: 'version_example', body: 'body_example', attachment_url: 'attachment_url_example'}) # CreateDataProcessingAgreement | Create data processing agreement payload
begin
# Create a data processing agreement.
result = api_instance.create_data_processing_agreement(create_data_processing_agreement)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->create_data_processing_agreement: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# Using the create_data_processing_agreement_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> create_data_processing_agreement_with_http_info(create_data_processing_agreement)
begin
# Create a data processing agreement.
data, status_code, headers = api_instance.create_data_processing_agreement_with_http_info(create_data_processing_agreement)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataProcessingAgreement>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->create_data_processing_agreement_with_http_info: #{e}"
end
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| create_data_processing_agreement | CreateDataProcessingAgreement | Create data processing agreement payload |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# delete_data_processing_agreement_by_id
delete_data_processing_agreement_by_id(id)
Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Agreement id.
begin
# Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
api_instance.delete_data_processing_agreement_by_id(id)
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->delete_data_processing_agreement_by_id: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# Using the delete_data_processing_agreement_by_id_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
delete_data_processing_agreement_by_id_with_http_info(id)
begin
# Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
data, status_code, headers = api_instance.delete_data_processing_agreement_by_id_with_http_info(id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->delete_data_processing_agreement_by_id_with_http_info: #{e}"
end
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Agreement id. |
# Return type
nil (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_data_processing_agreement_by_id
get_data_processing_agreement_by_id(id)
Get data processing agreement by id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Agreement id.
begin
# Get data processing agreement by id.
result = api_instance.get_data_processing_agreement_by_id(id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->get_data_processing_agreement_by_id: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
# Using the get_data_processing_agreement_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_data_processing_agreement_by_id_with_http_info(id)
begin
# Get data processing agreement by id.
data, status_code, headers = api_instance.get_data_processing_agreement_by_id_with_http_info(id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataProcessingAgreement>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->get_data_processing_agreement_by_id_with_http_info: #{e}"
end
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Agreement id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_data_processing_agreements
get_data_processing_agreements(opts)
Get paginated data processing agreements.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
opts = {
page_no: 56, # Integer | Page number.
page_size: 56 # Integer | Number of items to return.
}
begin
# Get paginated data processing agreements.
result = api_instance.get_data_processing_agreements(opts)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->get_data_processing_agreements: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# Using the get_data_processing_agreements_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_data_processing_agreements_with_http_info(opts)
begin
# Get paginated data processing agreements.
data, status_code, headers = api_instance.get_data_processing_agreements_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataProcessingAgreementPaginatedList>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->get_data_processing_agreements_with_http_info: #{e}"
end
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page_no | Integer | Page number. | [optional][default to 1] |
| page_size | Integer | Number of items to return. | [optional][default to 25] |
# Return type
DataProcessingAgreementPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# terminate_data_processing_agreement_by_id
terminate_data_processing_agreement_by_id(id)
Terminate a data processing agreement.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Agreement id.
begin
# Terminate a data processing agreement.
api_instance.terminate_data_processing_agreement_by_id(id)
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->terminate_data_processing_agreement_by_id: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# Using the terminate_data_processing_agreement_by_id_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
terminate_data_processing_agreement_by_id_with_http_info(id)
begin
# Terminate a data processing agreement.
data, status_code, headers = api_instance.terminate_data_processing_agreement_by_id_with_http_info(id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->terminate_data_processing_agreement_by_id_with_http_info: #{e}"
end
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Agreement id. |
# Return type
nil (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# update_data_processing_agreement
update_data_processing_agreement(id, update_data_processing_agreement)
Update a data processing agreement.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataProcessingAgreementsApi.new
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Agreement id.
update_data_processing_agreement = MyDataMyConsent::UpdateDataProcessingAgreement.new({version: 'version_example', body: 'body_example', attachment_url: 'attachment_url_example'}) # UpdateDataProcessingAgreement | Update data processing agreement payload
begin
# Update a data processing agreement.
result = api_instance.update_data_processing_agreement(id, update_data_processing_agreement)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->update_data_processing_agreement: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# Using the update_data_processing_agreement_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> update_data_processing_agreement_with_http_info(id, update_data_processing_agreement)
begin
# Update a data processing agreement.
data, status_code, headers = api_instance.update_data_processing_agreement_with_http_info(id, update_data_processing_agreement)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataProcessingAgreement>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataProcessingAgreementsApi->update_data_processing_agreement_with_http_info: #{e}"
end
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | Agreement id. | |
| update_data_processing_agreement | UpdateDataProcessingAgreement | Update data processing agreement payload |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: application/json
- Accept: application/json