My Data My Consent - Developer Documentation

# \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(ctx, documentId).Execute()

Get issued document.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    documentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Document id.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.GetIssuedDocumentById(context.Background(), documentId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.GetIssuedDocumentById``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIssuedDocumentById`: IssuedDocumentDetails
    fmt.Fprintf(os.Stdout, "Response from `DocumentsApi.GetIssuedDocumentById`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
documentId string Document id.

# Other Parameters

Other parameters are passed through a pointer to a apiGetIssuedDocumentByIdRequest struct via the builder pattern

Name Type Description Notes

# Return type

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

IssuedDocumentPaginatedList GetIssuedDocuments(ctx).DocumentTypeId(documentTypeId).FromDateTime(fromDateTime).ToDateTime(toDateTime).PageNo(pageNo).PageSize(pageSize).Execute()

Get paginated list of issued documents of given document type.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    documentTypeId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Document type id. (optional)
    fromDateTime := time.Now() // time.Time | From DateTime in UTC timezone. (optional)
    toDateTime := time.Now() // time.Time | To DateTime in UTC timezone. (optional)
    pageNo := int32(56) // int32 | Page number. (optional) (default to 1)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.GetIssuedDocuments(context.Background()).DocumentTypeId(documentTypeId).FromDateTime(fromDateTime).ToDateTime(toDateTime).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.GetIssuedDocuments``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIssuedDocuments`: IssuedDocumentPaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DocumentsApi.GetIssuedDocuments`: %v\n", resp)
}
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

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiGetIssuedDocumentsRequest struct via the builder pattern

Name Type Description Notes
documentTypeId string Document type id.
fromDateTime time.Time From DateTime in UTC timezone.
toDateTime time.Time To DateTime in UTC timezone.
pageNo int32 Page number. [default to 1]
pageSize int32 Number of items to return. [default to 25]

# Return type

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

DocumentTypePaginatedList GetRegisteredDocumentTypes(ctx).SupportedEntityType(supportedEntityType).PageNo(pageNo).PageSize(pageSize).Execute()

Get paginated list of registered document types.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    supportedEntityType := openapiclient.SupportedEntityType("Individual") // SupportedEntityType | Supported entity type. (optional)
    pageNo := int32(56) // int32 | Page number. (optional) (default to 1)
    pageSize := int32(56) // int32 | Number of items to return. (optional) (default to 25)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.GetRegisteredDocumentTypes(context.Background()).SupportedEntityType(supportedEntityType).PageNo(pageNo).PageSize(pageSize).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.GetRegisteredDocumentTypes``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetRegisteredDocumentTypes`: DocumentTypePaginatedList
    fmt.Fprintf(os.Stdout, "Response from `DocumentsApi.GetRegisteredDocumentTypes`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiGetRegisteredDocumentTypesRequest struct via the builder pattern

Name Type Description Notes
supportedEntityType SupportedEntityType Supported entity type.
pageNo int32 Page number. [default to 1]
pageSize int32 Number of items to return. [default to 25]

# Return type

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

DocumentIssueRequestDetails IssueDocumentToIndividual(ctx).DocumentIssueRequest(documentIssueRequest).Execute()

Issue a new document to an individual user.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    documentIssueRequest := *openapiclient.NewDocumentIssueRequest("DocumentTypeId_example", "GJ05FG67866586.", "Description_example", *openapiclient.NewDocumentReceiver("CountryIso2Code_example", []openapiclient.StringStringKeyValuePair{*openapiclient.NewStringStringKeyValuePair()}, openapiclient.IdentificationStrategy("MatchAtLeastOneIdentifier")), time.Now(), time.Now()) // DocumentIssueRequest | Document issue request payload

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.IssueDocumentToIndividual(context.Background()).DocumentIssueRequest(documentIssueRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.IssueDocumentToIndividual``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IssueDocumentToIndividual`: DocumentIssueRequestDetails
    fmt.Fprintf(os.Stdout, "Response from `DocumentsApi.IssueDocumentToIndividual`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiIssueDocumentToIndividualRequest struct via the builder pattern

Name Type Description Notes
documentIssueRequest DocumentIssueRequest Document issue request payload

# Return type

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

DocumentIssueRequestDetails IssueDocumentToOrganization(ctx).DocumentIssueRequest(documentIssueRequest).Execute()

Issue a new document to an organization.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    "time"
    openapiclient "./openapi"
)

func main() {
    documentIssueRequest := *openapiclient.NewDocumentIssueRequest("DocumentTypeId_example", "GJ05FG67866586.", "Description_example", *openapiclient.NewDocumentReceiver("CountryIso2Code_example", []openapiclient.StringStringKeyValuePair{*openapiclient.NewStringStringKeyValuePair()}, openapiclient.IdentificationStrategy("MatchAtLeastOneIdentifier")), time.Now(), time.Now()) // DocumentIssueRequest | Document issue request payload

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.IssueDocumentToOrganization(context.Background()).DocumentIssueRequest(documentIssueRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.IssueDocumentToOrganization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `IssueDocumentToOrganization`: DocumentIssueRequestDetails
    fmt.Fprintf(os.Stdout, "Response from `DocumentsApi.IssueDocumentToOrganization`: %v\n", resp)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

# Path Parameters

# Other Parameters

Other parameters are passed through a pointer to a apiIssueDocumentToOrganizationRequest struct via the builder pattern

Name Type Description Notes
documentIssueRequest DocumentIssueRequest Document issue request payload

# Return type

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(ctx, issueRequestId).FormFile(formFile).Execute()

Upload a document for issuance request of individual.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    issueRequestId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Document issue request id.
    formFile := os.NewFile(1234, "some_file") // *os.File | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.UploadDocumentForIndividual(context.Background(), issueRequestId).FormFile(formFile).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.UploadDocumentForIndividual``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
issueRequestId string Document issue request id.

# Other Parameters

Other parameters are passed through a pointer to a apiUploadDocumentForIndividualRequest struct via the builder pattern

Name Type Description Notes

formFile | *os.File | |

# Return type

(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(ctx, issueRequestId).FormFile(formFile).Execute()

Upload a document for issuance request of organization.

# Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    issueRequestId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Document issue request id System.Guid.
    formFile := os.NewFile(1234, "some_file") // *os.File | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.DocumentsApi.UploadDocumentForOrganization(context.Background(), issueRequestId).FormFile(formFile).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DocumentsApi.UploadDocumentForOrganization``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

# Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
issueRequestId string Document issue request id System.Guid.

# Other Parameters

Other parameters are passed through a pointer to a apiUploadDocumentForOrganizationRequest struct via the builder pattern

Name Type Description Notes

formFile | *os.File | |

# Return type

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

Last Updated: 6/19/2022, 7:27:56 PM