MyDataMyConsent::IndividualsApi

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

Method	HTTP request	Description
issuer_issuedoc1_xml_post	POST /issuer/issuedoc/1/xml	Digilocker compatible endpoint to issue document.
v1_individuals_consent_requests_get	GET /v1/individuals/consent-requests	Get all consent requests sent to Individuals.
v1_individuals_consent_requests_post	POST /v1/individuals/consent-requests	Create individual consent request.
v1_individuals_consent_requests_request_id_cancel_put	PUT /v1/individuals/consent-requests/{request_id}/cancel	Cancel the Individual data request by id.
v1_individuals_consent_requests_request_id_get	GET /v1/individuals/consent-requests/{request_id}	Get Individual data consent request by id.
v1_individuals_consent_templates_get	GET /v1/individuals/consent-templates	Get the paginated list of individual consent templates.
v1_individuals_consent_templates_template_id_get	GET /v1/individuals/consent-templates/{template_id}	Get Individual consent template details by consent id.
v1_individuals_consents_consent_id_documents_document_id_download_get	GET /v1/individuals/consents/{consent_id}/documents/{document_id}/download	Download Individual consented document by document id.
v1_individuals_consents_consent_id_documents_document_id_get	GET /v1/individuals/consents/{consent_id}/documents/{document_id}	Get Individual consented document by document id.
v1_individuals_consents_consent_id_documents_get	GET /v1/individuals/consents/{consent_id}/documents	Get Individual consented document by consent id.
v1_individuals_consents_consent_id_financial_accounts_account_id_get	GET /v1/individuals/consents/{consent_id}/financial-accounts/{account_id}	Get individual consented financial account details.
v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get	GET /v1/individuals/consents/{consent_id}/financial-accounts/{account_id}/transactions	Get individual consented financial account transactions.
v1_individuals_consents_consent_id_financial_accounts_get	GET /v1/individuals/consents/{consent_id}/financial-accounts	Get all individual consented financial accounts.
v1_individuals_consents_consent_id_get	GET /v1/individuals/consents/{consent_id}	Get Individuals consent details by consent id.
v1_individuals_consents_consent_id_health_fhir_bundle_get	GET /v1/individuals/consents/{consent_id}/health/fhir/bundle	Get Individual consented Health Records by consent id.
v1_individuals_consents_get	GET /v1/individuals/consents	Get the paginated list of Individual consents.
v1_individuals_documents_issue_issue_request_id_upload_post	POST /v1/individuals/documents/issue/{issue_request_id}/upload	Upload a document for issuance request of individual.
v1_individuals_documents_issue_post	POST /v1/individuals/documents/issue	Issue a new document to an individual user.
v1_individuals_documents_issued_document_id_get	GET /v1/individuals/documents/issued/{document_id}	Get issued document.
v1_individuals_documents_issued_get	GET /v1/individuals/documents/issued	Get paginated list of issued documents of given document type.
v1_individuals_documents_types_get	GET /v1/individuals/documents/types	Get paginated list of registered document types.

issuer_issuedoc1_xml_post

issuer_issuedoc1_xml_post(push_uri_request)

Digilocker compatible endpoint to issue document.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
push_uri_request = MyDataMyConsent::PushUriRequest.new({uri_details: MyDataMyConsent::UriDetails.new({aadhaar: 'aadhaar_example', uri: 'uri_example', doc_type: 'doc_type_example', doc_name: 'doc_name_example', doc_id: 'doc_id_example', issued_on: 'issued_on_example', valid_from: 'valid_from_example'})}) # PushUriRequest | 

begin
  # Digilocker compatible endpoint to issue document.
  result = api_instance.issuer_issuedoc1_xml_post(push_uri_request)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->issuer_issuedoc1_xml_post: #{e}"
end

Using the issuer_issuedoc1_xml_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> issuer_issuedoc1_xml_post_with_http_info(push_uri_request)

begin
  # Digilocker compatible endpoint to issue document.
  data, status_code, headers = api_instance.issuer_issuedoc1_xml_post_with_http_info(push_uri_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PushUriResponse>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->issuer_issuedoc1_xml_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
push_uri_request	PushUriRequest

Return type

PushUriResponse

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

v1_individuals_consent_requests_get

v1_individuals_consent_requests_get(opts)

Get all consent requests sent to Individuals.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
opts = {
  status: MyDataMyConsent::DataConsentStatus::PENDING, # DataConsentStatus | 
  from_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  to_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get all consent requests sent to Individuals.
  result = api_instance.v1_individuals_consent_requests_get(opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_get: #{e}"
end

Using the v1_individuals_consent_requests_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consent_requests_get_with_http_info(opts)

begin
  # Get all consent requests sent to Individuals.
  data, status_code, headers = api_instance.v1_individuals_consent_requests_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfIndividualConsentRequestDetailss>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_get_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
status	DataConsentStatus	[optional]
from_date_time	Time	[optional]
to_date_time	Time	[optional]
page_no	Integer	[optional]
page_size	Integer	[optional]

Return type

PaginatedListOfIndividualConsentRequestDetailss

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consent_requests_post

v1_individuals_consent_requests_post(create_consent_request)

Create individual consent request.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
create_consent_request = MyDataMyConsent::CreateConsentRequest.new({consent_template_id: 'consent_template_id_example', receiver: MyDataMyConsent::ConsentRequestReceiver.new({country_iso2_code: 'country_iso2_code_example', identifiers: [MyDataMyConsent::KeyValuePair.new({key: 'key_example', value: 'value_example'})], identification_strategy: MyDataMyConsent::IdentificationStrategy::MATCH_AT_LEAST_ONE_IDENTIFIER})}) # CreateConsentRequest | 

begin
  # Create individual consent request.
  result = api_instance.v1_individuals_consent_requests_post(create_consent_request)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_post: #{e}"
end

Using the v1_individuals_consent_requests_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consent_requests_post_with_http_info(create_consent_request)

begin
  # Create individual consent request.
  data, status_code, headers = api_instance.v1_individuals_consent_requests_post_with_http_info(create_consent_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IndividualConsentRequestDetails>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
create_consent_request	CreateConsentRequest

Return type

IndividualConsentRequestDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

v1_individuals_consent_requests_request_id_cancel_put

Boolean v1_individuals_consent_requests_request_id_cancel_put(request_id)

Cancel the Individual data request by id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
request_id = 'request_id_example' # String | 

begin
  # Cancel the Individual data request by id.
  result = api_instance.v1_individuals_consent_requests_request_id_cancel_put(request_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_request_id_cancel_put: #{e}"
end

Using the v1_individuals_consent_requests_request_id_cancel_put_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(Boolean, Integer, Hash)> v1_individuals_consent_requests_request_id_cancel_put_with_http_info(request_id)

begin
  # Cancel the Individual data request by id.
  data, status_code, headers = api_instance.v1_individuals_consent_requests_request_id_cancel_put_with_http_info(request_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => Boolean
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_request_id_cancel_put_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
request_id	String

Return type

Boolean

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consent_requests_request_id_get

v1_individuals_consent_requests_request_id_get(request_id)

Get Individual data consent request by id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
request_id = 'request_id_example' # String | 

begin
  # Get Individual data consent request by id.
  result = api_instance.v1_individuals_consent_requests_request_id_get(request_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_request_id_get: #{e}"
end

Using the v1_individuals_consent_requests_request_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consent_requests_request_id_get_with_http_info(request_id)

begin
  # Get Individual data consent request by id.
  data, status_code, headers = api_instance.v1_individuals_consent_requests_request_id_get_with_http_info(request_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ConsentRequest>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_requests_request_id_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
request_id	String

Return type

ConsentRequest

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consent_templates_get

v1_individuals_consent_templates_get(opts)

Get the paginated list of individual consent templates.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
opts = {
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get the paginated list of individual consent templates.
  result = api_instance.v1_individuals_consent_templates_get(opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_templates_get: #{e}"
end

Using the v1_individuals_consent_templates_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consent_templates_get_with_http_info(opts)

begin
  # Get the paginated list of individual consent templates.
  data, status_code, headers = api_instance.v1_individuals_consent_templates_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfConsentRequestTemplates>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_templates_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
page_no	Integer		[optional]
page_size	Integer		[optional]

Return type

PaginatedListOfConsentRequestTemplates

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consent_templates_template_id_get

v1_individuals_consent_templates_template_id_get(template_id)

Get Individual consent template details by consent id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
template_id = 'template_id_example' # String | 

begin
  # Get Individual consent template details by consent id.
  result = api_instance.v1_individuals_consent_templates_template_id_get(template_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_templates_template_id_get: #{e}"
end

Using the v1_individuals_consent_templates_template_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consent_templates_template_id_get_with_http_info(template_id)

begin
  # Get Individual consent template details by consent id.
  data, status_code, headers = api_instance.v1_individuals_consent_templates_template_id_get_with_http_info(template_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IndividualConsentRequestTemplateDetails>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consent_templates_template_id_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
template_id	String

Return type

IndividualConsentRequestTemplateDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_documents_document_id_download_get

File v1_individuals_consents_consent_id_documents_document_id_download_get(consent_id, document_id)

Download Individual consented document by document id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 
document_id = 'document_id_example' # String | 

begin
  # Download Individual consented document by document id.
  result = api_instance.v1_individuals_consents_consent_id_documents_document_id_download_get(consent_id, document_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_documents_document_id_download_get: #{e}"
end

Using the v1_individuals_consents_consent_id_documents_document_id_download_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(File, Integer, Hash)> v1_individuals_consents_consent_id_documents_document_id_download_get_with_http_info(consent_id, document_id)

begin
  # Download Individual consented document by document id.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_documents_document_id_download_get_with_http_info(consent_id, document_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => File
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_documents_document_id_download_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String
document_id	String

Return type

File

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/octet-stream, application/json; charset=utf-8

v1_individuals_consents_consent_id_documents_document_id_get

v1_individuals_consents_consent_id_documents_document_id_get(consent_id, document_id)

Get Individual consented document by document id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 
document_id = 'document_id_example' # String | 

begin
  # Get Individual consented document by document id.
  result = api_instance.v1_individuals_consents_consent_id_documents_document_id_get(consent_id, document_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_documents_document_id_get: #{e}"
end

Using the v1_individuals_consents_consent_id_documents_document_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consents_consent_id_documents_document_id_get_with_http_info(consent_id, document_id)

begin
  # Get Individual consented document by document id.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_documents_document_id_get_with_http_info(consent_id, document_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ConsentedDocument>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_documents_document_id_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String
document_id	String

Return type

ConsentedDocument

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_documents_get

<Array> v1_individuals_consents_consent_id_documents_get(consent_id)

Get Individual consented document by consent id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 

begin
  # Get Individual consented document by consent id.
  result = api_instance.v1_individuals_consents_consent_id_documents_get(consent_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_documents_get: #{e}"
end

Using the v1_individuals_consents_consent_id_documents_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> v1_individuals_consents_consent_id_documents_get_with_http_info(consent_id)

begin
  # Get Individual consented document by consent id.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_documents_get_with_http_info(consent_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<ConsentedDocument>>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_documents_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String

Return type

Array<ConsentedDocument>

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_financial_accounts_account_id_get

v1_individuals_consents_consent_id_financial_accounts_account_id_get(consent_id, account_id)

Get individual consented financial account details.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 
account_id = 'account_id_example' # String | 

begin
  # Get individual consented financial account details.
  result = api_instance.v1_individuals_consents_consent_id_financial_accounts_account_id_get(consent_id, account_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_financial_accounts_account_id_get: #{e}"
end

Using the v1_individuals_consents_consent_id_financial_accounts_account_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consents_consent_id_financial_accounts_account_id_get_with_http_info(consent_id, account_id)

begin
  # Get individual consented financial account details.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_financial_accounts_account_id_get_with_http_info(consent_id, account_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FinancialAccount>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_financial_accounts_account_id_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String
account_id	String

Return type

FinancialAccount

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get

v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get(consent_id, account_id, opts)

Get individual consented financial account transactions.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 
account_id = 'account_id_example' # String | 
opts = {
  from_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  to_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get individual consented financial account transactions.
  result = api_instance.v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get(consent_id, account_id, opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get: #{e}"
end

Using the v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get_with_http_info(consent_id, account_id, opts)

begin
  # Get individual consented financial account transactions.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get_with_http_info(consent_id, account_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfFinancialAccountTransactions>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_financial_accounts_account_id_transactions_get_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
consent_id	String
account_id	String
from_date_time	Time	[optional]
to_date_time	Time	[optional]
page_no	Integer	[optional]
page_size	Integer	[optional]

Return type

PaginatedListOfFinancialAccountTransactions

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_financial_accounts_get

<Array> v1_individuals_consents_consent_id_financial_accounts_get(consent_id)

Get all individual consented financial accounts.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 

begin
  # Get all individual consented financial accounts.
  result = api_instance.v1_individuals_consents_consent_id_financial_accounts_get(consent_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_financial_accounts_get: #{e}"
end

Using the v1_individuals_consents_consent_id_financial_accounts_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> v1_individuals_consents_consent_id_financial_accounts_get_with_http_info(consent_id)

begin
  # Get all individual consented financial accounts.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_financial_accounts_get_with_http_info(consent_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<FinancialAccount>>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_financial_accounts_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String

Return type

Array<FinancialAccount>

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_get

v1_individuals_consents_consent_id_get(consent_id)

Get Individuals consent details by consent id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 

begin
  # Get Individuals consent details by consent id.
  result = api_instance.v1_individuals_consents_consent_id_get(consent_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_get: #{e}"
end

Using the v1_individuals_consents_consent_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consents_consent_id_get_with_http_info(consent_id)

begin
  # Get Individuals consent details by consent id.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_get_with_http_info(consent_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ConsentDetails>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String

Return type

ConsentDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_consent_id_health_fhir_bundle_get

v1_individuals_consents_consent_id_health_fhir_bundle_get(consent_id)

Get Individual consented Health Records by consent id.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
consent_id = 'consent_id_example' # String | 

begin
  # Get Individual consented Health Records by consent id.
  result = api_instance.v1_individuals_consents_consent_id_health_fhir_bundle_get(consent_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_health_fhir_bundle_get: #{e}"
end

Using the v1_individuals_consents_consent_id_health_fhir_bundle_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consents_consent_id_health_fhir_bundle_get_with_http_info(consent_id)

begin
  # Get Individual consented Health Records by consent id.
  data, status_code, headers = api_instance.v1_individuals_consents_consent_id_health_fhir_bundle_get_with_http_info(consent_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FhirBundleany>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_consent_id_health_fhir_bundle_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
consent_id	String

Return type

FhirBundleany

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_consents_get

v1_individuals_consents_get(opts)

Get the paginated list of Individual consents.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
opts = {
  status: MyDataMyConsent::DataConsentStatus::PENDING, # DataConsentStatus | 
  from_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  to_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get the paginated list of Individual consents.
  result = api_instance.v1_individuals_consents_get(opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_get: #{e}"
end

Using the v1_individuals_consents_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_consents_get_with_http_info(opts)

begin
  # Get the paginated list of Individual consents.
  data, status_code, headers = api_instance.v1_individuals_consents_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfConsents>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_consents_get_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
status	DataConsentStatus	[optional]
from_date_time	Time	[optional]
to_date_time	Time	[optional]
page_no	Integer	[optional]
page_size	Integer	[optional]

Return type

PaginatedListOfConsents

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_documents_issue_issue_request_id_upload_post

v1_individuals_documents_issue_issue_request_id_upload_post(issue_request_id, file)

Upload a document for issuance request of individual.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
issue_request_id = 'issue_request_id_example' # String | 
file = File.new('/path/to/some/file') # File | 

begin
  # Upload a document for issuance request of individual.
  result = api_instance.v1_individuals_documents_issue_issue_request_id_upload_post(issue_request_id, file)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issue_issue_request_id_upload_post: #{e}"
end

Using the v1_individuals_documents_issue_issue_request_id_upload_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_documents_issue_issue_request_id_upload_post_with_http_info(issue_request_id, file)

begin
  # Upload a document for issuance request of individual.
  data, status_code, headers = api_instance.v1_individuals_documents_issue_issue_request_id_upload_post_with_http_info(issue_request_id, file)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <UploadDocumentResponse>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issue_issue_request_id_upload_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
issue_request_id	String
file	File

Return type

UploadDocumentResponse

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json; charset=utf-8

v1_individuals_documents_issue_post

v1_individuals_documents_issue_post(document_issue_request)

Issue a new document to an individual user.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
document_issue_request = MyDataMyConsent::DocumentIssueRequest.new({document_type_id: 'document_type_id_example', identifier: 'identifier_example', description: 'description_example', receiver: MyDataMyConsent::DocumentIssueRequestReceiver.new({country_iso2_code: 'country_iso2_code_example', identifiers: [MyDataMyConsent::KeyValuePair.new({key: 'key_example', value: 'value_example'})], identification_strategy: MyDataMyConsent::IdentificationStrategy::MATCH_AT_LEAST_ONE_IDENTIFIER}), issued_at_utc: Time.now, valid_from_utc: Time.now}) # DocumentIssueRequest | 

begin
  # Issue a new document to an individual user.
  result = api_instance.v1_individuals_documents_issue_post(document_issue_request)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issue_post: #{e}"
end

Using the v1_individuals_documents_issue_post_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_documents_issue_post_with_http_info(document_issue_request)

begin
  # Issue a new document to an individual user.
  data, status_code, headers = api_instance.v1_individuals_documents_issue_post_with_http_info(document_issue_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DocumentIssueRequestDetails>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issue_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
document_issue_request	DocumentIssueRequest

Return type

DocumentIssueRequestDetails

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

v1_individuals_documents_issued_document_id_get

v1_individuals_documents_issued_document_id_get(document_id)

Get issued document.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
document_id = 'document_id_example' # String | 

begin
  # Get issued document.
  result = api_instance.v1_individuals_documents_issued_document_id_get(document_id)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issued_document_id_get: #{e}"
end

Using the v1_individuals_documents_issued_document_id_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_documents_issued_document_id_get_with_http_info(document_id)

begin
  # Get issued document.
  data, status_code, headers = api_instance.v1_individuals_documents_issued_document_id_get_with_http_info(document_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <IssuedDocument>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issued_document_id_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
document_id	String

Return type

IssuedDocument

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_documents_issued_get

v1_individuals_documents_issued_get(document_type_id, opts)

Get paginated list of issued documents of given document type.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
document_type_id = 'document_type_id_example' # String | 
opts = {
  from_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  to_date_time: Time.parse('2013-10-20T19:20:30+01:00'), # Time | 
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get paginated list of issued documents of given document type.
  result = api_instance.v1_individuals_documents_issued_get(document_type_id, opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issued_get: #{e}"
end

Using the v1_individuals_documents_issued_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_documents_issued_get_with_http_info(document_type_id, opts)

begin
  # Get paginated list of issued documents of given document type.
  data, status_code, headers = api_instance.v1_individuals_documents_issued_get_with_http_info(document_type_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfIssuedDocuments>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_issued_get_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
document_type_id	String
from_date_time	Time	[optional]
to_date_time	Time	[optional]
page_no	Integer	[optional]
page_size	Integer	[optional]

Return type

PaginatedListOfIssuedDocuments

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

v1_individuals_documents_types_get

v1_individuals_documents_types_get(opts)

Get paginated list of registered document types.

Examples

require 'time'
require 'mydatamyconsent'
# setup authorization
MyDataMyConsent.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = MyDataMyConsent::IndividualsApi.new
opts = {
  page_no: 56, # Integer | 
  page_size: 56 # Integer | 
}

begin
  # Get paginated list of registered document types.
  result = api_instance.v1_individuals_documents_types_get(opts)
  p result
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_types_get: #{e}"
end

Using the v1_individuals_documents_types_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> v1_individuals_documents_types_get_with_http_info(opts)

begin
  # Get paginated list of registered document types.
  data, status_code, headers = api_instance.v1_individuals_documents_types_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedListOfDocumentTypes>
rescue MyDataMyConsent::ApiError => e
  puts "Error when calling IndividualsApi->v1_individuals_documents_types_get_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
page_no	Integer		[optional]
page_size	Integer		[optional]

Return type

PaginatedListOfDocumentTypes

Authorization

OAuth2ClientCredentials

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

Uh oh!

FilesExpand file tree

IndividualsApi.md

Latest commit

History

IndividualsApi.md

File metadata and controls

MyDataMyConsent::IndividualsApi

issuer_issuedoc1_xml_post

Examples

Using the issuer_issuedoc1_xml_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consent_requests_get

Examples

Using the v1_individuals_consent_requests_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consent_requests_post

Examples

Using the v1_individuals_consent_requests_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consent_requests_request_id_cancel_put

Examples

Using the v1_individuals_consent_requests_request_id_cancel_put_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consent_requests_request_id_get

Examples

Using the v1_individuals_consent_requests_request_id_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consent_templates_get

Examples

Using the v1_individuals_consent_templates_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consent_templates_template_id_get

Examples

Using the v1_individuals_consent_templates_template_id_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consents_consent_id_documents_document_id_download_get

Examples

Using the v1_individuals_consents_consent_id_documents_document_id_download_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consents_consent_id_documents_document_id_get

Examples

Using the v1_individuals_consents_consent_id_documents_document_id_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consents_consent_id_documents_get

Examples

Using the v1_individuals_consents_consent_id_documents_get_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

v1_individuals_consents_consent_id_financial_accounts_account_id_get

Examples