Skip to content

Latest commit

 

History

History
383 lines (264 loc) · 16 KB

ObjectEzsigntemplatepackageAPI.md

File metadata and controls

383 lines (264 loc) · 16 KB

ObjectEzsigntemplatepackageAPI

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

Method HTTP request Description
ezsigntemplatepackageCreateObjectV1 POST /1/object/ezsigntemplatepackage Create a new Ezsigntemplatepackage
ezsigntemplatepackageDeleteObjectV1 DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Delete an existing Ezsigntemplatepackage
ezsigntemplatepackageEditEzsigntemplatepackagesignersV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners Edit multiple Ezsigntemplatepackagesigners
ezsigntemplatepackageEditObjectV1 PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Edit an existing Ezsigntemplatepackage
ezsigntemplatepackageGetAutocompleteV2 GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector} Retrieve Ezsigntemplatepackages and IDs
ezsigntemplatepackageGetListV1 GET /1/object/ezsigntemplatepackage/getList Retrieve Ezsigntemplatepackage list
ezsigntemplatepackageGetObjectV2 GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID} Retrieve an existing Ezsigntemplatepackage

ezsigntemplatepackageCreateObjectV1

    open class func ezsigntemplatepackageCreateObjectV1(ezsigntemplatepackageCreateObjectV1Request: EzsigntemplatepackageCreateObjectV1Request, completion: @escaping (_ data: EzsigntemplatepackageCreateObjectV1Response?, _ error: Error?) -> Void)

Create a new Ezsigntemplatepackage

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 ezsigntemplatepackageCreateObjectV1Request = ezsigntemplatepackage-createObject-v1-Request(aObjEzsigntemplatepackage: [ezsigntemplatepackage-RequestCompound(pkiEzsigntemplatepackageID: 123, fkiEzsignfoldertypeID: 123, fkiLanguageID: 123, sEzsigntemplatepackageDescription: "sEzsigntemplatepackageDescription_example", bEzsigntemplatepackageAdminonly: false, bEzsigntemplatepackageIsactive: true)]) // EzsigntemplatepackageCreateObjectV1Request | 

// Create a new Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageCreateObjectV1(ezsigntemplatepackageCreateObjectV1Request: ezsigntemplatepackageCreateObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
ezsigntemplatepackageCreateObjectV1Request EzsigntemplatepackageCreateObjectV1Request

Return type

EzsigntemplatepackageCreateObjectV1Response

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]

ezsigntemplatepackageDeleteObjectV1

    open class func ezsigntemplatepackageDeleteObjectV1(pkiEzsigntemplatepackageID: Int, completion: @escaping (_ data: EzsigntemplatepackageDeleteObjectV1Response?, _ error: Error?) -> Void)

Delete an existing Ezsigntemplatepackage

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 pkiEzsigntemplatepackageID = 987 // Int | 

// Delete an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageDeleteObjectV1(pkiEzsigntemplatepackageID: pkiEzsigntemplatepackageID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID Int

Return type

EzsigntemplatepackageDeleteObjectV1Response

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]

ezsigntemplatepackageEditEzsigntemplatepackagesignersV1

    open class func ezsigntemplatepackageEditEzsigntemplatepackagesignersV1(pkiEzsigntemplatepackageID: Int, ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request, completion: @escaping (_ data: EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response?, _ error: Error?) -> Void)

Edit multiple Ezsigntemplatepackagesigners

Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time.

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 pkiEzsigntemplatepackageID = 987 // Int | 
let ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request = ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Request(aObjEzsigntemplatepackagesigner: [ezsigntemplatepackagesigner-RequestCompound(pkiEzsigntemplatepackagesignerID: 123, fkiEzsigntemplatepackageID: 123, sEzsigntemplatepackagesignerDescription: "sEzsigntemplatepackagesignerDescription_example")]) // EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request | 

// Edit multiple Ezsigntemplatepackagesigners
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageEditEzsigntemplatepackagesignersV1(pkiEzsigntemplatepackageID: pkiEzsigntemplatepackageID, ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request: ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID Int
ezsigntemplatepackageEditEzsigntemplatepackagesignersV1Request EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Request

Return type

EzsigntemplatepackageEditEzsigntemplatepackagesignersV1Response

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]

ezsigntemplatepackageEditObjectV1

    open class func ezsigntemplatepackageEditObjectV1(pkiEzsigntemplatepackageID: Int, ezsigntemplatepackageEditObjectV1Request: EzsigntemplatepackageEditObjectV1Request, completion: @escaping (_ data: EzsigntemplatepackageEditObjectV1Response?, _ error: Error?) -> Void)

Edit an existing Ezsigntemplatepackage

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 pkiEzsigntemplatepackageID = 987 // Int | 
let ezsigntemplatepackageEditObjectV1Request = ezsigntemplatepackage-editObject-v1-Request(objEzsigntemplatepackage: ezsigntemplatepackage-RequestCompound(pkiEzsigntemplatepackageID: 123, fkiEzsignfoldertypeID: 123, fkiLanguageID: 123, sEzsigntemplatepackageDescription: "sEzsigntemplatepackageDescription_example", bEzsigntemplatepackageAdminonly: false, bEzsigntemplatepackageIsactive: true)) // EzsigntemplatepackageEditObjectV1Request | 

// Edit an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageEditObjectV1(pkiEzsigntemplatepackageID: pkiEzsigntemplatepackageID, ezsigntemplatepackageEditObjectV1Request: ezsigntemplatepackageEditObjectV1Request) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID Int
ezsigntemplatepackageEditObjectV1Request EzsigntemplatepackageEditObjectV1Request

Return type

EzsigntemplatepackageEditObjectV1Response

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]

ezsigntemplatepackageGetAutocompleteV2

    open class func ezsigntemplatepackageGetAutocompleteV2(sSelector: SSelector_ezsigntemplatepackageGetAutocompleteV2, eFilterActive: EFilterActive_ezsigntemplatepackageGetAutocompleteV2? = nil, sQuery: String? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, completion: @escaping (_ data: EzsigntemplatepackageGetAutocompleteV2Response?, _ error: Error?) -> Void)

Retrieve Ezsigntemplatepackages and IDs

Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control.

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 sSelector = "sSelector_example" // String | The type of Ezsigntemplatepackages to return
let eFilterActive = "eFilterActive_example" // String | Specify which results we want to display. (optional) (default to .active)
let sQuery = "sQuery_example" // String | Allow to filter the returned results (optional)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)

// Retrieve Ezsigntemplatepackages and IDs
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageGetAutocompleteV2(sSelector: sSelector, eFilterActive: eFilterActive, sQuery: sQuery, acceptLanguage: acceptLanguage) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
sSelector String The type of Ezsigntemplatepackages to return
eFilterActive String Specify which results we want to display. [optional] [default to .active]
sQuery String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional]

Return type

EzsigntemplatepackageGetAutocompleteV2Response

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]

ezsigntemplatepackageGetListV1

    open class func ezsigntemplatepackageGetListV1(eOrderBy: EOrderBy_ezsigntemplatepackageGetListV1? = nil, iRowMax: Int? = nil, iRowOffset: Int? = nil, acceptLanguage: HeaderAcceptLanguage? = nil, sFilter: String? = nil, completion: @escaping (_ data: EzsigntemplatepackageGetListV1Response?, _ error: Error?) -> Void)

Retrieve Ezsigntemplatepackage list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eEzsigntemplatepackageType | Company
Team
User
Usergroup |

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 eOrderBy = "eOrderBy_example" // String | Specify how you want the results to be sorted (optional)
let iRowMax = 987 // Int |  (optional)
let iRowOffset = 987 // Int |  (optional) (default to 0)
let acceptLanguage = Header-Accept-Language() // HeaderAcceptLanguage |  (optional)
let sFilter = "sFilter_example" // String |  (optional)

// Retrieve Ezsigntemplatepackage list
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageGetListV1(eOrderBy: eOrderBy, iRowMax: iRowMax, iRowOffset: iRowOffset, acceptLanguage: acceptLanguage, sFilter: sFilter) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax Int [optional]
iRowOffset Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter String [optional]

Return type

EzsigntemplatepackageGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

ezsigntemplatepackageGetObjectV2

    open class func ezsigntemplatepackageGetObjectV2(pkiEzsigntemplatepackageID: Int, completion: @escaping (_ data: EzsigntemplatepackageGetObjectV2Response?, _ error: Error?) -> Void)

Retrieve an existing Ezsigntemplatepackage

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 pkiEzsigntemplatepackageID = 987 // Int | 

// Retrieve an existing Ezsigntemplatepackage
ObjectEzsigntemplatepackageAPI.ezsigntemplatepackageGetObjectV2(pkiEzsigntemplatepackageID: pkiEzsigntemplatepackageID) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pkiEzsigntemplatepackageID Int

Return type

EzsigntemplatepackageGetObjectV2Response

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]