# MyDataMyConsent\DataConsentsApi
All URIs are relative to https://api.mydatamyconsent.com.
| Method | HTTP request | Description |
|---|---|---|
| downloadConsentedDocumentAnalysis() | GET /v1/consents/{consentId}/documents/{documentId}/analysis | Get analysis of a consented document. |
| downloadIndividualConsentedDocumentById() | GET /v1/consents/individuals/{consentId}/documents/{documentId}/download | Download individual consented document by document id. |
| downloadOrganizationConsentedDocumentById() | GET /v1/consents/organizations/{consentId}/documents/{documentId}/download | Download organization consent document based on document id. |
| getAllConsentedFinancialAccounts() | GET /v1/consents/individuals/{consentId}/financial-accounts | Get all individual consented financial accounts. |
| getConsentFinancialAccounts() | GET /v1/consents/organizations/{consentId}/financial-accounts | Get all organizational consented financial accounts. |
| getConsentedAccountById() | GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId} | Get individual consented financial account details based on account id. |
| getConsentedDocumentById() | GET /v1/consents/individuals/{consentId}/documents/{documentId} | Get individual consented document by document id. |
| getConsentedFinancialAccount() | GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId} | Get organization consented financial account details based on account id. |
| getConsentedFinancialAccountInsights() | GET /v1/consents/{consentId}/financial-accounts/{accountId}/insights | Get consented financial account insights. |
| getConsentedFinancialAccountTransactions() | GET /v1/consents/individuals/{consentId}/financial-accounts/{accountId}/transactions | Get individual consented financial account transactions of an individual based on accountId. |
| getConsents() | GET /v1/consents/individuals | Get the paginated list of individual data consents. |
| getIndividualConsentedDocuments() | GET /v1/consents/individuals/{consentId}/documents | Get individual consented documents by consent id. |
| getIndividualDataConsentById() | GET /v1/consents/individuals/{consentId} | Get individuals data consent details by consent id. |
| getOrgConsentedAccountTransactions() | GET /v1/consents/organizations/{consentId}/financial-accounts/{accountId}/transactions | Get organization consented financial account transactions of an individual based on accountId. |
| getOrganizationConsentedDocumentById() | GET /v1/consents/organizations/{consentId}/documents/{documentId} | Get organization consent document based on document id. |
| getOrganizationConsentedDocuments() | GET /v1/consents/organizations/{consentId}/documents | Get organization consented documents by consent id. |
| getOrganizationDataConsentById() | GET /v1/consents/organizations/{consentId} | Get organizations data consent details by consent id. |
| getOrganizationDataConsents() | GET /v1/consents/organizations | Get the paginated list of organization data consents. |
# downloadConsentedDocumentAnalysis()
downloadConsentedDocumentAnalysis($consent_id, $document_id)
1
Get analysis of a consented document.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Data consent id.
$document_id = 'document_id_example'; // string | Consented document Id.
try {
$apiInstance->downloadConsentedDocumentAnalysis($consent_id, $document_id);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->downloadConsentedDocumentAnalysis: ', $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 |
|---|---|---|---|
| consent_id | string | Data consent id. | |
| document_id | string | Consented document 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]
# downloadIndividualConsentedDocumentById()
downloadIndividualConsentedDocumentById($consent_id, $document_id)
1
Download individual consented document by document id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Individual data consent id.
$document_id = 'document_id_example'; // string | Consented document id.
try {
$apiInstance->downloadIndividualConsentedDocumentById($consent_id, $document_id);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->downloadIndividualConsentedDocumentById: ', $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 |
|---|---|---|---|
| consent_id | string | Individual data consent id. | |
| document_id | string | Consented document 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]
# downloadOrganizationConsentedDocumentById()
downloadOrganizationConsentedDocumentById($consent_id, $document_id)
1
Download organization consent document based on document id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Organization data consent id.
$document_id = 'document_id_example'; // string | Organization consented document Id.
try {
$apiInstance->downloadOrganizationConsentedDocumentById($consent_id, $document_id);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->downloadOrganizationConsentedDocumentById: ', $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 |
|---|---|---|---|
| consent_id | string | Organization data consent id. | |
| document_id | string | Organization consented document 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]
# getAllConsentedFinancialAccounts()
getAllConsentedFinancialAccounts($consent_id): \MyDataMyConsent\Model\DataConsentFinancialsDto
1
Get all individual consented financial accounts.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Consent id.
try {
$result = $apiInstance->getAllConsentedFinancialAccounts($consent_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getAllConsentedFinancialAccounts: ', $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 |
|---|---|---|---|
| consent_id | string | Consent id. |
# Return type
\MyDataMyConsent\Model\DataConsentFinancialsDto
# 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]
# getConsentFinancialAccounts()
getConsentFinancialAccounts($consent_id): \MyDataMyConsent\Model\DataConsentFinancialsDto
1
Get all organizational consented financial accounts.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Consent id.
try {
$result = $apiInstance->getConsentFinancialAccounts($consent_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsentFinancialAccounts: ', $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 |
|---|---|---|---|
| consent_id | string | Consent id. |
# Return type
\MyDataMyConsent\Model\DataConsentFinancialsDto
# 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]
# getConsentedAccountById()
getConsentedAccountById($consent_id, $account_id): \MyDataMyConsent\Model\FinancialAccount
1
Get individual consented financial account details based on account id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Consent id.
$account_id = 'account_id_example'; // string | Account id.
try {
$result = $apiInstance->getConsentedAccountById($consent_id, $account_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsentedAccountById: ', $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 |
|---|---|---|---|
| consent_id | string | Consent id. | |
| account_id | string | Account id. |
# Return type
\MyDataMyConsent\Model\FinancialAccount
# 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]
# getConsentedDocumentById()
getConsentedDocumentById($consent_id, $document_id): \MyDataMyConsent\Model\DataConsentDocument
1
Get individual consented document by document id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Individual data consent id.
$document_id = 'document_id_example'; // string | Consented document id.
try {
$result = $apiInstance->getConsentedDocumentById($consent_id, $document_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsentedDocumentById: ', $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 |
|---|---|---|---|
| consent_id | string | Individual data consent id. | |
| document_id | string | Consented document id. |
# Return type
\MyDataMyConsent\Model\DataConsentDocument
# 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]
# getConsentedFinancialAccount()
getConsentedFinancialAccount($consent_id, $account_id): \MyDataMyConsent\Model\OrganizationFinancialAccountDto
1
Get organization consented financial account details based on account id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Consent id.
$account_id = 'account_id_example'; // string | Account id.
try {
$result = $apiInstance->getConsentedFinancialAccount($consent_id, $account_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsentedFinancialAccount: ', $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 |
|---|---|---|---|
| consent_id | string | Consent id. | |
| account_id | string | Account id. |
# Return type
\MyDataMyConsent\Model\OrganizationFinancialAccountDto
# 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]
# getConsentedFinancialAccountInsights()
getConsentedFinancialAccountInsights($consent_id, $account_id)
1
Get consented financial account insights.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string |
$account_id = 'account_id_example'; // string |
try {
$apiInstance->getConsentedFinancialAccountInsights($consent_id, $account_id);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsentedFinancialAccountInsights: ', $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 |
|---|---|---|---|
| consent_id | string | ||
| account_id | string |
# 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]
# getConsentedFinancialAccountTransactions()
getConsentedFinancialAccountTransactions($consent_id, $account_id, $filters, $from_date_time_utc, $to_date_time_utc, $page_no, $page_size): \MyDataMyConsent\Model\UserAccountFinancialTransactionsDtoPaginatedList
1
Get individual consented financial account transactions of an individual based on accountId.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Consent id.
$account_id = 'account_id_example'; // string | Account id.
$filters = 'filters_example'; // string | Filters.
$from_date_time_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | From date time in utc timezone.
$to_date_time_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Til date time in utc timezone.
$page_no = 10; // int | Page number.
$page_size = 25; // int | Number of items to return.
try {
$result = $apiInstance->getConsentedFinancialAccountTransactions($consent_id, $account_id, $filters, $from_date_time_utc, $to_date_time_utc, $page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsentedFinancialAccountTransactions: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| consent_id | string | Consent id. | |
| account_id | string | Account id. | |
| filters | string | Filters. | [optional] |
| from_date_time_utc | \DateTime | From date time in utc timezone. | [optional] |
| to_date_time_utc | \DateTime | Til date time in utc timezone. | [optional] |
| page_no | int | Page number. | [optional] [default to 10] |
| page_size | int | Number of items to return. | [optional] [default to 25] |
# Return type
\MyDataMyConsent\Model\UserAccountFinancialTransactionsDtoPaginatedList
# 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]
# getConsents()
getConsents($status, $from_date_time, $to_date_time, $page_no, $page_size): \MyDataMyConsent\Model\DataConsentDetailsPaginatedList
1
Get the paginated list of individual data consents.
GetIndividualDataConsents
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$status = new \MyDataMyConsent\Model\DataConsentStatus(); // DataConsentStatus | Data consent status.
$from_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | From datetime in UTC timezone.
$to_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | To datetime in UTC timezone.
$page_no = 1; // int | Page number.
$page_size = 25; // int | Number of items to return.
try {
$result = $apiInstance->getConsents($status, $from_date_time, $to_date_time, $page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getConsents: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| status | DataConsentStatus | Data consent status. | [optional] |
| from_date_time | \DateTime | From datetime in UTC timezone. | [optional] |
| to_date_time | \DateTime | To datetime in UTC timezone. | [optional] |
| 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\DataConsentDetailsPaginatedList
# 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]
# getIndividualConsentedDocuments()
getIndividualConsentedDocuments($consent_id): \MyDataMyConsent\Model\DataConsentDocument[]
1
Get individual consented documents by consent id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Individual data consent id.
try {
$result = $apiInstance->getIndividualConsentedDocuments($consent_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getIndividualConsentedDocuments: ', $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 |
|---|---|---|---|
| consent_id | string | Individual data consent id. |
# Return type
\MyDataMyConsent\Model\DataConsentDocument[]
# 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]
# getIndividualDataConsentById()
getIndividualDataConsentById($consent_id): \MyDataMyConsent\Model\DataConsent
1
Get individuals data consent details by consent id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Individual data consent id.
try {
$result = $apiInstance->getIndividualDataConsentById($consent_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getIndividualDataConsentById: ', $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 |
|---|---|---|---|
| consent_id | string | Individual data consent id. |
# Return type
\MyDataMyConsent\Model\DataConsent
# 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]
# getOrgConsentedAccountTransactions()
getOrgConsentedAccountTransactions($consent_id, $account_id, $filters, $from_date_time_utc, $to_date_time_utc, $page_no, $page_size): \MyDataMyConsent\Model\OrganizationFinancialTransactionsDtoPaginatedList
1
Get organization consented financial account transactions of an individual based on accountId.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Consent id.
$account_id = 'account_id_example'; // string | Account id.
$filters = 'filters_example'; // string | Filters.
$from_date_time_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | From date time in utc timezone.
$to_date_time_utc = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Til date time in utc timezone.
$page_no = 1; // int | Page number.
$page_size = 25; // int | Number of items to return.
try {
$result = $apiInstance->getOrgConsentedAccountTransactions($consent_id, $account_id, $filters, $from_date_time_utc, $to_date_time_utc, $page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getOrgConsentedAccountTransactions: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| consent_id | string | Consent id. | |
| account_id | string | Account id. | |
| filters | string | Filters. | [optional] |
| from_date_time_utc | \DateTime | From date time in utc timezone. | [optional] |
| to_date_time_utc | \DateTime | Til date time in utc timezone. | [optional] |
| 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\OrganizationFinancialTransactionsDtoPaginatedList
# 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]
# getOrganizationConsentedDocumentById()
getOrganizationConsentedDocumentById($consent_id, $document_id): \MyDataMyConsent\Model\DataConsentDocument
1
Get organization consent document based on document id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Organization data consent id.
$document_id = 'document_id_example'; // string | Organization consented document Id.
try {
$result = $apiInstance->getOrganizationConsentedDocumentById($consent_id, $document_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getOrganizationConsentedDocumentById: ', $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 |
|---|---|---|---|
| consent_id | string | Organization data consent id. | |
| document_id | string | Organization consented document Id. |
# Return type
\MyDataMyConsent\Model\DataConsentDocument
# 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]
# getOrganizationConsentedDocuments()
getOrganizationConsentedDocuments($consent_id): \MyDataMyConsent\Model\DataConsentDocument[]
1
Get organization consented documents by consent id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Organization data consent id.
try {
$result = $apiInstance->getOrganizationConsentedDocuments($consent_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getOrganizationConsentedDocuments: ', $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 |
|---|---|---|---|
| consent_id | string | Organization data consent id. |
# Return type
\MyDataMyConsent\Model\DataConsentDocument[]
# 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]
# getOrganizationDataConsentById()
getOrganizationDataConsentById($consent_id): \MyDataMyConsent\Model\DataConsent
1
Get organizations data consent details by consent id.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$consent_id = 'consent_id_example'; // string | Organization data consent id.
try {
$result = $apiInstance->getOrganizationDataConsentById($consent_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getOrganizationDataConsentById: ', $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 |
|---|---|---|---|
| consent_id | string | Organization data consent id. |
# Return type
\MyDataMyConsent\Model\DataConsent
# 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]
# getOrganizationDataConsents()
getOrganizationDataConsents($status, $from_date_time, $to_date_time, $page_no, $page_size): \MyDataMyConsent\Model\DataConsentDetailsPaginatedList
1
Get the paginated list of organization data consents.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DataConsentsApi(
// 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()
);
$status = new \MyDataMyConsent\Model\DataConsentStatus(); // DataConsentStatus | Data consent status.
$from_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | From datetime in UTC timezone.
$to_date_time = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | To datetime in UTC timezone.
$page_no = 1; // int | Page number.
$page_size = 25; // int | Number of items to return.
try {
$result = $apiInstance->getOrganizationDataConsents($status, $from_date_time, $to_date_time, $page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DataConsentsApi->getOrganizationDataConsents: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| status | DataConsentStatus | Data consent status. | [optional] |
| from_date_time | \DateTime | From datetime in UTC timezone. | [optional] |
| to_date_time | \DateTime | To datetime in UTC timezone. | [optional] |
| 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\DataConsentDetailsPaginatedList
# 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]