# MyDataMyConsent.Api.DataProcessingAgreementsApi

All URIs are relative to https://api.mydatamyconsent.com

Method	HTTP request	Description
CreateDataProcessingAgreement	POST /v1/data-agreements	Create a data processing agreement.
DeleteDataProcessingAgreementById	DELETE /v1/data-agreements/{id}	Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
GetDataProcessingAgreementById	GET /v1/data-agreements/{id}	Get data processing agreement by id.
GetDataProcessingAgreements	GET /v1/data-agreements	Get paginated data processing agreements.
TerminateDataProcessingAgreementById	PUT /v1/data-agreements/{id}/terminate	Terminate a data processing agreement.
UpdateDataProcessingAgreement	PUT /v1/data-agreements/{id}	Update a data processing agreement.

# CreateDataProcessingAgreement

DataProcessingAgreement CreateDataProcessingAgreement (CreateDataProcessingAgreement createDataProcessingAgreement)

Create a data processing agreement.

# Example

using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;

namespace Example
{
    public class CreateDataProcessingAgreementExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mydatamyconsent.com";
            var apiInstance = new DataProcessingAgreementsApi(config);
            var createDataProcessingAgreement = new CreateDataProcessingAgreement(); // CreateDataProcessingAgreement | Create data processing agreement payload

            try
            {
                // Create a data processing agreement.
                DataProcessingAgreement result = apiInstance.CreateDataProcessingAgreement(createDataProcessingAgreement);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DataProcessingAgreementsApi.CreateDataProcessingAgreement: " + 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

# Parameters

Name	Type	Description	Notes
createDataProcessingAgreement	CreateDataProcessingAgreement	Create data processing agreement payload

# Return type

DataProcessingAgreement

# 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	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# DeleteDataProcessingAgreementById

void DeleteDataProcessingAgreementById (Guid id)

Delete a data processing agreement. This will not delete a published or a agreement in use with consents.

# Example

using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;

namespace Example
{
    public class DeleteDataProcessingAgreementByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mydatamyconsent.com";
            var apiInstance = new DataProcessingAgreementsApi(config);
            var id = "id_example";  // Guid | Agreement id.

            try
            {
                // Delete a data processing agreement. This will not delete a published or a agreement in use with consents.
                apiInstance.DeleteDataProcessingAgreementById(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DataProcessingAgreementsApi.DeleteDataProcessingAgreementById: " + 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

# Parameters

Name	Type	Description	Notes
id	Guid	Agreement id.

# Return type

void (empty response body)

# Authorization

No authorization required

# HTTP request headers

Content-Type: Not defined
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]

# GetDataProcessingAgreementById

DataProcessingAgreement GetDataProcessingAgreementById (Guid id)

Get data processing agreement by id.

# Example

using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;

namespace Example
{
    public class GetDataProcessingAgreementByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mydatamyconsent.com";
            var apiInstance = new DataProcessingAgreementsApi(config);
            var id = "id_example";  // Guid | Agreement id.

            try
            {
                // Get data processing agreement by id.
                DataProcessingAgreement result = apiInstance.GetDataProcessingAgreementById(id);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DataProcessingAgreementsApi.GetDataProcessingAgreementById: " + 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

# Parameters

Name	Type	Description	Notes
id	Guid	Agreement id.

# Return type

DataProcessingAgreement

# 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]

# GetDataProcessingAgreements

DataProcessingAgreementPaginatedList GetDataProcessingAgreements (int? pageNo = null, int? pageSize = null)

Get paginated data processing agreements.

# Example

using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;

namespace Example
{
    public class GetDataProcessingAgreementsExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mydatamyconsent.com";
            var apiInstance = new DataProcessingAgreementsApi(config);
            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 data processing agreements.
                DataProcessingAgreementPaginatedList result = apiInstance.GetDataProcessingAgreements(pageNo, pageSize);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DataProcessingAgreementsApi.GetDataProcessingAgreements: " + 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

# Parameters

Name	Type	Description	Notes
pageNo	int?	Page number.	[optional] [default to 1]
pageSize	int?	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

# HTTP response details

Status code	Description	Response headers
200	Success	-
400	Bad Request	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# TerminateDataProcessingAgreementById

void TerminateDataProcessingAgreementById (Guid id)

Terminate a data processing agreement.

# Example

using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;

namespace Example
{
    public class TerminateDataProcessingAgreementByIdExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mydatamyconsent.com";
            var apiInstance = new DataProcessingAgreementsApi(config);
            var id = "id_example";  // Guid | Agreement id.

            try
            {
                // Terminate a data processing agreement.
                apiInstance.TerminateDataProcessingAgreementById(id);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DataProcessingAgreementsApi.TerminateDataProcessingAgreementById: " + 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

# Parameters

Name	Type	Description	Notes
id	Guid	Agreement id.

# Return type

void (empty response body)

# Authorization

No authorization required

# HTTP request headers

Content-Type: Not defined
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]

# UpdateDataProcessingAgreement

DataProcessingAgreement UpdateDataProcessingAgreement (Guid id, UpdateDataProcessingAgreement updateDataProcessingAgreement)

Update a data processing agreement.

# Example

using System.Collections.Generic;
using System.Diagnostics;
using MyDataMyConsent.Api;
using MyDataMyConsent.Client;
using MyDataMyConsent.Models;

namespace Example
{
    public class UpdateDataProcessingAgreementExample
    {
        public static void Main()
        {
            Configuration config = new Configuration();
            config.BasePath = "https://api.mydatamyconsent.com";
            var apiInstance = new DataProcessingAgreementsApi(config);
            var id = "id_example";  // Guid | Agreement id.
            var updateDataProcessingAgreement = new UpdateDataProcessingAgreement(); // UpdateDataProcessingAgreement | Update data processing agreement payload

            try
            {
                // Update a data processing agreement.
                DataProcessingAgreement result = apiInstance.UpdateDataProcessingAgreement(id, updateDataProcessingAgreement);
                Debug.WriteLine(result);
            }
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling DataProcessingAgreementsApi.UpdateDataProcessingAgreement: " + 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

# Parameters

Name	Type	Description	Notes
id	Guid	Agreement id.
updateDataProcessingAgreement	UpdateDataProcessingAgreement	Update data processing agreement payload

# Return type

DataProcessingAgreement

# Authorization

No authorization required

# HTTP request headers

Content-Type: application/json
Accept: application/json

# HTTP response details

Status code	Description	Response headers
200	Success	-
404	Not Found	-
400	Bad Request	-
500	Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]