Skip to content

Latest commit

 

History

History
713 lines (457 loc) · 23.9 KB

ObjectEzsigndocumentApi.md

File metadata and controls

713 lines (457 loc) · 23.9 KB
Raw

eZmaxAPI\ObjectEzsigndocumentApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
EzsigndocumentApplyEzsigntemplateV1 Post /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate Apply an Ezsign Template to the Ezsigndocument.
EzsigndocumentApplyEzsigntemplateV2 Post /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate Apply an Ezsign Template to the Ezsigndocument.
EzsigndocumentCreateObjectV1 Post /1/object/ezsigndocument Create a new Ezsigndocument
EzsigndocumentDeleteObjectV1 Delete /1/object/ezsigndocument/{pkiEzsigndocumentID} Delete an existing Ezsigndocument
EzsigndocumentGetChildrenV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID}/getChildren Retrieve an existing Ezsigndocument's children IDs
EzsigndocumentGetDownloadUrlV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType} Retrieve a URL to download documents.
EzsigndocumentGetEzsignpagesV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages Retrieve an existing Ezsigndocument's Ezsignpages
EzsigndocumentGetFormDataV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData Retrieve an existing Ezsigndocument's Form Data
EzsigndocumentGetObjectV1 Get /1/object/ezsigndocument/{pkiEzsigndocumentID} Retrieve an existing Ezsigndocument
EzsigndocumentGetWordsPositionsV1 Post /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions Retrieve positions X,Y of given words from a Ezsigndocument

EzsigndocumentApplyEzsigntemplateV1

EzsigndocumentApplyEzsigntemplateV1Response EzsigndocumentApplyEzsigntemplateV1(ctx, pkiEzsigndocumentID).EzsigndocumentApplyEzsigntemplateV1Request(ezsigndocumentApplyEzsigntemplateV1Request).Execute()

Apply an Ezsign Template to the Ezsigndocument.

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 
    ezsigndocumentApplyEzsigntemplateV1Request := *openapiclient.NewEzsigndocumentApplyEzsigntemplateV1Request(int32(36), []string{"John"}, []int32{int32(20)}) // EzsigndocumentApplyEzsigntemplateV1Request | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentApplyEzsigntemplateV1(context.Background(), pkiEzsigndocumentID).EzsigndocumentApplyEzsigntemplateV1Request(ezsigndocumentApplyEzsigntemplateV1Request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentApplyEzsigntemplateV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentApplyEzsigntemplateV1`: EzsigndocumentApplyEzsigntemplateV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentApplyEzsigntemplateV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

ezsigndocumentApplyEzsigntemplateV1Request | EzsigndocumentApplyEzsigntemplateV1Request | |

Return type

EzsigndocumentApplyEzsigntemplateV1Response

Authorization

Authorization

HTTP request headers

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

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

EzsigndocumentApplyEzsigntemplateV2

EzsigndocumentApplyEzsigntemplateV2Response EzsigndocumentApplyEzsigntemplateV2(ctx, pkiEzsigndocumentID).EzsigndocumentApplyEzsigntemplateV2Request(ezsigndocumentApplyEzsigntemplateV2Request).Execute()

Apply an Ezsign Template to the Ezsigndocument.

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 
    ezsigndocumentApplyEzsigntemplateV2Request := *openapiclient.NewEzsigndocumentApplyEzsigntemplateV2Request(int32(36), []string{"John"}, []int32{int32(20)}) // EzsigndocumentApplyEzsigntemplateV2Request | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentApplyEzsigntemplateV2(context.Background(), pkiEzsigndocumentID).EzsigndocumentApplyEzsigntemplateV2Request(ezsigndocumentApplyEzsigntemplateV2Request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentApplyEzsigntemplateV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentApplyEzsigntemplateV2`: EzsigndocumentApplyEzsigntemplateV2Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentApplyEzsigntemplateV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

ezsigndocumentApplyEzsigntemplateV2Request | EzsigndocumentApplyEzsigntemplateV2Request | |

Return type

EzsigndocumentApplyEzsigntemplateV2Response

Authorization

Authorization

HTTP request headers

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

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

EzsigndocumentCreateObjectV1

EzsigndocumentCreateObjectV1Response EzsigndocumentCreateObjectV1(ctx).EzsigndocumentCreateObjectV1Request(ezsigndocumentCreateObjectV1Request).Execute()

Create a new Ezsigndocument

Example

package main

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

func main() {
    ezsigndocumentCreateObjectV1Request := []openapiclient.EzsigndocumentCreateObjectV1Request{*openapiclient.NewEzsigndocumentCreateObjectV1Request()} // []EzsigndocumentCreateObjectV1Request | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentCreateObjectV1(context.Background()).EzsigndocumentCreateObjectV1Request(ezsigndocumentCreateObjectV1Request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentCreateObjectV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentCreateObjectV1`: EzsigndocumentCreateObjectV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentCreateObjectV1`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
ezsigndocumentCreateObjectV1Request []EzsigndocumentCreateObjectV1Request

Return type

EzsigndocumentCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

EzsigndocumentDeleteObjectV1

EzsigndocumentDeleteObjectV1Response EzsigndocumentDeleteObjectV1(ctx, pkiEzsigndocumentID).Execute()

Delete an existing Ezsigndocument

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentDeleteObjectV1(context.Background(), pkiEzsigndocumentID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentDeleteObjectV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentDeleteObjectV1`: EzsigndocumentDeleteObjectV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentDeleteObjectV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

Return type

EzsigndocumentDeleteObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EzsigndocumentGetChildrenV1

EzsigndocumentGetChildrenV1(ctx, pkiEzsigndocumentID).Execute()

Retrieve an existing Ezsigndocument's children IDs

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentGetChildrenV1(context.Background(), pkiEzsigndocumentID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentGetChildrenV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EzsigndocumentGetDownloadUrlV1

EzsigndocumentGetDownloadUrlV1Response EzsigndocumentGetDownloadUrlV1(ctx, pkiEzsigndocumentID, eDocumentType).Execute()

Retrieve a URL to download documents.

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 
    eDocumentType := "eDocumentType_example" // string | The type of document to retrieve.  1. **Initial** Is the initial document before any signature were applied. 2. **Signed** Is the final document once all signatures were applied. 3. **Proofdocument** Is the evidence report. 4. **Proof** Is the complete evidence archive including all of the above and more. 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentGetDownloadUrlV1(context.Background(), pkiEzsigndocumentID, eDocumentType).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentGetDownloadUrlV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentGetDownloadUrlV1`: EzsigndocumentGetDownloadUrlV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentGetDownloadUrlV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32
eDocumentType string The type of document to retrieve. 1. Initial Is the initial document before any signature were applied. 2. Signed Is the final document once all signatures were applied. 3. Proofdocument Is the evidence report. 4. Proof Is the complete evidence archive including all of the above and more.

Other Parameters

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

Name Type Description Notes

Return type

EzsigndocumentGetDownloadUrlV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EzsigndocumentGetEzsignpagesV1

EzsigndocumentGetEzsignpagesV1Response EzsigndocumentGetEzsignpagesV1(ctx, pkiEzsigndocumentID).Execute()

Retrieve an existing Ezsigndocument's Ezsignpages

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentGetEzsignpagesV1(context.Background(), pkiEzsigndocumentID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentGetEzsignpagesV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentGetEzsignpagesV1`: EzsigndocumentGetEzsignpagesV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentGetEzsignpagesV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

Return type

EzsigndocumentGetEzsignpagesV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EzsigndocumentGetFormDataV1

EzsigndocumentGetFormDataV1Response EzsigndocumentGetFormDataV1(ctx, pkiEzsigndocumentID).Execute()

Retrieve an existing Ezsigndocument's Form Data

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentGetFormDataV1(context.Background(), pkiEzsigndocumentID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentGetFormDataV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentGetFormDataV1`: EzsigndocumentGetFormDataV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentGetFormDataV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

Return type

EzsigndocumentGetFormDataV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/zip, text/csv

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

EzsigndocumentGetObjectV1

EzsigndocumentGetObjectV1Response EzsigndocumentGetObjectV1(ctx, pkiEzsigndocumentID).Execute()

Retrieve an existing Ezsigndocument

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentGetObjectV1(context.Background(), pkiEzsigndocumentID).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentGetObjectV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentGetObjectV1`: EzsigndocumentGetObjectV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentGetObjectV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

Return type

EzsigndocumentGetObjectV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

EzsigndocumentGetWordsPositionsV1

EzsigndocumentGetWordsPositionsV1Response EzsigndocumentGetWordsPositionsV1(ctx, pkiEzsigndocumentID).EzsigndocumentGetWordsPositionsV1Request(ezsigndocumentGetWordsPositionsV1Request).Execute()

Retrieve positions X,Y of given words from a Ezsigndocument

Example

package main

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

func main() {
    pkiEzsigndocumentID := int32(56) // int32 | 
    ezsigndocumentGetWordsPositionsV1Request := *openapiclient.NewEzsigndocumentGetWordsPositionsV1Request("EGet_example", false) // EzsigndocumentGetWordsPositionsV1Request | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.ObjectEzsigndocumentApi.EzsigndocumentGetWordsPositionsV1(context.Background(), pkiEzsigndocumentID).EzsigndocumentGetWordsPositionsV1Request(ezsigndocumentGetWordsPositionsV1Request).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ObjectEzsigndocumentApi.EzsigndocumentGetWordsPositionsV1``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `EzsigndocumentGetWordsPositionsV1`: EzsigndocumentGetWordsPositionsV1Response
    fmt.Fprintf(os.Stdout, "Response from `ObjectEzsigndocumentApi.EzsigndocumentGetWordsPositionsV1`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pkiEzsigndocumentID int32

Other Parameters

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

Name Type Description Notes

ezsigndocumentGetWordsPositionsV1Request | EzsigndocumentGetWordsPositionsV1Request | |

Return type

EzsigndocumentGetWordsPositionsV1Response

Authorization

Authorization

HTTP request headers

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

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