Skip to content

Latest commit

 

History

History
214 lines (143 loc) · 6.75 KB

ObjectSignatureAPI.md

File metadata and controls

214 lines (143 loc) · 6.75 KB
Raw

ObjectSignatureAPI

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

Method HTTP request Description
signatureCreateObjectV1 POST /1/object/signature Create a new Signature
signatureDeleteObjectV1 DELETE /1/object/signature/{pkiSignatureID} Delete an existing Signature
signatureEditObjectV1 PUT /1/object/signature/{pkiSignatureID} Edit an existing Signature
signatureGetObjectV2 GET /2/object/signature/{pkiSignatureID} Retrieve an existing Signature

signatureCreateObjectV1

    open class func signatureCreateObjectV1(signatureCreateObjectV1Request: SignatureCreateObjectV1Request, completion: @escaping (_ data: SignatureCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Signature

The endpoint allows to create one or many elements at once.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let signatureCreateObjectV1Request = signature-createObject-v1-Request(aObjSignature: [signature-RequestCompound(pkiSignatureID: 123, tSignatureSvg: "tSignatureSvg_example")]) // SignatureCreateObjectV1Request | 

// Create a new Signature
ObjectSignatureAPI.signatureCreateObjectV1(signatureCreateObjectV1Request: signatureCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
signatureCreateObjectV1Request SignatureCreateObjectV1Request

Return type

SignatureCreateObjectV1Response

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]

signatureDeleteObjectV1

    open class func signatureDeleteObjectV1(pkiSignatureID: Int, completion: @escaping (_ data: SignatureDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Signature

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiSignatureID = 987 // Int | The unique ID of the Signature

// Delete an existing Signature
ObjectSignatureAPI.signatureDeleteObjectV1(pkiSignatureID: pkiSignatureID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiSignatureID Int The unique ID of the Signature

Return type

SignatureDeleteObjectV1Response

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]

signatureEditObjectV1

    open class func signatureEditObjectV1(pkiSignatureID: Int, signatureEditObjectV1Request: SignatureEditObjectV1Request, completion: @escaping (_ data: SignatureEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Signature

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiSignatureID = 987 // Int | The unique ID of the Signature
let signatureEditObjectV1Request = signature-editObject-v1-Request(objSignature: signature-RequestCompound(pkiSignatureID: 123, tSignatureSvg: "tSignatureSvg_example")) // SignatureEditObjectV1Request | 

// Edit an existing Signature
ObjectSignatureAPI.signatureEditObjectV1(pkiSignatureID: pkiSignatureID, signatureEditObjectV1Request: signatureEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiSignatureID Int The unique ID of the Signature
signatureEditObjectV1Request SignatureEditObjectV1Request

Return type

SignatureEditObjectV1Response

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]

signatureGetObjectV2

    open class func signatureGetObjectV2(pkiSignatureID: Int, completion: @escaping (_ data: SignatureGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Signature

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import OpenAPIClient

let pkiSignatureID = 987 // Int | The unique ID of the Signature

// Retrieve an existing Signature
ObjectSignatureAPI.signatureGetObjectV2(pkiSignatureID: pkiSignatureID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiSignatureID Int The unique ID of the Signature

Return type

SignatureGetObjectV2Response

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]