# MyDataMyConsent.Api.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
IssuedDocumentDetails GetIssuedDocumentById (Guid documentId)
Get issued document.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class GetIssuedDocumentByIdExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var documentId = "documentId_example"; // Guid | Document id.
try
{
// Get issued document.
IssuedDocumentDetails result = apiInstance.GetIssuedDocumentById(documentId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.GetIssuedDocumentById: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| documentId | Guid | Document id. |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 500 | Server Error | - |
| 400 | Bad Request | - |
| 404 | Not Found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetIssuedDocuments
IssuedDocumentPaginatedList GetIssuedDocuments (Guid? documentTypeId = null, DateTime? fromDateTime = null, DateTime? toDateTime = null, int? pageNo = null, int? pageSize = null)
Get paginated list of issued documents of given document type.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class GetIssuedDocumentsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var documentTypeId = "documentTypeId_example"; // Guid? | Document type id. (optional)
var fromDateTime = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | From DateTime in UTC timezone. (optional)
var toDateTime = DateTime.Parse("2013-10-20T19:20:30+01:00"); // DateTime? | To DateTime in UTC timezone. (optional)
var pageNo = 1; // int? | Page number. (optional) (default to 1)
var pageSize = 25; // int? | Number of items to return. (optional) (default to 25)
try
{
// Get paginated list of issued documents of given document type.
IssuedDocumentPaginatedList result = apiInstance.GetIssuedDocuments(documentTypeId, fromDateTime, toDateTime, pageNo, pageSize);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.GetIssuedDocuments: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| documentTypeId | Guid? | Document type id. | [optional] |
| fromDateTime | DateTime? | From DateTime in UTC timezone. | [optional] |
| toDateTime | DateTime? | To DateTime in UTC timezone. | [optional] |
| pageNo | int? | Page number. | [optional] [default to 1] |
| pageSize | int? | Number of items to return. | [optional] [default to 25] |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 500 | Server Error | - |
| 400 | Bad Request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# GetRegisteredDocumentTypes
DocumentTypePaginatedList GetRegisteredDocumentTypes (SupportedEntityType? supportedEntityType = null, int? pageNo = null, int? pageSize = null)
Get paginated list of registered document types.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class GetRegisteredDocumentTypesExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var supportedEntityType = new SupportedEntityType?(); // SupportedEntityType? | Supported entity type. (optional)
var pageNo = 1; // int? | Page number. (optional) (default to 1)
var pageSize = 25; // int? | Number of items to return. (optional) (default to 25)
try
{
// Get paginated list of registered document types.
DocumentTypePaginatedList result = apiInstance.GetRegisteredDocumentTypes(supportedEntityType, pageNo, pageSize);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.GetRegisteredDocumentTypes: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| supportedEntityType | SupportedEntityType? | Supported entity type. | [optional] |
| pageNo | int? | Page number. | [optional] [default to 1] |
| pageSize | int? | Number of items to return. | [optional] [default to 25] |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 500 | Server Error | - |
| 400 | Bad Request | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# IssueDocumentToIndividual
DocumentIssueRequestDetails IssueDocumentToIndividual (DocumentIssueRequest documentIssueRequest)
Issue a new document to an individual user.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class IssueDocumentToIndividualExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var documentIssueRequest = new DocumentIssueRequest(); // DocumentIssueRequest | Document issue request payload
try
{
// Issue a new document to an individual user.
DocumentIssueRequestDetails result = apiInstance.IssueDocumentToIndividual(documentIssueRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.IssueDocumentToIndividual: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| documentIssueRequest | DocumentIssueRequest | Document issue request payload |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 400 | Bad Request | - |
| 404 | Not Found | - |
| 500 | Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# IssueDocumentToOrganization
DocumentIssueRequestDetails IssueDocumentToOrganization (DocumentIssueRequest documentIssueRequest)
Issue a new document to an organization.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class IssueDocumentToOrganizationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var documentIssueRequest = new DocumentIssueRequest(); // DocumentIssueRequest | Document issue request payload
try
{
// Issue a new document to an organization.
DocumentIssueRequestDetails result = apiInstance.IssueDocumentToOrganization(documentIssueRequest);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.IssueDocumentToOrganization: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| documentIssueRequest | DocumentIssueRequest | Document issue request payload |
# Return type
# Authorization
No authorization required
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Success | - |
| 400 | Bad Request | - |
| 404 | Not Found | - |
| 500 | Server Error | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# UploadDocumentForIndividual
void UploadDocumentForIndividual (Guid issueRequestId, System.IO.Stream formFile)
Upload a document for issuance request of individual.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class UploadDocumentForIndividualExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var issueRequestId = "issueRequestId_example"; // Guid | Document issue request id.
var formFile = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // System.IO.Stream |
try
{
// Upload a document for issuance request of individual.
apiInstance.UploadDocumentForIndividual(issueRequestId, formFile);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.UploadDocumentForIndividual: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| issueRequestId | Guid | Document issue request id. | |
| formFile | System.IO.Stream****System.IO.Stream |
# Return type
void (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 404 | Not Found | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
# UploadDocumentForOrganization
void UploadDocumentForOrganization (Guid issueRequestId, System.IO.Stream formFile)
Upload a document for issuance request of organization.
# Example
using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;
namespace Example
{
public class UploadDocumentForOrganizationExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.mydatamyconsent.com";
var apiInstance = new DocumentsApi(config);
var issueRequestId = "issueRequestId_example"; // Guid | Document issue request id System.Guid.
var formFile = new System.IO.MemoryStream(System.IO.File.ReadAllBytes("/path/to/file.txt")); // System.IO.Stream |
try
{
// Upload a document for issuance request of organization.
apiInstance.UploadDocumentForOrganization(issueRequestId, formFile);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DocumentsApi.UploadDocumentForOrganization: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| issueRequestId | Guid | Document issue request id System.Guid. | |
| formFile | System.IO.Stream****System.IO.Stream |
# Return type
void (empty response body)
# Authorization
No authorization required
# HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
# HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 404 | Not Found | - |
| 400 | Bad Request | - |
| 500 | Server Error | - |
| 0 | Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]