# MyDataMyConsent::DataConsentsApi
All URIs are relative to https://api.mydatamyconsent.com
| Method | HTTP request | Description |
|---|---|---|
| download_consented_document_analysis | GET /v1/consents/{consentId}/documents/{documentId}/analysis | Get analysis of a consented document. |
| download_individual_consented_document_by_id | GET /v1/consents/individuals/{consentId}/documents/{documentId}/download | Download individual consented document by document id. |
| download_organization_consented_document_by_id | GET /v1/consents/organizations/{consentId}/documents/{documentId}/download | Download organization consent document based on document id. |
| get_all_consented_financial_accounts | GET /v1/consents/individuals/{consentId}/financial-accounts | Get all individual consented financial accounts. |
| get_consent_financial_accounts | GET /v1/consents/organizations/{consentId}/financial-accounts | Get all organizational consented financial accounts. |
| get_consented_account_by_id | GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId} | Get individual consented financial account details based on account id. |
| get_consented_document_by_id | GET /v1/consents/individuals/{consentId}/documents/{documentId} | Get individual consented document by document id. |
| get_consented_financial_account | GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId} | Get organization consented financial account details based on account id. |
| get_consented_financial_account_insights | GET /v1/consents/{consentId}/financial-accounts/{accountId}/insights | Get consented financial account insights. |
| get_consented_financial_account_transactions | GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId}/transactions | Get individual consented financial account transactions of an individual based on accountId. |
| get_consents | GET /v1/consents/individuals | Get the paginated list of individual data consents. |
| get_individual_consented_documents | GET /v1/consents/individuals/{consentId}/documents | Get individual consented documents by consent id. |
| get_individual_data_consent_by_id | GET /v1/consents/individuals/{consentId} | Get individuals data consent details by consent id. |
| get_org_consented_account_transactions | GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId}/transactions | Get organization consented financial account transactions of an individual based on accountId. |
| get_organization_consented_document_by_id | GET /v1/consents/organizations/{consentId}/documents/{documentId} | Get organization consent document based on document id. |
| get_organization_consented_documents | GET /v1/consents/organizations/{consentId}/documents | Get organization consented documents by consent id. |
| get_organization_data_consent_by_id | GET /v1/consents/organizations/{consentId} | Get organizations data consent details by consent id. |
| get_organization_data_consents | GET /v1/consents/organizations | Get the paginated list of organization data consents. |
# download_consented_document_analysis
download_consented_document_analysis(consent_id, document_id)
Get analysis of a consented document.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = 'consent_id_example' # String | Data consent id.
document_id = 'document_id_example' # String | Consented document Id.
begin
# Get analysis of a consented document.
api_instance.download_consented_document_analysis(consent_id, document_id)
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->download_consented_document_analysis: #{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 download_consented_document_analysis_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
download_consented_document_analysis_with_http_info(consent_id, document_id)
begin
# Get analysis of a consented document.
data, status_code, headers = api_instance.download_consented_document_analysis_with_http_info(consent_id, document_id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->download_consented_document_analysis_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 |
|---|---|---|---|
| consent_id | String | Data consent id. | |
| document_id | String | Consented document Id. |
# Return type
nil (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# download_individual_consented_document_by_id
download_individual_consented_document_by_id(consent_id, document_id)
Download individual consented document by document id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Individual data consent id.
document_id = 'document_id_example' # String | Consented document id.
begin
# Download individual consented document by document id.
api_instance.download_individual_consented_document_by_id(consent_id, document_id)
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->download_individual_consented_document_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 download_individual_consented_document_by_id_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
download_individual_consented_document_by_id_with_http_info(consent_id, document_id)
begin
# Download individual consented document by document id.
data, status_code, headers = api_instance.download_individual_consented_document_by_id_with_http_info(consent_id, document_id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->download_individual_consented_document_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 |
|---|---|---|---|
| consent_id | String | Individual data consent id. | |
| document_id | String | Consented document id. |
# Return type
nil (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# download_organization_consented_document_by_id
download_organization_consented_document_by_id(consent_id, document_id)
Download organization consent document based on document id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Organization data consent id.
document_id = 'document_id_example' # String | Organization consented document Id.
begin
# Download organization consent document based on document id.
api_instance.download_organization_consented_document_by_id(consent_id, document_id)
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->download_organization_consented_document_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 download_organization_consented_document_by_id_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
download_organization_consented_document_by_id_with_http_info(consent_id, document_id)
begin
# Download organization consent document based on document id.
data, status_code, headers = api_instance.download_organization_consented_document_by_id_with_http_info(consent_id, document_id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->download_organization_consented_document_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 |
|---|---|---|---|
| consent_id | String | Organization data consent id. | |
| document_id | String | Organization consented document Id. |
# Return type
nil (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_all_consented_financial_accounts
get_all_consented_financial_accounts(consent_id)
Get all individual consented financial accounts.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Consent id.
begin
# Get all individual consented financial accounts.
result = api_instance.get_all_consented_financial_accounts(consent_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_all_consented_financial_accounts: #{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_all_consented_financial_accounts_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_all_consented_financial_accounts_with_http_info(consent_id)
begin
# Get all individual consented financial accounts.
data, status_code, headers = api_instance.get_all_consented_financial_accounts_with_http_info(consent_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsentFinancialsDto>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_all_consented_financial_accounts_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 |
|---|---|---|---|
| consent_id | String | Consent id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consent_financial_accounts
get_consent_financial_accounts(consent_id)
Get all organizational consented financial accounts.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Consent id.
begin
# Get all organizational consented financial accounts.
result = api_instance.get_consent_financial_accounts(consent_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consent_financial_accounts: #{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_consent_financial_accounts_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_consent_financial_accounts_with_http_info(consent_id)
begin
# Get all organizational consented financial accounts.
data, status_code, headers = api_instance.get_consent_financial_accounts_with_http_info(consent_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsentFinancialsDto>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consent_financial_accounts_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 |
|---|---|---|---|
| consent_id | String | Consent id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consented_account_by_id
get_consented_account_by_id(consent_id, account_id)
Get individual consented financial account details based on account id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Consent id.
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Account id.
begin
# Get individual consented financial account details based on account id.
result = api_instance.get_consented_account_by_id(consent_id, account_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_account_by_id: #{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 get_consented_account_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_consented_account_by_id_with_http_info(consent_id, account_id)
begin
# Get individual consented financial account details based on account id.
data, status_code, headers = api_instance.get_consented_account_by_id_with_http_info(consent_id, account_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <FinancialAccount>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_account_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 |
|---|---|---|---|
| consent_id | String | Consent id. | |
| account_id | String | Account id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consented_document_by_id
get_consented_document_by_id(consent_id, document_id)
Get individual consented document by document id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Individual data consent id.
document_id = 'document_id_example' # String | Consented document id.
begin
# Get individual consented document by document id.
result = api_instance.get_consented_document_by_id(consent_id, document_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_document_by_id: #{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 get_consented_document_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_consented_document_by_id_with_http_info(consent_id, document_id)
begin
# Get individual consented document by document id.
data, status_code, headers = api_instance.get_consented_document_by_id_with_http_info(consent_id, document_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsentDocument>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_document_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 |
|---|---|---|---|
| consent_id | String | Individual data consent id. | |
| document_id | String | Consented document id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consented_financial_account
get_consented_financial_account(consent_id, account_id)
Get organization consented financial account details based on account id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Consent id.
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Account id.
begin
# Get organization consented financial account details based on account id.
result = api_instance.get_consented_financial_account(consent_id, account_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_financial_account: #{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 get_consented_financial_account_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_consented_financial_account_with_http_info(consent_id, account_id)
begin
# Get organization consented financial account details based on account id.
data, status_code, headers = api_instance.get_consented_financial_account_with_http_info(consent_id, account_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <OrganizationFinancialAccountDto>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_financial_account_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 |
|---|---|---|---|
| consent_id | String | Consent id. | |
| account_id | String | Account id. |
# Return type
OrganizationFinancialAccountDto
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consented_financial_account_insights
get_consented_financial_account_insights(consent_id, account_id)
Get consented financial account insights.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = 'consent_id_example' # String |
account_id = 'account_id_example' # String |
begin
# Get consented financial account insights.
api_instance.get_consented_financial_account_insights(consent_id, account_id)
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_financial_account_insights: #{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_consented_financial_account_insights_with_http_info variant
This returns an Array which contains the response data (nil in this case), status code and headers.
get_consented_financial_account_insights_with_http_info(consent_id, account_id)
begin
# Get consented financial account insights.
data, status_code, headers = api_instance.get_consented_financial_account_insights_with_http_info(consent_id, account_id)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_financial_account_insights_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 |
|---|---|---|---|
| consent_id | String | ||
| account_id | String |
# Return type
nil (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consented_financial_account_transactions
get_consented_financial_account_transactions(consent_id, account_id, opts)
Get individual consented financial account transactions of an individual based on accountId.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Consent id.
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Account id.
opts = {
filters: 'filters_example', # String | Filters.
from_date_time_utc: Time.parse('2013-10-20T19:20:30+01:00'), # Time | From date time in utc timezone.
to_date_time_utc: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Til date time in utc timezone.
page_no: 56, # Integer | Page number.
page_size: 56 # Integer | Number of items to return.
}
begin
# Get individual consented financial account transactions of an individual based on accountId.
result = api_instance.get_consented_financial_account_transactions(consent_id, account_id, opts)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_financial_account_transactions: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Using the get_consented_financial_account_transactions_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_consented_financial_account_transactions_with_http_info(consent_id, account_id, opts)
begin
# Get individual consented financial account transactions of an individual based on accountId.
data, status_code, headers = api_instance.get_consented_financial_account_transactions_with_http_info(consent_id, account_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <UserAccountFinancialTransactionsDtoPaginatedList>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consented_financial_account_transactions_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 |
|---|---|---|---|
| consent_id | String | Consent id. | |
| account_id | String | Account id. | |
| filters | String | Filters. | [optional] |
| from_date_time_utc | Time | From date time in utc timezone. | [optional] |
| to_date_time_utc | Time | Til date time in utc timezone. | [optional] |
| page_no | Integer | Page number. | [optional][default to 10] |
| page_size | Integer | Number of items to return. | [optional][default to 25] |
# Return type
UserAccountFinancialTransactionsDtoPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_consents
get_consents(opts)
Get the paginated list of individual data consents.
GetIndividualDataConsents
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
opts = {
status: MyDataMyConsent::DataConsentStatus::PENDING, # DataConsentStatus | Data consent status.
from_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | From datetime in UTC timezone.
to_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | To datetime in UTC timezone.
page_no: 56, # Integer | Page number.
page_size: 56 # Integer | Number of items to return.
}
begin
# Get the paginated list of individual data consents.
result = api_instance.get_consents(opts)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consents: #{e}"
end
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
# Using the get_consents_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_consents_with_http_info(opts)
begin
# Get the paginated list of individual data consents.
data, status_code, headers = api_instance.get_consents_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsentDetailsPaginatedList>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_consents_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 |
|---|---|---|---|
| status | DataConsentStatus | Data consent status. | [optional] |
| from_date_time | Time | From datetime in UTC timezone. | [optional] |
| to_date_time | Time | To datetime in UTC timezone. | [optional] |
| page_no | Integer | Page number. | [optional][default to 1] |
| page_size | Integer | Number of items to return. | [optional][default to 25] |
# Return type
DataConsentDetailsPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_individual_consented_documents
> get_individual_consented_documents(consent_id)
Get individual consented documents by consent id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Individual data consent id.
begin
# Get individual consented documents by consent id.
result = api_instance.get_individual_consented_documents(consent_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_individual_consented_documents: #{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_individual_consented_documents_with_http_info variant
This returns an Array which contains the response data, status code and headers.
>, Integer, Hash)> get_individual_consented_documents_with_http_info(consent_id)
begin
# Get individual consented documents by consent id.
data, status_code, headers = api_instance.get_individual_consented_documents_with_http_info(consent_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <Array<DataConsentDocument>>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_individual_consented_documents_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 |
|---|---|---|---|
| consent_id | String | Individual data consent id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_individual_data_consent_by_id
get_individual_data_consent_by_id(consent_id)
Get individuals data consent details by consent id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Individual data consent id.
begin
# Get individuals data consent details by consent id.
result = api_instance.get_individual_data_consent_by_id(consent_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_individual_data_consent_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_individual_data_consent_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_individual_data_consent_by_id_with_http_info(consent_id)
begin
# Get individuals data consent details by consent id.
data, status_code, headers = api_instance.get_individual_data_consent_by_id_with_http_info(consent_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsent>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_individual_data_consent_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 |
|---|---|---|---|
| consent_id | String | Individual data consent id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_org_consented_account_transactions
get_org_consented_account_transactions(consent_id, account_id, opts)
Get organization consented financial account transactions of an individual based on accountId.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Consent id.
account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Account id.
opts = {
filters: 'filters_example', # String | Filters.
from_date_time_utc: Time.parse('2013-10-20T19:20:30+01:00'), # Time | From date time in utc timezone.
to_date_time_utc: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Til date time in utc timezone.
page_no: 56, # Integer | Page number.
page_size: 56 # Integer | Number of items to return.
}
begin
# Get organization consented financial account transactions of an individual based on accountId.
result = api_instance.get_org_consented_account_transactions(consent_id, account_id, opts)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_org_consented_account_transactions: #{e}"
end
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Using the get_org_consented_account_transactions_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_org_consented_account_transactions_with_http_info(consent_id, account_id, opts)
begin
# Get organization consented financial account transactions of an individual based on accountId.
data, status_code, headers = api_instance.get_org_consented_account_transactions_with_http_info(consent_id, account_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <OrganizationFinancialTransactionsDtoPaginatedList>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_org_consented_account_transactions_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 |
|---|---|---|---|
| consent_id | String | Consent id. | |
| account_id | String | Account id. | |
| filters | String | Filters. | [optional] |
| from_date_time_utc | Time | From date time in utc timezone. | [optional] |
| to_date_time_utc | Time | Til date time in utc timezone. | [optional] |
| page_no | Integer | Page number. | [optional][default to 1] |
| page_size | Integer | Number of items to return. | [optional][default to 25] |
# Return type
OrganizationFinancialTransactionsDtoPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_organization_consented_document_by_id
get_organization_consented_document_by_id(consent_id, document_id)
Get organization consent document based on document id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Organization data consent id.
document_id = 'document_id_example' # String | Organization consented document Id.
begin
# Get organization consent document based on document id.
result = api_instance.get_organization_consented_document_by_id(consent_id, document_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_consented_document_by_id: #{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 get_organization_consented_document_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_organization_consented_document_by_id_with_http_info(consent_id, document_id)
begin
# Get organization consent document based on document id.
data, status_code, headers = api_instance.get_organization_consented_document_by_id_with_http_info(consent_id, document_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsentDocument>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_consented_document_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 |
|---|---|---|---|
| consent_id | String | Organization data consent id. | |
| document_id | String | Organization consented document Id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_organization_consented_documents
> get_organization_consented_documents(consent_id)
Get organization consented documents by consent id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Organization data consent id.
begin
# Get organization consented documents by consent id.
result = api_instance.get_organization_consented_documents(consent_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_consented_documents: #{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_organization_consented_documents_with_http_info variant
This returns an Array which contains the response data, status code and headers.
>, Integer, Hash)> get_organization_consented_documents_with_http_info(consent_id)
begin
# Get organization consented documents by consent id.
data, status_code, headers = api_instance.get_organization_consented_documents_with_http_info(consent_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <Array<DataConsentDocument>>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_consented_documents_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 |
|---|---|---|---|
| consent_id | String | Organization data consent id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_organization_data_consent_by_id
get_organization_data_consent_by_id(consent_id)
Get organizations data consent details by consent id.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
consent_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Organization data consent id.
begin
# Get organizations data consent details by consent id.
result = api_instance.get_organization_data_consent_by_id(consent_id)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_data_consent_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_organization_data_consent_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_organization_data_consent_by_id_with_http_info(consent_id)
begin
# Get organizations data consent details by consent id.
data, status_code, headers = api_instance.get_organization_data_consent_by_id_with_http_info(consent_id)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsent>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_data_consent_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 |
|---|---|---|---|
| consent_id | String | Organization data consent id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# get_organization_data_consents
get_organization_data_consents(opts)
Get the paginated list of organization data consents.
# Examples
require 'time'
require 'mydatamyconsent'
api_instance = MyDataMyConsent::DataConsentsApi.new
opts = {
status: MyDataMyConsent::DataConsentStatus::PENDING, # DataConsentStatus | Data consent status.
from_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | From datetime in UTC timezone.
to_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | To datetime in UTC timezone.
page_no: 56, # Integer | Page number.
page_size: 56 # Integer | Number of items to return.
}
begin
# Get the paginated list of organization data consents.
result = api_instance.get_organization_data_consents(opts)
p result
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_data_consents: #{e}"
end
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
# Using the get_organization_data_consents_with_http_info variant
This returns an Array which contains the response data, status code and headers.
, Integer, Hash)> get_organization_data_consents_with_http_info(opts)
begin
# Get the paginated list of organization data consents.
data, status_code, headers = api_instance.get_organization_data_consents_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <DataConsentDetailsPaginatedList>
rescue MyDataMyConsent::ApiError => e
puts "Error when calling DataConsentsApi->get_organization_data_consents_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 |
|---|---|---|---|
| status | DataConsentStatus | Data consent status. | [optional] |
| from_date_time | Time | From datetime in UTC timezone. | [optional] |
| to_date_time | Time | To datetime in UTC timezone. | [optional] |
| page_no | Integer | Page number. | [optional][default to 1] |
| page_size | Integer | Number of items to return. | [optional][default to 25] |
# Return type
DataConsentDetailsPaginatedList
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json