# MyDataMyConsent\DocumentsApi
All URIs are relative to https://api.mydatamyconsent.com.
| Method | HTTP request | Description |
|---|---|---|
| getIssuedDocumentById() | GET /v1/documents/issued/{documentId} | Get issued document. |
| getIssuedDocuments() | GET /v1/documents/issued | Get paginated list of issued documents of given document type. |
| getRegisteredDocumentTypes() | GET /v1/documents/types | Get paginated list of registered document types. |
| issueDocumentToIndividual() | POST /v1/documents/issue/individual | Issue a new document to an individual user. |
| issueDocumentToOrganization() | POST /v1/documents/issue/organization | Issue a new document to an organization. |
| uploadDocumentForIndividual() | POST /v1/documents/issue/individual/upload/{issueRequestId} | Upload a document for issuance request of individual. |
| uploadDocumentForOrganization() | POST /v1/documents/issue/organization/upload/{issueRequestId} | Upload a document for issuance request of organization. |
# getIssuedDocumentById()
getIssuedDocumentById($document_id): \MyDataMyConsent\Model\IssuedDocumentDetails
1
Get issued document.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$document_id = 'document_id_example'; // string | Document id.
try {
$result = $apiInstance->getIssuedDocumentById($document_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->getIssuedDocumentById: ', $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 |
|---|---|---|---|
| document_id | string | Document id. |
# Return type
\MyDataMyConsent\Model\IssuedDocumentDetails
# 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]
# getIssuedDocuments()
getIssuedDocuments($document_type_id, $from_date_time, $to_date_time, $page_no, $page_size): \MyDataMyConsent\Model\IssuedDocumentPaginatedList
1
Get paginated list of issued documents of given document type.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$document_type_id = 'document_type_id_example'; // string | Document type id.
$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->getIssuedDocuments($document_type_id, $from_date_time, $to_date_time, $page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->getIssuedDocuments: ', $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 |
|---|---|---|---|
| document_type_id | string | Document type id. | [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\IssuedDocumentPaginatedList
# 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]
# getRegisteredDocumentTypes()
getRegisteredDocumentTypes($supported_entity_type, $page_no, $page_size): \MyDataMyConsent\Model\DocumentTypePaginatedList
1
Get paginated list of registered document types.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$supported_entity_type = new \MyDataMyConsent\Model\SupportedEntityType(); // SupportedEntityType | Supported entity type.
$page_no = 1; // int | Page number.
$page_size = 25; // int | Number of items to return.
try {
$result = $apiInstance->getRegisteredDocumentTypes($supported_entity_type, $page_no, $page_size);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->getRegisteredDocumentTypes: ', $e->getMessage(), PHP_EOL;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| supported_entity_type | SupportedEntityType | Supported entity type. | [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\DocumentTypePaginatedList
# 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]
# issueDocumentToIndividual()
issueDocumentToIndividual($document_issue_request): \MyDataMyConsent\Model\DocumentIssueRequestDetails
1
Issue a new document to an individual user.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$document_issue_request = new \MyDataMyConsent\Model\DocumentIssueRequest(); // \MyDataMyConsent\Model\DocumentIssueRequest | Document issue request payload
try {
$result = $apiInstance->issueDocumentToIndividual($document_issue_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->issueDocumentToIndividual: ', $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 |
|---|---|---|---|
| document_issue_request | \MyDataMyConsent\Model\DocumentIssueRequest | Document issue request payload |
# Return type
\MyDataMyConsent\Model\DocumentIssueRequestDetails
# 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]
# issueDocumentToOrganization()
issueDocumentToOrganization($document_issue_request): \MyDataMyConsent\Model\DocumentIssueRequestDetails
1
Issue a new document to an organization.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$document_issue_request = new \MyDataMyConsent\Model\DocumentIssueRequest(); // \MyDataMyConsent\Model\DocumentIssueRequest | Document issue request payload
try {
$result = $apiInstance->issueDocumentToOrganization($document_issue_request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->issueDocumentToOrganization: ', $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 |
|---|---|---|---|
| document_issue_request | \MyDataMyConsent\Model\DocumentIssueRequest | Document issue request payload |
# Return type
\MyDataMyConsent\Model\DocumentIssueRequestDetails
# 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]
# uploadDocumentForIndividual()
uploadDocumentForIndividual($issue_request_id, $form_file)
1
Upload a document for issuance request of individual.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$issue_request_id = 'issue_request_id_example'; // string | Document issue request id.
$form_file = "/path/to/file.txt"; // \SplFileObject
try {
$apiInstance->uploadDocumentForIndividual($issue_request_id, $form_file);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->uploadDocumentForIndividual: ', $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 |
|---|---|---|---|
| issue_request_id | string | Document issue request id. | |
| form_file | \SplFileObject**\SplFileObject** |
# Return type
void (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type:
multipart/form-data - Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# uploadDocumentForOrganization()
uploadDocumentForOrganization($issue_request_id, $form_file)
1
Upload a document for issuance request of organization.
# Example
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new MyDataMyConsent\Api\DocumentsApi(
// 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()
);
$issue_request_id = 'issue_request_id_example'; // string | Document issue request id System.Guid.
$form_file = "/path/to/file.txt"; // \SplFileObject
try {
$apiInstance->uploadDocumentForOrganization($issue_request_id, $form_file);
} catch (Exception $e) {
echo 'Exception when calling DocumentsApi->uploadDocumentForOrganization: ', $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 |
|---|---|---|---|
| issue_request_id | string | Document issue request id System.Guid. | |
| form_file | \SplFileObject**\SplFileObject** |
# Return type
void (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type:
multipart/form-data - Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]