{
"openapi": "3.0.3",
"info": {
"title": "eZmax API Definition (Full)",
"version": "1.1.18",
"description": "This API expose all the functionnalities for the eZmax and eZsign applications.",
"termsOfService": "https://www.ezmax.ca/TODO",
"contact": {
"name": "API Support department",
"url": "https://www.ezmax.ca/en/contact",
"email": "support-api@ezmax.ca"
},
"license": {
"name": "MIT License",
"url": "https://opensource.org/licenses/MIT"
},
"x-logo": {
"url": "https://github.com/eZmaxinc/eZmax-API/raw/master/docs/resources/images/logo.png",
"backgroundColor": "#fafafa",
"altText": "eZmax Logo"
},
"x-restgeninfo": []
},
"servers": [
{
"url": "https://{sInfrastructureenvironmenttypeDescription}.api.appcluster01.{sInfrastructureregionCode}.ezmax.com/rest",
"description": "The server endpoint where to send your region specific API requests.",
"variables": {
"sInfrastructureenvironmenttypeDescription": {
"enum": [
"prod",
"stg",
"qa",
"dev"
],
"default": "prod",
"description": "The environment on on which to call the API. Should always be \"prod\" unless instructed otherwise by support."
},
"sInfrastructureregionCode": {
"enum": [
"ca-central-1"
],
"default": "ca-central-1",
"description": "The region where your services are hosted."
}
}
},
{
"url": "https://{sInfrastructureenvironmenttypeDescription}.api.global.ezmax.com",
"description": "The server endpoint where to send your global API requests.",
"variables": {
"sInfrastructureenvironmenttypeDescription": {
"enum": [
"prod",
"stg",
"qa",
"dev"
],
"default": "prod",
"description": "The environment on on which to call the API. Should always be \"prod\" unless instructed otherwise by support."
}
}
},
{
"url": "wss://ws.{sInfrastructureregionCode}.ezmax.com/{sInfrastructureenvironmenttypeDescription}",
"description": "The server endpoint where to send your websocket requests.",
"variables": {
"sInfrastructureenvironmenttypeDescription": {
"enum": [
"prod",
"stg",
"qa",
"dev"
],
"default": "prod",
"description": "The environment on on which to call the API. Should always be \"prod\" unless instructed otherwise by support."
},
"sInfrastructureregionCode": {
"enum": [
"ca-central-1"
],
"default": "ca-central-1",
"description": "The region where your services are hosted."
}
}
}
],
"paths": {
"/1/customer/{pksCustomerCode}/endpoint": {
"description": "",
"get": {
"tags": [
"Global_Customer"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/global-customer-getEndpoint-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"deprecated": true,
"security": [
{}
],
"operationId": "Global_Customer_GetEndpoint_V1",
"summary": "Get customer endpoint",
"description": "Retrieve the customer's specific server endpoint where to send requests. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored.",
"x-presentations": [],
"x-permissions": [],
"x-usertypeextra": [],
"x-apikeyrequire": false,
"x-authorizationsources": [
"NoAuthorization"
]
},
"parameters": [
{
"name": "pksCustomerCode",
"schema": {
"$ref": "#/components/schemas/Field-pksCustomerCode"
},
"in": "path",
"required": true
},
{
"name": "sInfrastructureproductCode",
"description": "The infrastructure product Code\n\nIf undefined, \"appcluster01\" is assumed",
"schema": {
"enum": [
"appcluster01",
"ezsignuser"
],
"type": "string"
},
"in": "query",
"required": false
}
]
},
"/1/ezmaxclient/{pksEzmaxclientOs}/version": {
"description": "",
"get": {
"tags": [
"Global_Ezmaxclient"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/global-ezmaxclient-version-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{}
],
"operationId": "Global_Ezmaxclient_Version_V1",
"summary": "Retrieve the latest version of the Ezmaxclient",
"description": "Retrieve the latest version of the Ezmaxclient that is available on the store.",
"x-presentations": [],
"x-permissions": [],
"x-usertypeextra": [],
"x-apikeyrequire": false,
"x-authorizationsources": [
"NoAuthorization"
]
},
"parameters": [
{
"name": "pksEzmaxclientOs",
"schema": {
"$ref": "#/components/schemas/Field-pksEzmaxclientOs"
},
"in": "path",
"required": true
}
]
},
"/1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration": {
"description": "",
"get": {
"tags": [
"Global_Ezmaxcustomer"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/global-ezmaxcustomer-getConfiguration-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{}
],
"operationId": "Global_Ezmaxcustomer_GetConfiguration_V1",
"summary": "Get ezmaxcustomer configuration",
"description": "Retrieve the ezmaxcustomer's specific configuration. This will help locate the proper region (ie: sInfrastructureregionCode) and the proper environment (ie: sInfrastructureenvironmenttypeDescription) where the customer's data is stored.",
"x-presentations": [],
"x-permissions": [],
"x-usertypeextra": [],
"x-apikeyrequire": false,
"x-authorizationsources": [
"NoAuthorization"
]
},
"parameters": [
{
"name": "pksEzmaxcustomerCode",
"schema": {
"$ref": "#/components/schemas/Field-pksEzmaxcustomerCode"
},
"in": "path",
"required": true
}
]
},
"/1/module/ezsign/suggestSigners": {
"get": {
"tags": [
"Module_Ezsign"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsign-suggestSigners-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsign_SuggestSigners_V1",
"summary": "Suggest signers",
"description": "Retrieve previously used Ezsignsigners and all users from the system",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/module/ezsign/suggestTemplates": {
"get": {
"tags": [
"Module_Ezsign"
],
"parameters": [
{
"name": "fkiEzsignfoldertypeID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"in": "query"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsign-suggestTemplates-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsign_SuggestTemplates_V1",
"summary": "Suggest templates",
"description": "Retrieve Ezsigntemplates and Ezsigntemplatepackages that can be imported in a Ezsignfolder",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/module/report/getReportFromCache/{sReportgroupCacheID}": {
"get": {
"tags": [
"Module_Report"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-getReport-v1-Response"
}
},
"application/pdf": {
"schema": {
"$ref": "#/components/schemas/File-Pdf"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/File-Zip"
}
},
"text/html": {
"schema": {
"$ref": "#/components/schemas/File-Html"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Presigned": [],
"Authorization": []
}
],
"operationId": "Report_GetReportFromCache_V1",
"summary": "Retrieve report from cache",
"description": "Retrieve a report that was previously generated and cached",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sReportgroupCacheID",
"schema": {
"$ref": "#/components/schemas/Field-sReportgroupCacheID"
},
"in": "path",
"required": true
}
]
},
"/1/module/user/createezsignuser": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/user-createEzsignuser-v1-Request"
}
}
}
},
"required": true
},
"tags": [
"Module_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-createEzsignuser-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_CreateEzsignuser_V1",
"summary": "Create a new User of type Ezsignuser",
"description": "The endpoint allows to initiate the creation or a user of type Ezsignuser.\n\nThe user will be created only once the email verification process will be completed",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"ElectronicSignatureConfiguration_CreateeZsignuser"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/activesession/getCurrent": {
"description": "",
"get": {
"tags": [
"Object_Activesession"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/activesession-getCurrent-v1-Response"
}
}
},
"description": "OK"
},
"350": {
"$ref": "#/components/responses/Response-Redirect-350"
},
"351": {
"$ref": "#/components/responses/Response-Redirect-351"
},
"352": {
"$ref": "#/components/responses/Response-Redirect-352"
},
"353": {
"$ref": "#/components/responses/Response-Redirect-353"
},
"354": {
"$ref": "#/components/responses/Response-Redirect-354"
},
"355": {
"$ref": "#/components/responses/Response-Redirect-355"
},
"356": {
"$ref": "#/components/responses/Response-Redirect-356"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Activesession_GetCurrent_V1",
"summary": "Get Current Activesession",
"description": "Retrieve the details about the current activesession",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/activesession/getList": {
"description": "",
"get": {
"tags": [
"Object_Activesession"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiActivesessionID_ASC",
"pkiActivesessionID_DESC",
"fkiUserID_ASC",
"fkiUserID_DESC",
"fkiComputerID_ASC",
"fkiComputerID_DESC",
"fkiCompanyID_ASC",
"fkiCompanyID_DESC",
"fkiDepartmentID_ASC",
"fkiDepartmentID_DESC",
"sCompanyNameX_ASC",
"sCompanyNameX_DESC",
"sDepartmentNameX_ASC",
"sDepartmentNameX_DESC",
"sActivesessionLoginname_ASC",
"sActivesessionLoginname_DESC",
"sComputerDescription_ASC",
"sComputerDescription_DESC",
"dtActivesessionFirsthit_ASC",
"dtActivesessionFirsthit_DESC",
"dtActivesessionLasthit_ASC",
"dtActivesessionLasthit_DESC",
"sActivesessionIP_ASC",
"sActivesessionIP_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/activesession-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Activesession_GetList_V1",
"summary": "Retrieve Activesession list",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-usertypeextra": [],
"x-presentations": [],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
]
}
},
"/2/object/apikey": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-createObject-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Apikey"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-createObject-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_CreateObject_V2",
"summary": "Create a new Apikey",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_APIKeyGeneration"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/apikey/{pkiApikeyID}": {
"description": "",
"get": {
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_GetObject_V2",
"summary": "Retrieve an existing Apikey",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_APIKeyGeneration"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiApikeyID",
"description": "The unique ID of the Apikey",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/{pkiApikeyID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_EditObject_V1",
"summary": "Edit an existing Apikey",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_APIKeyGeneration"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiApikeyID",
"description": "The unique ID of the Apikey",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/{pkiApikeyID}/editPermissions": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-editPermissions-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-editPermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_EditPermissions_V1",
"summary": "Edit multiple Permissions",
"description": "Using this endpoint, you can edit multiple Permissions at the same time.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiApikeyID",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/{pkiApikeyID}/getCors": {
"description": "",
"get": {
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-getCors-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_GetCors_V1",
"summary": "Retrieve an existing Apikey's cors",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiApikeyID",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/{pkiApikeyID}/getPermissions": {
"description": "",
"get": {
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-getPermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_GetPermissions_V1",
"summary": "Retrieve an existing Apikey's Permissions",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiApikeyID",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/{pkiApikeyID}/getSubnets": {
"description": "",
"get": {
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-getSubnets-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_GetSubnets_V1",
"summary": "Retrieve an existing Apikey's subnets",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiApikeyID",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/{pkiApikeyID}/regenerate": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-regenerate-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Apikey"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-regenerate-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_Regenerate_V1",
"summary": "Regenerate the Apikey",
"description": "",
"x-presentations": [],
"x-permissions": [
"Management_APIKeyGeneration"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiApikeyID",
"schema": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"in": "path",
"required": true
}
]
},
"/1/object/apikey/getList": {
"description": "",
"get": {
"tags": [
"Object_Apikey"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiApikeyID_ASC",
"pkiApikeyID_DESC",
"sApikeyDescriptionX_ASC",
"sApikeyDescriptionX_DESC",
"bApikeyIssigned_ASC",
"bApikeyIssigned_DESC",
"bApikeyIsactive_ASC",
"bApikeyIsactive_DESC",
"sUserFirstname_ASC",
"sUserFirstname_DESC",
"sUserLastname_ASC",
"sUserLastname_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/apikey-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Apikey_GetList_V1",
"summary": "Retrieve Apikey list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_APIKeyGeneration"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/billingentityexternal/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Billingentityexternal"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityexternal-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Billingentityexternal_GetAutocomplete_V2",
"summary": "Retrieve Billingentityexternals and IDs",
"description": "Get the list of Billingentityexternal to be used in a dropdown or autocomplete control.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"EzmaxInvoicing_Access"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Billingentityexternals to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/billingentityinternal": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Billingentityinternal"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Billingentityinternal_CreateObject_V1",
"summary": "Create a new Billingentityinternal",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/billingentityinternal/{pkiBillingentityinternalID}": {
"description": "",
"get": {
"tags": [
"Object_Billingentityinternal"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Billingentityinternal_GetObject_V2",
"summary": "Retrieve an existing Billingentityinternal",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiBillingentityinternalID",
"schema": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"in": "path",
"required": true
}
]
},
"/1/object/billingentityinternal/{pkiBillingentityinternalID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Billingentityinternal"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Billingentityinternal_EditObject_V1",
"summary": "Edit an existing Billingentityinternal",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiBillingentityinternalID",
"schema": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"in": "path",
"required": true
}
]
},
"/2/object/billingentityinternal/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Billingentityinternal"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Billingentityinternal_GetAutocomplete_V2",
"summary": "Retrieve Billingentityinternals and IDs",
"description": "Get the list of Billingentityinternal to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"EzmaxInvoicing_Access",
"ElectronicSignature_CreationModificationFolderTypes"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Billingentityinternals to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/billingentityinternal/getList": {
"description": "",
"get": {
"tags": [
"Object_Billingentityinternal"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiBillingentityinternalID_ASC",
"pkiBillingentityinternalID_DESC",
"sBillingentityinternalDescriptionX_ASC",
"sBillingentityinternalDescriptionX_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billingentityinternal-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Billingentityinternal_GetList_V1",
"summary": "Retrieve Billingentityinternal list",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/1/object/branding": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Branding"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Branding_CreateObject_V1",
"summary": "Create a new Branding",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Branding_CreationModification"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/branding/{pkiBrandingID}": {
"description": "",
"get": {
"tags": [
"Object_Branding"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Branding_GetObject_V2",
"summary": "Retrieve an existing Branding",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Branding_CreationModification"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiBrandingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"in": "path",
"required": true
}
]
},
"/1/object/branding/{pkiBrandingID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Branding"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Branding_EditObject_V1",
"summary": "Edit an existing Branding",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Branding_CreationModification"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiBrandingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"in": "path",
"required": true
}
]
},
"/2/object/branding/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Branding"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Branding_GetAutocomplete_V2",
"summary": "Retrieve Brandings and IDs",
"description": "Get the list of Branding to be used in a dropdown or autocomplete control.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Brandings to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/branding/getList": {
"description": "",
"get": {
"tags": [
"Object_Branding"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiBrandingID_ASC",
"pkiBrandingID_DESC",
"sBrandingDescriptionX_ASC",
"sBrandingDescriptionX_DESC",
"iBrandingColortext_ASC",
"iBrandingColortext_DESC",
"iBrandingColortextlinkbox_ASC",
"iBrandingColortextlinkbox_DESC",
"iBrandingColortextbutton_ASC",
"iBrandingColortextbutton_DESC",
"iBrandingColorbackground_ASC",
"iBrandingColorbackground_DESC",
"iBrandingColorbackgroundbutton_ASC",
"iBrandingColorbackgroundbutton_DESC",
"iBrandingColorbackgroundsmallbox_ASC",
"iBrandingColorbackgroundsmallbox_DESC",
"bBrandingIsactive_ASC",
"bBrandingIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/branding-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Branding_GetList_V1",
"summary": "Retrieve Branding list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eBrandingLogo | Default<br>JPEG<br>PNG |",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Branding_CreationModification"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/clonehistory/getList": {
"description": "",
"get": {
"tags": [
"Object_Clonehistory"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiClonehistoryID_ASC",
"pkiClonehistoryID_DESC",
"fkiUserIDCloning_ASC",
"fkiUserIDCloning_DESC",
"fkiUserIDCloned_ASC",
"fkiUserIDCloned_DESC",
"dtClonehistoryFirsthit_ASC",
"dtClonehistoryFirsthit_DESC",
"dtClonehistoryLasthit_ASC",
"dtClonehistoryLasthit_DESC",
"sUserLoginnameCloning_ASC",
"sUserLoginnameCloning_DESC",
"sUserFirstnameCloning_ASC",
"sUserFirstnameCloning_DESC",
"sUserLastnameCloning_ASC",
"sUserLastnameCloning_DESC",
"sUserLoginnameCloned_ASC",
"sUserLoginnameCloned_DESC",
"sUserFirstnameCloned_ASC",
"sUserFirstnameCloned_DESC",
"sUserLastnameCloned_ASC",
"sUserLastnameCloned_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/clonehistory-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Clonehistory_GetList_V1",
"summary": "Retrieve Clonehistory list",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"AgentBroker",
"Assistant"
],
"x-presentations": []
}
},
"/2/object/communication/{pkiCommunicationID}": {
"description": "",
"get": {
"tags": [
"Object_Communication"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/communication-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Communication_GetObject_V2",
"summary": "Retrieve an existing Communication",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiCommunicationID",
"schema": {
"$ref": "#/components/schemas/Field-pkiCommunicationID"
},
"in": "path",
"required": true
}
]
},
"/2/object/company/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Company"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/company-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Company_GetAutocomplete_V2",
"summary": "Retrieve Companys and IDs",
"description": "Get the list of Company to be used in a dropdown or autocomplete control.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Companys to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/cors": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cors-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Cors"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cors-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Cors_CreateObject_V1",
"summary": "Create a new Cors",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/cors/{pkiCorsID}": {
"description": "",
"get": {
"tags": [
"Object_Cors"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cors-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Cors_GetObject_V2",
"summary": "Retrieve an existing Cors",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiCorsID",
"description": "The unique ID of the Cors",
"schema": {
"$ref": "#/components/schemas/Field-pkiCorsID"
},
"in": "path",
"required": true
}
]
},
"/1/object/cors/{pkiCorsID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cors-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Cors"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cors-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Cors_EditObject_V1",
"summary": "Edit an existing Cors",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"delete": {
"tags": [
"Object_Cors"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/cors-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Cors_DeleteObject_V1",
"summary": "Delete an existing Cors",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiCorsID",
"description": "The unique ID of the Cors",
"schema": {
"$ref": "#/components/schemas/Field-pkiCorsID"
},
"in": "path",
"required": true
}
]
},
"/2/object/department/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Department"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/department-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Department_GetAutocomplete_V2",
"summary": "Retrieve Departments and IDs",
"description": "Get the list of Department to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Departments to return",
"schema": {
"enum": [
"All",
"AllButDepartmentZero",
"Company",
"CompanyButDepartmentZero"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/emailtype/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Emailtype"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/emailtype-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Emailtype_GetAutocomplete_V2",
"summary": "Retrieve Emailtypes and IDs",
"description": "Get the list of Emailtype to be used in a dropdown or autocomplete control.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"AgentBroker"
],
"x-presentations": []
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Emailtypes to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}": {
"get": {
"tags": [
"Object_Ezmaxinvoicing"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezmaxinvoicing-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezmaxinvoicing_GetObject_V2",
"summary": "Retrieve an existing Ezmaxinvoicing",
"description": "",
"x-presentations": [],
"x-permissions": [
"EzmaxInvoicing_Access"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzmaxinvoicingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezmaxinvoicing/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezmaxinvoicing"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezmaxinvoicing-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezmaxinvoicing_GetAutocomplete_V2",
"summary": "Retrieve Ezmaxinvoicings and IDs",
"description": "Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezmaxinvoicings to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezmaxinvoicing/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezmaxinvoicing"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display. Active is the default value.",
"schema": {
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-getAutocomplete-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezmaxinvoicing_GetAutocomplete_V1",
"summary": "Retrieve Ezmaxinvoicings and IDs",
"description": "Get the list of Ezmaxinvoicing to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezmaxinvoicings to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezmaxinvoicing/getProvisional": {
"description": "",
"get": {
"tags": [
"Object_Ezmaxinvoicing"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezmaxinvoicing-getProvisional-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezmaxinvoicing_GetProvisional_V1",
"summary": "Retrieve provisional Ezmaxinvoicing",
"description": "",
"x-presentations": [],
"x-permissions": [
"EzmaxInvoicing_Access",
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezmaxproduct/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezmaxproduct"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezmaxproduct-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezmaxproduct_GetAutocomplete_V2",
"summary": "Retrieve Ezmaxproducts and IDs",
"description": "Get the list of Ezmaxproduct to be used in a dropdown or autocomplete control.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"EzmaxInvoicing_Access",
"Management_Billingentities"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezmaxproducts to return",
"schema": {
"enum": [
"All",
"Entitydefault",
"Entityother"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_CreateObject_V1",
"summary": "Create a new Ezsignbulksend",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignbulksend/{pkiEzsignbulksendID}": {
"get": {
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_GetObject_V2",
"summary": "Retrieve an existing Ezsignbulksend",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_EditObject_V1",
"summary": "Edit an existing Ezsignbulksend",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_DeleteObject_V1",
"summary": "Delete an existing Ezsignbulksend",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-createEzsignbulksendtransmission-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-createEzsignbulksendtransmission-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_CreateEzsignbulksendtransmission_V1",
"summary": "Create a new Ezsignbulksendtransmission in the Ezsignbulksend",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate": {
"get": {
"tags": [
"Object_Ezsignbulksend"
],
"parameters": [
{
"name": "eCsvSeparator",
"description": "Separator that will be used to separate fields",
"schema": {
"enum": [
"Comma",
"Semicolon"
],
"type": "string"
},
"in": "query",
"required": true
}
],
"responses": {
"200": {
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/File-Csv"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_GetCsvTemplate_V1",
"summary": "Retrieve an existing Ezsignbulksend's empty Csv template",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions": {
"get": {
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-getEzsignbulksendtransmissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_GetEzsignbulksendtransmissions_V1",
"summary": "Retrieve an existing Ezsignbulksend's Ezsignbulksendtransmissions",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic": {
"get": {
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-getEzsignsignaturesAutomatic-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_GetEzsignsignaturesAutomatic_V1",
"summary": "Retrieve an existing Ezsignbulksend's automatic Ezsignsignatures",
"description": "Return the Ezsignsignatures that can be signed by the current user at the current step in the process",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData": {
"get": {
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-getFormsData-v1-Response"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/File-Zip"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_GetFormsData_V1",
"summary": "Retrieve an existing Ezsignbulksend's forms data",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-reorder-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignbulksend"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-reorder-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_Reorder_V1",
"summary": "Reorder Ezsignbulksenddocumentmappings in the Ezsignbulksend",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksend/getList": {
"description": "",
"get": {
"tags": [
"Object_Ezsignbulksend"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiEzsignbulksendID_ASC",
"pkiEzsignbulksendID_DESC",
"fkiEzsignfoldertypeID_ASC",
"fkiEzsignfoldertypeID_DESC",
"sEzsignbulksendDescription_ASC",
"sEzsignbulksendDescription_DESC",
"sEzsignfoldertypeNameX_ASC",
"sEzsignfoldertypeNameX_DESC",
"eEzsignfoldertypePrivacylevel_ASC",
"eEzsignfoldertypePrivacylevel_DESC",
"bEzsignbulksendNeedvalidation_ASC",
"bEzsignbulksendNeedvalidation_DESC",
"iEzsignbulksendtransmission_ASC",
"iEzsignbulksendtransmission_DESC",
"iEzsignfolder_ASC",
"iEzsignfolder_DESC",
"iEzsigndocument_ASC",
"iEzsigndocument_DESC",
"iEzsignsignature_ASC",
"iEzsignsignature_DESC",
"iEzsignsignatureSigned_ASC",
"iEzsignsignatureSigned_DESC",
"bEzsignbulksendIsactive_ASC",
"bEzsignbulksendIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksend-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksend_GetList_V1",
"summary": "Retrieve Ezsignbulksend list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eEzsignfoldertypePrivacylevel | User<br>Usergroup |",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignbulksenddocumentmapping": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignbulksenddocumentmapping"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksenddocumentmapping_CreateObject_V1",
"summary": "Create a new Ezsignbulksenddocumentmapping",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}": {
"get": {
"tags": [
"Object_Ezsignbulksenddocumentmapping"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksenddocumentmapping_GetObject_V2",
"summary": "Retrieve an existing Ezsignbulksenddocumentmapping",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksenddocumentmappingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksenddocumentmappingID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}": {
"description": "",
"delete": {
"tags": [
"Object_Ezsignbulksenddocumentmapping"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksenddocumentmapping_DeleteObject_V1",
"summary": "Delete an existing Ezsignbulksenddocumentmapping",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksenddocumentmappingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksenddocumentmappingID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksendsignermapping": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignbulksendsignermapping"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendsignermapping_CreateObject_V1",
"summary": "Create a new Ezsignbulksendsignermapping",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}": {
"get": {
"tags": [
"Object_Ezsignbulksendsignermapping"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendsignermapping_GetObject_V2",
"summary": "Retrieve an existing Ezsignbulksendsignermapping",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendsignermappingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendsignermappingID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}": {
"description": "",
"delete": {
"tags": [
"Object_Ezsignbulksendsignermapping"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendsignermapping_DeleteObject_V1",
"summary": "Delete an existing Ezsignbulksendsignermapping",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendsignermappingID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendsignermappingID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}": {
"get": {
"tags": [
"Object_Ezsignbulksendtransmission"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendtransmission_GetObject_V2",
"summary": "Retrieve an existing Ezsignbulksendtransmission",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendtransmissionID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendtransmissionID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors": {
"get": {
"tags": [
"Object_Ezsignbulksendtransmission"
],
"responses": {
"200": {
"content": {
"text/csv": {
"schema": {
"$ref": "#/components/schemas/File-Csv"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendtransmission_GetCsvErrors_V1",
"summary": "Retrieve an existing Ezsignbulksendtransmission's Csv containing errors",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendtransmissionID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendtransmissionID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic": {
"get": {
"tags": [
"Object_Ezsignbulksendtransmission"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-getEzsignsignaturesAutomatic-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendtransmission_GetEzsignsignaturesAutomatic_V1",
"summary": "Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures",
"description": "Return the Ezsignsignatures that can be signed by the current user at the current step in the process",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendtransmissionID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendtransmissionID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData": {
"get": {
"tags": [
"Object_Ezsignbulksendtransmission"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-getFormsData-v1-Response"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/File-Zip"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignbulksendtransmission_GetFormsData_V1",
"summary": "Retrieve an existing Ezsignbulksendtransmission's forms data",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignbulksendtransmissionID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendtransmissionID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsigndocument": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-createObject-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-createObject-v2-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422-sTemporaryFileUrl"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_CreateObject_V2",
"summary": "Create a new Ezsigndocument",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsigndocument": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigndocument-createObject-v1-Request"
}
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422-sTemporaryFileUrl"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_CreateObject_V1",
"summary": "Create a new Ezsigndocument",
"description": "The endpoint allows to create one or many elements at once.\n\nThe array can contain simple (Just the object) or compound (The object and its child) objects.\n\nCreating compound elements allows to reduce the multiple requests to create all child objects.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigndocument/{pkiEzsigndocumentID}": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetObject_V2",
"summary": "Retrieve an existing Ezsigndocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetObject_V1",
"summary": "Retrieve an existing Ezsigndocument",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_DeleteObject_V1",
"summary": "Delete an existing Ezsigndocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-patchObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-patchObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_PatchObject_V1",
"summary": "Patch an existing Ezsigndocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-applyEzsigntemplate-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-applyEzsigntemplate-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_ApplyEzsigntemplate_V2",
"summary": "Apply an Ezsigntemplate to the Ezsigndocument.",
"description": "This endpoint applies a predefined template to the ezsign document.\nThis allows to automatically apply all the form and signature fields on a document in a single step.\n\nThe document must not already have fields otherwise an error will be returned.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-applyEzsigntemplate-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-applyEzsigntemplate-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_ApplyEzsigntemplate_V1",
"summary": "Apply an Ezsigntemplate to the Ezsigndocument.",
"description": "This function is deprecated. Please use *applyEzsigntemplate* instead which is doing the same thing but with a capital \"E\" to normalize the nomenclature.\n\nThis endpoint applies a predefined template to the ezsign document.\nThis allows to automatically apply all the form and signature fields on a document in a single step.\n\nThe document must not already have fields otherwise an error will be returned.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-declineToSign-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-declineToSign-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_DeclineToSign_V1",
"summary": "Decline to sign",
"description": "Decline to sign",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner",
"AgentBroker"
],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-editEzsignformfieldgroups-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-editEzsignformfieldgroups-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_EditEzsignformfieldgroups_V1",
"summary": "Edit multiple Ezsignformfieldgroups",
"description": "Using this endpoint, you can edit multiple Ezsignformfieldgroups at the same time.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-editEzsignsignatures-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-editEzsignsignatures-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_EditEzsignsignatures_V1",
"summary": "Edit multiple Ezsignsignatures",
"description": "Using this endpoint, you can edit multiple Ezsignsignatures at the same time.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-endPrematurely-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-endPrematurely-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_EndPrematurely_V1",
"summary": "End prematurely",
"description": "End prematurely an Ezsigndocument when some signatures are still required",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-flatten-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-flatten-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_Flatten_V1",
"summary": "Flatten",
"description": "Flatten an Ezsigndocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getActionableElements-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetActionableElements_V1",
"summary": "Retrieve actionable elements for the Ezsigndocument",
"description": "Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getCompletedElements-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetCompletedElements_V1",
"summary": "Retrieve completed elements for the Ezsigndocument",
"description": "Return the completed Ezsignsignatures, Ezsignformfieldgroups and Ezsignannotations at the current step in the process",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"AgentBroker",
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getDownloadUrl/{eDocumentType}": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getDownloadUrl-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetDownloadUrl_V1",
"summary": "Retrieve a URL to download documents.",
"description": "This endpoint returns URLs to different files that can be downloaded during the signing process.\n\nThese links will expire after 5 minutes so the download of the file should be made soon after retrieving the link.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
},
{
"name": "eDocumentType",
"description": "The type of document to retrieve.\n\n1. **Initial** Is the initial document before any signature were applied.\n2. **Signed** Is the final document once all signatures were applied.\n3. **Proofdocument** Is the evidence report.\n4. **Proof** Is the complete evidence archive including all of the above and more.\n",
"schema": {
"enum": [
"Initial",
"Signed",
"Proof",
"Proofdocument"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignannotations-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetEzsignannotations_V1",
"summary": "Retrieve an existing Ezsigndocument's Ezsignannotations",
"description": "",
"x-usertypeextra": [
"EzsignSigner"
],
"x-presentations": [],
"x-permissions": [
"All"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignformfieldgroups-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetEzsignformfieldgroups_V1",
"summary": "Retrieve an existing Ezsigndocument's Ezsignformfieldgroups",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignpages-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetEzsignpages_V1",
"summary": "Retrieve an existing Ezsigndocument's Ezsignpages",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignsignatures-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetEzsignsignatures_V1",
"summary": "Retrieve an existing Ezsigndocument's Ezsignsignatures",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignsignaturesAutomatic-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetEzsignsignaturesAutomatic_V1",
"summary": "Retrieve an existing Ezsigndocument's automatic Ezsignsignatures",
"description": "Return the Ezsignsignatures that can be signed by the current user at the current step in the process",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getFormData-v1-Response"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/File-Zip"
}
},
"text/csv": {
"schema": {
"$ref": "#/components/schemas/File-Csv"
},
"examples": {
"Example": {
"value": "sep=,\n\"sEzsignformfieldgroupLabel.sEzsignformfieldLabel1\",\"sEzsignformfieldgroupLabel.sEzsignformfieldLabel2\",\"sEzsignformfieldgroupLabel.sEzsignformfieldLabel3\",\"sEzsignformfieldgroupLabel.sEzsignformfieldLabel4\"\n\"sEzsignformfieldValue01\",\"sEzsignformfieldValue02\",\"sEzsignformfieldValue03\",\"sEzsignformfieldValue04\"\n\"sEzsignformfieldValue11\",\"sEzsignformfieldValue12\",\"sEzsignformfieldValue13\",\"sEzsignformfieldValue14\"\n\"sEzsignformfieldValue21\",\"sEzsignformfieldValue22\",\"sEzsignformfieldValue23\",\"sEzsignformfieldValue24\""
}
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetFormData_V1",
"summary": "Retrieve an existing Ezsigndocument's Form Data",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof": {
"get": {
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getTemporaryProof-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetTemporaryProof_V1",
"summary": "Retrieve the temporary proof",
"description": "Retrieve the temporary proof while the Ezsigndocument is being processed since the proof isn't available until the Ezsigndocument is completed",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getWordsPositions-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-getWordsPositions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_GetWordsPositions_V1",
"summary": "Retrieve positions X,Y of given words from a Ezsigndocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-submitEzsignform-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-submitEzsignform-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422-EzsignformValidation"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_SubmitEzsignform_V1",
"summary": "Submit the Ezsignform",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner",
"AgentBroker"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-unsend-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigndocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigndocument-unsend-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigndocument_Unsend_V1",
"summary": "Unsend the Ezsigndocument",
"description": "Once an Ezsigndocument has been sent to signatories, it cannot be modified.\n\nUsing this endpoint, you can unsend the Ezsigndocument and make it modifiable again.\n\nSignatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign.\n\n⚠️ Warning: Any signature previously made by signatories on this Ezsigndocumentswill be lost.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigndocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsignfolder": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-createObject-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-createObject-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_CreateObject_V2",
"summary": "Create a new Ezsignfolder",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignfolder": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfolder-createObject-v1-Request"
}
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_CreateObject_V1",
"summary": "Create a new Ezsignfolder",
"description": "The endpoint allows to create one or many elements at once.\n\nThe array can contain simple (Just the object) or compound (The object and its child) objects.\n\nCreating compound elements allows to reduce the multiple requests to create all child objects.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignfolder/{pkiEzsignfolderID}": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetObject_V2",
"summary": "Retrieve an existing Ezsignfolder",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetObject_V1",
"summary": "Retrieve an existing Ezsignfolder",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_EditObject_V1",
"summary": "Edit an existing Ezsignfolder",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_DeleteObject_V1",
"summary": "Delete an existing Ezsignfolder",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/archive": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-archive-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-archive-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Archive_V1",
"summary": "Archive the Ezsignfolder",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-batchDownload-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/zip": {
"schema": {
"$ref": "#/components/schemas/File-Zip"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_BatchDownload_V1",
"summary": "Download multiples files from an Ezsignfolder",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/dispose": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-dispose-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-dispose-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Dispose_V1",
"summary": "Dispose the Ezsignfolder",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"ElectronicSignature_DisposalofeZsignfolders"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getActionableElements-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetActionableElements_V1",
"summary": "Retrieve actionable elements for the Ezsignfolder",
"description": "Return the Ezsignsignatures that can be signed and Ezsignformfieldgroups that can be filled by the current user at the current step in the process",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getCommunicationCount-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_getCommunicationCount_V1",
"summary": "Retrieve Communication count",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getCommunicationList-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_getCommunicationList_V1",
"summary": "Retrieve Communication list",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getEzsigndocuments-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetEzsigndocuments_V1",
"summary": "Retrieve an existing Ezsignfolder's Ezsigndocuments",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getEzsignfoldersignerassociations-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetEzsignfoldersignerassociations_V1",
"summary": "Retrieve an existing Ezsignfolder's Ezsignfoldersignerassociations",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociationsmine": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getEzsignfoldersignerassociationsmine-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetEzsignfoldersignerassociationsmine_V1",
"summary": "Retrieve your own Ezsignfoldersignerassociations from an existing Ezsignfolder",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getEzsignsignaturesAutomatic-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetEzsignsignaturesAutomatic_V1",
"summary": "Retrieve an existing Ezsignfolder's automatic Ezsignsignatures",
"description": "Return the Ezsignsignatures that can be signed by the current user at the current step in the process",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData": {
"get": {
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getFormsData-v1-Response"
}
},
"application/zip": {
"schema": {
"$ref": "#/components/schemas/File-Zip"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetFormsData_V1",
"summary": "Retrieve an existing Ezsignfolder's forms data",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-importEzsignfoldersignerassociations-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-importEzsignfoldersignerassociations-v1-Response"
}
}
},
"description": "Successful response"
},
"403": {
"$ref": "#/components/responses/Response-Error-403"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_ImportEzsignfoldersignerassociations_V1",
"summary": "Import an existing Ezsignfoldersignerassociation into this Ezsignfolder",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-importEzsigntemplatepackage-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-importEzsigntemplatepackage-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_ImportEzsigntemplatepackage_V1",
"summary": "Import an Ezsigntemplatepackage in the Ezsignfolder.",
"description": "This endpoint imports all of the Ezsigntemplates from the Ezsigntemplatepackage into the Ezsignfolder as Ezsigndocuments.\n\nThis allows to automatically apply all the Ezsigntemplateformfieldgroups and Ezsigntemplatesignatures on the newly created Ezsigndocuments in a single step.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/reorder": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-reorder-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-reorder-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Reorder_V1",
"summary": "Reorder Ezsigndocuments in the Ezsignfolder",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/3/object/ezsignfolder/{pkiEzsignfolderID}/send": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-send-v3-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-send-v3-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Send_V3",
"summary": "Send the Ezsignfolder to the signatories for signature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsignfolder/{pkiEzsignfolderID}/send": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-send-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-send-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Send_V2",
"summary": "Send the Ezsignfolder to the signatories for signature",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/send": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-send-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-send-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Send_V1",
"summary": "Send the Ezsignfolder to the signatories for signature",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/{pkiEzsignfolderID}/unsend": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-unsend-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-unsend-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_Unsend_V1",
"summary": "Unsend the Ezsignfolder",
"description": "Once an Ezsignfolder has been sent to signatories, it cannot be modified.\n\nUsing this endpoint, you can unsend the Ezsignfolder and make it modifiable again.\n\nSignatories will receive an email informing them the signature process was aborted and they might receive a new invitation to sign.\n\n⚠️ Warning: Any signature previously made by signatories on \"Non-completed\" Ezsigndocuments will be lost.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfolderID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfolder/disposeEzsignfolders": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-disposeEzsignfolders-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfolder"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-disposeEzsignfolders-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_DisposeEzsignfolders_V1",
"summary": "Dispose Ezsignfolders",
"description": "",
"x-presentations": [],
"x-permissions": [
"ElectronicSignature_DisposalofeZsignfolders"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignfolder/getList": {
"description": "",
"get": {
"tags": [
"Object_Ezsignfolder"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiEzsignfolderID_ASC",
"pkiEzsignfolderID_DESC",
"sEzsignfolderDescription_ASC",
"sEzsignfolderDescription_DESC",
"dtCreatedDate_ASC",
"dtCreatedDate_DESC",
"fkiEzsignfoldertypeID_ASC",
"fkiEzsignfoldertypeID_DESC",
"sEzsignfoldertypeNameX_ASC",
"sEzsignfoldertypeNameX_DESC",
"eEzsignfolderStep_ASC",
"eEzsignfolderStep_DESC",
"dtEzsignfolderSentdate_ASC",
"dtEzsignfolderSentdate_DESC",
"dtEzsignfolderDuedate_ASC",
"dtEzsignfolderDuedate_DESC",
"iEzsigndocument_ASC",
"iEzsigndocument_DESC",
"iEzsigndocumentEdm_ASC",
"iEzsigndocumentEdm_DESC",
"iEzsignsignature_ASC",
"iEzsignsignature_DESC",
"iEzsignsignatureSigned_ASC",
"iEzsignsignatureSigned_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfolder-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfolder_GetList_V1",
"summary": "Retrieve Ezsignfolder list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eEzsignfolderStep | Unsent<br>Sent<br>PartiallySigned<br>Expired<br>Completed<br>Archived<br>Disposed|\n| eEzsignfoldertypePrivacylevel | User<br>Usergroup |",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignfoldersignerassociation": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-createObject-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-createObject-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_CreateObject_V2",
"summary": "Create a new Ezsignfoldersignerassociation",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignfoldersignerassociation": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-createObject-v1-Request"
}
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_CreateObject_V1",
"summary": "Create a new Ezsignfoldersignerassociation",
"description": "The endpoint allows to create one or many elements at once.\n\nThe array can contain simple (Just the object) or compound (The object and its child) objects.\n\nCreating compound elements allows to reduce the multiple requests to create all child objects.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}": {
"get": {
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_GetObject_V2",
"summary": "Retrieve an existing Ezsignfoldersignerassociation",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfoldersignerassociationID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-getObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_GetObject_V1",
"summary": "Retrieve an existing Ezsignfoldersignerassociation",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_EditObject_V1",
"summary": "Edit an existing Ezsignfoldersignerassociation",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_DeleteObject_V1",
"summary": "Delete an existing Ezsignfoldersignerassociation",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-patchObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-patchObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_PatchObject_V1",
"summary": "Patch an existing Ezsignfoldersignerassociation",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfoldersignerassociationID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/forceDisconnect": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-forceDisconnect-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-forceDisconnect-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_ForceDisconnect_V1",
"summary": "Disconnects the Ezsignfoldersignerassociation",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfoldersignerassociationID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}/getInPersonLoginUrl": {
"get": {
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-getInPersonLoginUrl-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldersignerassociation_GetInPersonLoginUrl_V1",
"summary": "Retrieve a Login Url to allow In-Person signing",
"description": "This endpoint returns a Login Url that can be used in a browser or embedded in an I-Frame to allow in person signing.\n\nThe signer Login type must be configured as In-Person.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfoldersignerassociationID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldertype": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldertype"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldertype_CreateObject_V1",
"summary": "Create a new Ezsignfoldertype",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"ElectronicSignature_CreationModificationFolderTypes"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignfoldertype/{pkiEzsignfoldertypeID}": {
"get": {
"tags": [
"Object_Ezsignfoldertype"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldertype_GetObject_V2",
"summary": "Retrieve an existing Ezsignfoldertype",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfoldertypeID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignfoldertype"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldertype_EditObject_V1",
"summary": "Edit an existing Ezsignfoldertype",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"ElectronicSignature_CreationModificationFolderTypes"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignfoldertypeID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsignfoldertype/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezsignfoldertype"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldertype_GetAutocomplete_V2",
"summary": "Retrieve Ezsignfoldertypes and IDs",
"description": "Get the list of Ezsignfoldertype to be used in a dropdown or autocomplete control.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezsignfoldertypes to return",
"schema": {
"enum": [
"Active",
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldertype/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezsignfoldertype"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-getAutocomplete-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldertype_GetAutocomplete_V1",
"summary": "Retrieve Ezsignfoldertypes and IDs",
"description": "Get the list of Ezsignfoldertypes to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezsignfoldertypes to return",
"schema": {
"enum": [
"Active",
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignfoldertype/getList": {
"description": "",
"get": {
"tags": [
"Object_Ezsignfoldertype"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiEzsignfoldertypeID_ASC",
"pkiEzsignfoldertypeID_DESC",
"eEzsignfoldertypePrivacylevel_ASC",
"eEzsignfoldertypePrivacylevel_DESC",
"sEzsignfoldertypeNameX_ASC",
"sEzsignfoldertypeNameX_DESC",
"bEzsignfoldertypeIsactive_ASC",
"bEzsignfoldertypeIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignfoldertype-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignfoldertype_GetList_V1",
"summary": "Retrieve Ezsignfoldertype list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eEzsignfoldertypePrivacylevel | User<br>Usergroup |",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"ElectronicSignature_CreationModificationFolderTypes"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignformfieldgroup": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignformfieldgroup-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignformfieldgroup"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignformfieldgroup-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignformfieldgroup_CreateObject_V1",
"summary": "Create a new Ezsignformfieldgroup",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}": {
"get": {
"tags": [
"Object_Ezsignformfieldgroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignformfieldgroup-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignformfieldgroup_GetObject_V2",
"summary": "Retrieve an existing Ezsignformfieldgroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignformfieldgroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignformfieldgroup-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignformfieldgroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignformfieldgroup-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignformfieldgroup_EditObject_V1",
"summary": "Edit an existing Ezsignformfieldgroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsignformfieldgroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignformfieldgroup-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignformfieldgroup_DeleteObject_V1",
"summary": "Delete an existing Ezsignformfieldgroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignformfieldgroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignpage/{pkiEzsignpageID}/consult": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignpage-consult-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignpage"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignpage-consult-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignpage_Consult_V1",
"summary": "Consult an Ezsignpage",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsignpageID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignpageID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsignsignature": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-createObject-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-createObject-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_CreateObject_V2",
"summary": "Create a new Ezsignsignature",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignsignature": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-createObject-v1-Request"
}
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_CreateObject_V1",
"summary": "Create a new Ezsignsignature",
"description": "The endpoint allows to create one or many elements at once.\n\nThe array can contain simple (Just the object) or compound (The object and its child) objects.\n\nCreating compound elements allows to reduce the multiple requests to create all child objects.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsignsignature/{pkiEzsignsignatureID}": {
"get": {
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_GetObject_V2",
"summary": "Retrieve an existing Ezsignsignature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignsignatureID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignature/{pkiEzsignsignatureID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_EditObject_V1",
"summary": "Edit an existing Ezsignsignature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_DeleteObject_V1",
"summary": "Delete an existing Ezsignsignature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignsignatureID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment": {
"description": "",
"get": {
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-getEzsignsignatureattachment-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_GetEzsignsignatureattachment_V1",
"summary": "Retrieve an existing Ezsignsignature's Ezsignsignatureattachments",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"AgentBroker",
"EzsignSigner"
],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsignsignatureID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignature/{pkiEzsignsignatureID}/sign": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-sign-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-sign-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_Sign_V1",
"summary": "Sign the Ezsignsignature",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"EzsignSigner"
],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsignsignatureID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignature/getEzsignsignaturesAutomatic": {
"get": {
"tags": [
"Object_Ezsignsignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignature-getEzsignsignaturesAutomatic-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignature_GetEzsignsignaturesAutomatic_V1",
"summary": "Retrieve all automatic Ezsignsignatures",
"description": "Return all the Ezsignsignatures that can be signed by the current user",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsignsignergroup": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignergroup"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroup_CreateObject_V1",
"summary": "Create a new Ezsignsignergroup",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
}
},
"/2/object/ezsignsignergroup/{pkiEzsignsignergroupID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsignsignergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroup_GetObject_V2",
"summary": "Retrieve an existing Ezsignsignergroup",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsignsignergroupID",
"description": "The unique ID of the Ezsignsignergroup",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroup_EditObject_V1",
"summary": "Edit an existing Ezsignsignergroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsignsignergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroup_DeleteObject_V1",
"summary": "Delete an existing Ezsignsignergroup",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsignsignergroupID",
"description": "The unique ID of the Ezsignsignergroup",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-editEzsignsignergroupmemberships-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-editEzsignsignergroupmemberships-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroup_EditEzsignsignergroupmemberships_V1",
"summary": "Edit multiple Ezsignsignergroupmemberships",
"description": "Using this endpoint, you can edit multiple Ezsignsignergroupmemberships at the same time.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiEzsignsignergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships": {
"description": "",
"get": {
"tags": [
"Object_Ezsignsignergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroup-getEzsignsignergroupmemberships-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroup_GetEzsignsignergroupmemberships_V1",
"summary": "Retrieve an existing Ezsignsignergroup's Ezsignsignergroupmemberships",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiEzsignsignergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignergroupmembership": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsignsignergroupmembership"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroupmembership_CreateObject_V1",
"summary": "Create a new Ezsignsignergroupmembership",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
}
},
"/2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsignsignergroupmembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroupmembership_GetObject_V2",
"summary": "Retrieve an existing Ezsignsignergroupmembership",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsignsignergroupmembershipID",
"description": "The unique ID of the Ezsignsignergroupmembership",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupmembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}": {
"description": "",
"delete": {
"tags": [
"Object_Ezsignsignergroupmembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsignsignergroupmembership_DeleteObject_V1",
"summary": "Delete an existing Ezsignsignergroupmembership",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiEzsignsignergroupmembershipID",
"description": "The unique ID of the Ezsignsignergroupmembership",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupmembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplate": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplate"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_CreateObject_V1",
"summary": "Create a new Ezsigntemplate",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplate/{pkiEzsigntemplateID}": {
"get": {
"tags": [
"Object_Ezsigntemplate"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplate",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplateID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplate/{pkiEzsigntemplateID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntemplate"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-getObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_GetObject_V1",
"summary": "Retrieve an existing Ezsigntemplate",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplate"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_EditObject_V1",
"summary": "Edit an existing Ezsigntemplate",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigntemplate"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplate",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplateID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-copy-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplate"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-copy-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_Copy_V1",
"summary": "Copy the Ezsigntemplate",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplateID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsigntemplate/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntemplate"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_GetAutocomplete_V2",
"summary": "Retrieve Ezsigntemplates and IDs",
"description": "Get the list of Ezsigntemplate to be used in a dropdown or autocomplete control.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezsigntemplates to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplate/getList": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntemplate"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiEzsigntemplateID_ASC",
"pkiEzsigntemplateID_DESC",
"fkiTeamID_ASC",
"fkiTeamID_DESC",
"fkiEzsignfoldertypeID_ASC",
"fkiEzsignfoldertypeID_DESC",
"fkiUserIDOwner_ASC",
"fkiUserIDOwner_DESC",
"fkiLanguageID_ASC",
"fkiLanguageID_DESC",
"eEzsigntemplateType_ASC",
"eEzsigntemplateType_DESC",
"sEzsigntemplateTypedescriptionX_ASC",
"sEzsigntemplateTypedescriptionX_DESC",
"sEzsigntemplatedocumentDescription_ASC",
"sEzsigntemplatedocumentDescription_DESC",
"iEzsigntemplatedocumentPagetotal_ASC",
"iEzsigntemplatedocumentPagetotal_DESC",
"iEzsigntemplateSignaturetotal_ASC",
"iEzsigntemplateSignaturetotal_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplate-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplate_GetList_V1",
"summary": "Retrieve Ezsigntemplate list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eEzsigntemplateType | Company<br>Team<br>User<br>Usergroup |\n",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsigntemplatedocument": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422-sTemporaryFileUrl"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_CreateObject_V1",
"summary": "Create a new Ezsigntemplatedocument",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}": {
"get": {
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatedocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422-sTemporaryFileUrl"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_EditObject_V1",
"summary": "Edit an existing Ezsigntemplatedocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"patch": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-patchObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-patchObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_PatchObject_V1",
"summary": "Patch an existing Ezsigntemplatedocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editEzsigntemplateformfieldgroups-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editEzsigntemplateformfieldgroups-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_EditEzsigntemplateformfieldgroups_V1",
"summary": "Edit multiple Ezsigntemplateformfieldgroups",
"description": "Using this endpoint, you can edit multiple Ezsigntemplateformfieldgroups at the same time.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editEzsigntemplatesignatures-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editEzsigntemplatesignatures-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_EditEzsigntemplatesignatures_V1",
"summary": "Edit multiple Ezsigntemplatesignatures",
"description": "Using this endpoint, you can edit multiple Ezsigntemplatesignatures at the same time.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-flatten-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-flatten-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_Flatten_V1",
"summary": "Flatten",
"description": "Flatten an Ezsigntemplatedocument signatures, forms and annotations. This process finalizes the PDF so that the forms and annotations become part of the document content and cannot be edited.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages": {
"get": {
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getEzsigntemplatedocumentpages-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_GetEzsigntemplatedocumentpages_V1",
"summary": "Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatedocumentpages",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups": {
"get": {
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getEzsigntemplateformfieldgroups-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_GetEzsigntemplateformfieldgroups_V1",
"summary": "Retrieve an existing Ezsigntemplatedocument's Ezsigntemplateformfieldgroups",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures": {
"get": {
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getEzsigntemplatesignatures-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_GetEzsigntemplatesignatures_V1",
"summary": "Retrieve an existing Ezsigntemplatedocument's Ezsigntemplatesignatures",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getWordsPositions-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatedocument"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getWordsPositions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatedocument_GetWordsPositions_V1",
"summary": "Retrieve positions X,Y of given words from a Ezsigntemplatedocument",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatedocumentID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplateformfieldgroup": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplateformfieldgroup"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplateformfieldgroup_CreateObject_V1",
"summary": "Create a new Ezsigntemplateformfieldgroup",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}": {
"get": {
"tags": [
"Object_Ezsigntemplateformfieldgroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplateformfieldgroup_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplateformfieldgroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplateformfieldgroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplateformfieldgroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplateformfieldgroup_EditObject_V1",
"summary": "Edit an existing Ezsigntemplateformfieldgroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigntemplateformfieldgroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplateformfieldgroup_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplateformfieldgroup",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplateformfieldgroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackage": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackage"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_CreateObject_V1",
"summary": "Create a new Ezsigntemplatepackage",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}": {
"get": {
"tags": [
"Object_Ezsigntemplatepackage"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatepackage",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackageID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackage"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_EditObject_V1",
"summary": "Edit an existing Ezsigntemplatepackage",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigntemplatepackage"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplatepackage",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackageID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackage"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_EditEzsigntemplatepackagesigners_V1",
"summary": "Edit multiple Ezsigntemplatepackagesigners",
"description": "Using this endpoint, you can edit multiple Ezsigntemplatepackagesigners at the same time.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackageID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntemplatepackage"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_GetAutocomplete_V2",
"summary": "Retrieve Ezsigntemplatepackages and IDs",
"description": "Get the list of Ezsigntemplatepackage to be used in a dropdown or autocomplete control.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezsigntemplatepackages to return",
"schema": {
"enum": [
"All",
"AllMultipleCopiesDisabled"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackage/getList": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntemplatepackage"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiEzsigntemplatepackageID_ASC",
"pkiEzsigntemplatepackageID_DESC",
"fkiTeamID_ASC",
"fkiTeamID_DESC",
"fkiEzsignfoldertypeID_ASC",
"fkiEzsignfoldertypeID_DESC",
"fkiLanguageID_ASC",
"fkiLanguageID_DESC",
"eEzsigntemplatepackageType_ASC",
"eEzsigntemplatepackageType_DESC",
"sEzsigntemplatepackageTypedescriptionX_ASC",
"sEzsigntemplatepackageTypedescriptionX_DESC",
"sEzsigntemplatepackageDescription_ASC",
"sEzsigntemplatepackageDescription_DESC",
"bEzsigntemplatepackageNeedvalidation_ASC",
"bEzsigntemplatepackageNeedvalidation_DESC",
"iEzsigntemplatepackagemembership_ASC",
"iEzsigntemplatepackagemembership_DESC",
"bEzsigntemplatepackageIsactive_ASC",
"bEzsigntemplatepackageIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackage-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackage_GetList_V1",
"summary": "Retrieve Ezsigntemplatepackage list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eEzsigntemplatepackageType | Company<br>Team<br>User<br>Usergroup |",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/ezsigntemplatepackagemembership": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackagemembership"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagemembership_CreateObject_V1",
"summary": "Create a new Ezsigntemplatepackagemembership",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}": {
"get": {
"tags": [
"Object_Ezsigntemplatepackagemembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagemembership_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatepackagemembership",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackagemembershipID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}": {
"description": "",
"delete": {
"tags": [
"Object_Ezsigntemplatepackagemembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagemembership_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplatepackagemembership",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackagemembershipID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackagesigner": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackagesigner"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesigner_CreateObject_V1",
"summary": "Create a new Ezsigntemplatepackagesigner",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}": {
"get": {
"tags": [
"Object_Ezsigntemplatepackagesigner"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesigner_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatepackagesigner",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackagesignerID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackagesigner"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesigner_EditObject_V1",
"summary": "Edit an existing Ezsigntemplatepackagesigner",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigntemplatepackagesigner"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesigner_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplatepackagesigner",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackagesignerID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackagesignermembership": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatepackagesignermembership"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesignermembership_CreateObject_V1",
"summary": "Create a new Ezsigntemplatepackagesignermembership",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}": {
"get": {
"tags": [
"Object_Ezsigntemplatepackagesignermembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesignermembership_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatepackagesignermembership",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackagesignermembershipID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignermembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}": {
"description": "",
"delete": {
"tags": [
"Object_Ezsigntemplatepackagesignermembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatepackagesignermembership_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplatepackagesignermembership",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatepackagesignermembershipID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignermembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatesignature": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesignature-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatesignature"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesignature-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesignature_CreateObject_V1",
"summary": "Create a new Ezsigntemplatesignature",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}": {
"get": {
"tags": [
"Object_Ezsigntemplatesignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesignature-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesignature_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatesignature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatesignatureID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesignature-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatesignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesignature-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesignature_EditObject_V1",
"summary": "Edit an existing Ezsigntemplatesignature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigntemplatesignature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesignature-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesignature_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplatesignature",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatesignatureID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatesigner": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesigner-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatesigner"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesigner-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesigner_CreateObject_V1",
"summary": "Create a new Ezsigntemplatesigner",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntemplatesigner"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesigner-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesigner_GetObject_V2",
"summary": "Retrieve an existing Ezsigntemplatesigner",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatesignerID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"in": "path",
"required": true
}
]
},
"/1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesigner-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Ezsigntemplatesigner"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesigner-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesigner_EditObject_V1",
"summary": "Edit an existing Ezsigntemplatesigner",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Ezsigntemplatesigner"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntemplatesigner-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntemplatesigner_DeleteObject_V1",
"summary": "Delete an existing Ezsigntemplatesigner",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiEzsigntemplatesignerID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"in": "path",
"required": true
}
]
},
"/2/object/ezsigntsarequirement/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Ezsigntsarequirement"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ezsigntsarequirement-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Ezsigntsarequirement_GetAutocomplete_V2",
"summary": "Retrieve Ezsigntsarequirements and IDs",
"description": "Get the list of Ezsigntsarequirement to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Ezsigntsarequirements to return",
"schema": {
"enum": [
"User",
"Usergroup"
],
"type": "string"
},
"in": "path",
"required": true
},
{
"name": "fkiEzsignfoldertypeID",
"schema": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"in": "query",
"required": false
}
]
},
"/2/object/font/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Font"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/font-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Font_GetAutocomplete_V2",
"summary": "Retrieve Fonts and IDs",
"description": "Get the list of Font to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Fonts to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/franchisebroker/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Franchisebroker"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/franchisebroker-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Franchisebroker_GetAutocomplete_V2",
"summary": "Retrieve Franchisebrokers and IDs",
"description": "Get the list of Franchisebroker to be used in a dropdown or autocomplete control.",
"x-presentations": [
"RemaxQC"
],
"x-permissions": [
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Franchisebrokers to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/franchisebroker/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Franchisebroker"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-getAutocomplete-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Franchisebroker_GetAutocomplete_V1",
"summary": "Retrieve Franchisebrokers and IDs",
"description": "Get the list of Franchisebrokers to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Franchisebrokers to return",
"schema": {
"enum": [
"Active",
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/franchiseoffice/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Franchiseoffice"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/franchiseoffice-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Franchiseoffice_GetAutocomplete_V2",
"summary": "Retrieve Franchiseoffices and IDs",
"description": "Get the list of Franchiseoffice to be used in a dropdown or autocomplete control.",
"x-presentations": [
"RemaxQC"
],
"x-permissions": [
"Invoicing_Reports",
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Franchiseoffices to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/franchisereferalincome": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/franchisereferalincome-createObject-v2-Request"
}
}
},
"required": true
},
"tags": [
"Object_Franchisereferalincome"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/franchisereferalincome-createObject-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Franchisereferalincome_CreateObject_V2",
"summary": "Create a new Franchisereferalincome",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"RemaxQC"
],
"x-permissions": [
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/franchisereferalincome": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/franchisereferalincome-createObject-v1-Request"
}
}
}
},
"required": true
},
"tags": [
"Object_Franchisereferalincome"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/franchisereferalincome-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Franchisereferalincome_CreateObject_V1",
"summary": "Create a new Franchisereferalincome",
"description": "The endpoint allows to create one or many elements at once.\n\nThe array can contain simple (Just the object) or compound (The object and its child) objects.\n\nCreating compound elements allows to reduce the multiple requests to create all child objects.",
"x-presentations": [],
"x-permissions": [
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/1/object/modulegroup/getAll/{eContext}": {
"description": "",
"get": {
"tags": [
"Object_Modulegroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/modulegroup-getAll-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Modulegroup_GetAll_V1",
"summary": "Retrieve all Modulegroups",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsersAgentBroker",
"Management_UsersAssistant",
"Management_UsersEmployee",
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "eContext",
"description": "The context of the Modulegroup",
"schema": {
"enum": [
"Api",
"User"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests": {
"get": {
"tags": [
"Object_Notificationsection"
],
"parameters": [
{
"name": "bShowHidden",
"description": "Whether or not to return the hidden Notificationtests",
"schema": {
"type": "boolean"
},
"in": "query",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notificationsection-getNotificationtests-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Notificationsection_GetNotificationtests_V1",
"summary": "Retrieve an existing Notificationsection's Notificationtests",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiNotificationsectionID",
"schema": {
"$ref": "#/components/schemas/Field-pkiNotificationsectionID"
},
"in": "path",
"required": true
}
]
},
"/1/object/notificationtest/{pkiNotificationtestID}/getElements": {
"get": {
"tags": [
"Object_Notificationtest"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/notificationtest-getElements-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Notificationtest_GetElements_V1",
"summary": "Retrieve an existing Notificationtest's Elements",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiNotificationtestID",
"schema": {
"$ref": "#/components/schemas/Field-pkiNotificationtestID"
},
"in": "path",
"required": true
}
]
},
"/1/object/paymentterm": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Paymentterm"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Paymentterm_CreateObject_V1",
"summary": "Create a new Paymentterm",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"Management_PaymentTerms"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/paymentterm/{pkiPaymenttermID}": {
"description": "",
"get": {
"tags": [
"Object_Paymentterm"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Paymentterm_GetObject_V2",
"summary": "Retrieve an existing Paymentterm",
"description": "",
"x-presentations": [],
"x-permissions": [
"Management_PaymentTerms"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiPaymenttermID",
"schema": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
},
"in": "path",
"required": true
}
]
},
"/1/object/paymentterm/{pkiPaymenttermID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Paymentterm"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Paymentterm_EditObject_V1",
"summary": "Edit an existing Paymentterm",
"description": "",
"x-presentations": [],
"x-permissions": [
"Management_PaymentTerms"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiPaymenttermID",
"schema": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
},
"in": "path",
"required": true
}
]
},
"/2/object/paymentterm/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Paymentterm"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Paymentterm_GetAutocomplete_V2",
"summary": "Retrieve Paymentterms and IDs",
"description": "Get the list of Paymentterm to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"RemaxFranchise_CreationModification",
"Purchases_CreationModification"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Paymentterms to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/paymentterm/getList": {
"description": "",
"get": {
"tags": [
"Object_Paymentterm"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiPaymenttermID_ASC",
"pkiPaymenttermID_DESC",
"sPaymenttermCode_ASC",
"sPaymenttermCode_DESC",
"ePaymenttermType_ASC",
"ePaymenttermType_DESC",
"iPaymenttermDay_ASC",
"iPaymenttermDay_DESC",
"sPaymenttermDescriptionX_ASC",
"sPaymenttermDescriptionX_DESC",
"bPaymenttermIsactive_ASC",
"bPaymenttermIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentterm-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Paymentterm_GetList_V1",
"summary": "Retrieve Paymentterm list",
"x-presentations": [],
"x-permissions": [
"Management_PaymentTerms"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/period/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Period"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/period-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Period_GetAutocomplete_V2",
"summary": "Retrieve Periods and IDs",
"description": "Get the list of Period to be used in a dropdown or autocomplete control.",
"x-presentations": [
"RemaxQC"
],
"x-permissions": [
"Purchases_Access",
"Purchases_Reports",
"AccountsPayableReports_Reports",
"Invoicing_Access",
"Invoicing_Reports",
"AccountReceivableReports_Reports",
"RealEstateReports_AdministrativeReports",
"RealEstateReports_OfficeReports",
"Inscription_Inspections",
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Periods to return",
"schema": {
"enum": [
"ActiveNormal",
"ActiveNormalAndEndOfYear",
"AllNormal",
"AllNormalAndEndOfYear"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/period/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Period"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-getAutocomplete-v1-Response"
}
}
},
"description": "Successful response"
}
},
"deprecated": true,
"security": [
{
"Authorization": []
}
],
"operationId": "Period_GetAutocomplete_V1",
"summary": "Retrieve Periods and IDs",
"description": "Get the list of Periods to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"Purchases_Access",
"Purchases_Reports",
"AccountsPayableReports_Reports",
"Invoicing_Access",
"Invoicing_Reports",
"AccountReceivableReports_Reports",
"RealEstateReports_AdministrativeReports",
"RealEstateReports_OfficeReports",
"Inscription_Inspections",
"RemaxFranchise_ReferencedIncomeAccess"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The types of Periods to return",
"schema": {
"enum": [
"ActiveNormal",
"ActiveNormalAndEndOfYear",
"AllNormal",
"AllNormalAndEndOfYear"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/permission": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/permission-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Permission"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/permission-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Permission_CreateObject_V1",
"summary": "Create a new Permission",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/permission/{pkiPermissionID}": {
"description": "",
"get": {
"tags": [
"Object_Permission"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/permission-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Permission_GetObject_V2",
"summary": "Retrieve an existing Permission",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiPermissionID",
"description": "The unique ID of the Permission",
"schema": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
},
"in": "path",
"required": true
}
]
},
"/1/object/permission/{pkiPermissionID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/permission-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Permission"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/permission-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Permission_EditObject_V1",
"summary": "Edit an existing Permission",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"delete": {
"tags": [
"Object_Permission"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/permission-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Permission_DeleteObject_V1",
"summary": "Delete an existing Permission",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiPermissionID",
"description": "The unique ID of the Permission",
"schema": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
},
"in": "path",
"required": true
}
]
},
"/2/object/phonetype/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Phonetype"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/phonetype-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Phonetype_GetAutocomplete_V2",
"summary": "Retrieve Phonetypes and IDs",
"description": "Get the list of Phonetype to be used in a dropdown or autocomplete control.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"AgentBroker"
],
"x-presentations": []
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Phonetypes to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/secretquestion/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Secretquestion"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/secretquestion-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Secretquestion_GetAutocomplete_V2",
"summary": "Retrieve Secretquestions and IDs",
"description": "Get the list of Secretquestion to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Secretquestions to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/sessionhistory/getList": {
"description": "",
"get": {
"tags": [
"Object_Sessionhistory"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiSessionhistoryID_ASC",
"pkiSessionhistoryID_DESC",
"fkiComputerID_ASC",
"fkiComputerID_DESC",
"fkiUserID_ASC",
"fkiUserID_DESC",
"dtSessionhistoryFirsthit_ASC",
"dtSessionhistoryFirsthit_DESC",
"dtSessionhistoryLasthit_ASC",
"dtSessionhistoryLasthit_DESC",
"eSessionhistoryEndby_ASC",
"eSessionhistoryEndby_DESC",
"sComputerDescription_ASC",
"sComputerDescription_DESC",
"sSessionhistoryDuration_ASC",
"sSessionhistoryDuration_DESC",
"sSessionhistoryIP_ASC",
"sSessionhistoryIP_DESC",
"sUserLoginname_ASC",
"sUserLoginname_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/sessionhistory-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Sessionhistory_GetList_V1",
"summary": "Retrieve Sessionhistory list",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-usertypeextra": [],
"x-presentations": [],
"x-permissions": [
"Management_UsersAgentBroker",
"Management_UsersAssistant",
"Management_UsersAttendance",
"Management_UsersEmployee",
"Management_UsersEzcom",
"Management_UsersEzsignUser",
"Management_UsersNormal",
"Management_UsersRewardMember",
"Management_UsersRewardRepresentative",
"Management_UsersRewardCustomer",
"Management_UsersRewardDistributorServer",
"Management_UsersSupplier",
"Management_UsersVetrxCustomer",
"Management_UsersVetrxcustomergroup",
"Management_UsersVetrxCustomerServer",
"Management_UsersVetrxManufacturer",
"Management_UsersVetrxVendor"
]
}
},
"/1/object/signature": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/signature-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Signature"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/signature-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Signature_CreateObject_V1",
"summary": "Create a new Signature",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersNormal",
"Management_UsersAgentBroker",
"Management_UsersEzsignUser"
],
"x-usertypeextra": [
"AgentBroker",
"EzsignSigner"
],
"x-presentations": []
}
},
"/2/object/signature/{pkiSignatureID}": {
"description": "",
"get": {
"tags": [
"Object_Signature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/signature-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Signature_GetObject_V2",
"summary": "Retrieve an existing Signature",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersNormal",
"Management_UsersAgentBroker",
"Management_UsersEzsignUser"
],
"x-usertypeextra": [
"AgentBroker",
"EzsignSigner"
],
"x-presentations": []
},
"parameters": [
{
"name": "pkiSignatureID",
"description": "The unique ID of the Signature",
"schema": {
"$ref": "#/components/schemas/Field-pkiSignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/signature/{pkiSignatureID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/signature-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Signature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/signature-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Signature_EditObject_V1",
"summary": "Edit an existing Signature",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersNormal",
"Management_UsersAgentBroker",
"Management_UsersEzsignUser"
],
"x-usertypeextra": [
"AgentBroker",
"EzsignSigner"
],
"x-presentations": []
},
"delete": {
"tags": [
"Object_Signature"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/signature-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Signature_DeleteObject_V1",
"summary": "Delete an existing Signature",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersNormal",
"Management_UsersAgentBroker",
"Management_UsersEzsignUser"
],
"x-usertypeextra": [
"AgentBroker",
"EzsignSigner"
],
"x-presentations": []
},
"parameters": [
{
"name": "pkiSignatureID",
"description": "The unique ID of the Signature",
"schema": {
"$ref": "#/components/schemas/Field-pkiSignatureID"
},
"in": "path",
"required": true
}
]
},
"/1/object/subnet": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subnet-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Subnet"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subnet-createObject-v1-Response"
}
}
},
"description": "Successful response"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Subnet_CreateObject_V1",
"summary": "Create a new Subnet",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/subnet/{pkiSubnetID}": {
"description": "",
"get": {
"tags": [
"Object_Subnet"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subnet-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Subnet_GetObject_V2",
"summary": "Retrieve an existing Subnet",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiSubnetID",
"description": "The unique ID of the Subnet",
"schema": {
"$ref": "#/components/schemas/Field-pkiSubnetID"
},
"in": "path",
"required": true
}
]
},
"/1/object/subnet/{pkiSubnetID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subnet-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Subnet"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subnet-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Subnet_EditObject_V1",
"summary": "Edit an existing Subnet",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"delete": {
"tags": [
"Object_Subnet"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/subnet-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Subnet_DeleteObject_V1",
"summary": "Delete an existing Subnet",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiSubnetID",
"description": "The unique ID of the Subnet",
"schema": {
"$ref": "#/components/schemas/Field-pkiSubnetID"
},
"in": "path",
"required": true
}
]
},
"/2/object/systemconfiguration/{pkiSystemconfigurationID}": {
"description": "",
"get": {
"tags": [
"Object_Systemconfiguration"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/systemconfiguration-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Systemconfiguration_GetObject_V2",
"summary": "Retrieve an existing Systemconfiguration",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [
"AgentBroker",
"Assistant"
],
"x-presentations": []
},
"parameters": [
{
"name": "pkiSystemconfigurationID",
"description": "The unique ID of the Systemconfiguration",
"schema": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/systemconfiguration/{pkiSystemconfigurationID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/systemconfiguration-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Systemconfiguration"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/systemconfiguration-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Systemconfiguration_EditObject_V1",
"summary": "Edit an existing Systemconfiguration",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_SystemconfigurationEdit"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiSystemconfigurationID",
"description": "The unique ID of the Systemconfiguration",
"schema": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationID"
},
"in": "path",
"required": true
}
]
},
"/2/object/taxassignment/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Taxassignment"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxassignment-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Taxassignment_GetAutocomplete_V2",
"summary": "Retrieve Taxassignments and IDs",
"description": "Get the list of Taxassignment to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Taxassignments to return",
"schema": {
"enum": [
"All",
"AllButNonrecoverable"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/2/object/timezone/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Timezone"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/timezone-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Timezone_GetAutocomplete_V2",
"summary": "Retrieve Timezones and IDs",
"description": "Get the list of Timezone to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Timezones to return",
"schema": {
"enum": [
"All",
"Active"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/user": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_User"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_CreateObject_V1",
"summary": "Create a new User",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersAgentBroker",
"Management_UsersAssistant",
"Management_UsersEmployee",
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/user/{pkiUserID}": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetObject_V2",
"summary": "Retrieve an existing User",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersAgentBroker",
"Management_UsersAssistant",
"Management_UsersEmployee",
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"description": "The unique ID of the User",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_EditObject_V1",
"summary": "Edit an existing User",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersAgentBroker",
"Management_UsersAssistant",
"Management_UsersEmployee",
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"description": "The unique ID of the User",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}/editPermissions": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-editPermissions-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-editPermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_EditPermissions_V1",
"summary": "Edit multiple Permissions",
"description": "Using this endpoint, you can edit multiple Permissions at the same time.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}/getApikeys": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getApikeys-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetApikeys_V1",
"summary": "Retrieve an existing User's Apikeys",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_APIKeyGeneration"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiUserID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}/getEffectivePermissions": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getEffectivePermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetEffectivePermissions_V1",
"summary": "Retrieve an existing User's Effective Permissions",
"description": "Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}/getPermissions": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getPermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetPermissions_V1",
"summary": "Retrieve an existing User's Permissions",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}/getSubnets": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getSubnets-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetSubnets_V1",
"summary": "Retrieve an existing User's Subnets",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/{pkiUserID}/sendPasswordReset": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-sendPasswordReset-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_User"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-sendPasswordReset-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_SendPasswordReset_V1",
"summary": "Send password reset",
"description": "Send the password reset email",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUserID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"in": "path",
"required": true
}
]
},
"/2/object/user/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetAutocomplete_V2",
"summary": "Retrieve Users and IDs",
"description": "Get the list of User to be used in a dropdown or autocomplete control.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Users to return",
"schema": {
"enum": [
"All",
"AgentBrokerEmployeeEzsignUserNormal",
"AgentBrokerEmployeeNormalBuiltIn",
"AgentBrokerEzsignuserNormal",
"ClonableUsers",
"EzsignuserBuiltIn",
"Normal",
"NormalEzsignSigner",
"UsergroupDelegated"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/user/getList": {
"description": "",
"get": {
"tags": [
"Object_User"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiUserID_ASC",
"pkiUserID_DESC",
"sUserFirstname_ASC",
"sUserFirstname_DESC",
"sUserLastname_ASC",
"sUserLastname_DESC",
"sUserLoginname_ASC",
"sUserLoginname_DESC",
"bUserIsactive_ASC",
"bUserIsactive_DESC",
"eUserType_ASC",
"eUserType_DESC",
"eUserOrigin_ASC",
"eUserOrigin_DESC",
"eUserEzsignaccess_ASC",
"eUserEzsignaccess_DESC",
"dtUserEzsignprepaidexpiration_ASC",
"dtUserEzsignprepaidexpiration_DESC",
"sEmailAddress_ASC",
"sEmailAddress_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/user-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "User_GetList_V1",
"summary": "Retrieve User list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eUserType | AgentBroker<br>Assistant<br>Employee<br>EzsignUser<br>Normal |\n| eUserOrigin | BuiltIn<br>External |\n| eUserEzsignaccess | No<br>PaidByOffice<br>PerDocument<br>Prepaid |",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersAgentBroker",
"Management_UsersAssistant",
"Management_UsersEmployee",
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/1/object/usergroup": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroup"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_CreateObject_V1",
"summary": "Create a new Usergroup",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/usergroup/{pkiUsergroupID}": {
"description": "",
"get": {
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_GetObject_V2",
"summary": "Retrieve an existing Usergroup",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_EditObject_V1",
"summary": "Edit an existing Usergroup",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}/editPermissions": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editPermissions-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editPermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_EditPermissions_V1",
"summary": "Edit multiple Permissions",
"description": "Using this endpoint, you can edit multiple Permissions at the same time.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editUsergroupdelegations-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editUsergroupdelegations-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_EditUsergroupdelegations_V1",
"summary": "Edit multiple Usergroupdelegations",
"description": "Edit multiple Usergroupdelegations",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships": {
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editUsergroupmemberships-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-editUsergroupmemberships-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_EditUsergroupmemberships_V1",
"summary": "Edit multiple Usergroupmemberships",
"description": "Using this endpoint, you can edit multiple Usergroupmemberships at the same time.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}/getPermissions": {
"description": "",
"get": {
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-getPermissions-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_GetPermissions_V1",
"summary": "Retrieve an existing Usergroup's Permissions",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations": {
"description": "",
"get": {
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-getUsergroupdelegations-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_GetUsergroupdelegations_V1",
"summary": "Retrieve an existing Usergroup's Usergroupdelegations",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships": {
"description": "",
"get": {
"tags": [
"Object_Usergroup"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-getUsergroupmemberships-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_GetUsergroupmemberships_V1",
"summary": "Retrieve an existing Usergroup's Usergroupmemberships",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"in": "path",
"required": true
}
]
},
"/2/object/usergroup/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Usergroup"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_GetAutocomplete_V2",
"summary": "Retrieve Usergroups and IDs",
"description": "Get the list of Usergroup to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"ElectronicSignature_CreationModificationFolderTypes"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Usergroups to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroup/getList": {
"description": "",
"get": {
"tags": [
"Object_Usergroup"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiUsergroupID_ASC",
"pkiUsergroupID_DESC",
"sUsergroupNameX_ASC",
"sUsergroupNameX_DESC",
"iCountUser_ASC",
"iCountUser_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroup-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroup_GetList_V1",
"summary": "Retrieve Usergroup list",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/1/object/usergroupdelegation": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupdelegation-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroupdelegation"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupdelegation-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupdelegation_CreateObject_V1",
"summary": "Create a new Usergroupdelegation",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/usergroupdelegation/{pkiUsergroupdelegationID}": {
"description": "",
"get": {
"tags": [
"Object_Usergroupdelegation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupdelegation-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupdelegation_GetObject_V2",
"summary": "Retrieve an existing Usergroupdelegation",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupdelegationID",
"description": "The unique ID of the Usergroupdelegation",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupdelegationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroupdelegation/{pkiUsergroupdelegationID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupdelegation-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroupdelegation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupdelegation-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupdelegation_EditObject_V1",
"summary": "Edit an existing Usergroupdelegation",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"delete": {
"tags": [
"Object_Usergroupdelegation"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupdelegation-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupdelegation_DeleteObject_V1",
"summary": "Delete an existing Usergroupdelegation",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupdelegationID",
"description": "The unique ID of the Usergroupdelegation",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupdelegationID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroupmembership": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupmembership-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroupmembership"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupmembership-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupmembership_CreateObject_V1",
"summary": "Create a new Usergroupmembership",
"description": "The endpoint allows to create one or many elements at once.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
}
},
"/2/object/usergroupmembership/{pkiUsergroupmembershipID}": {
"description": "",
"get": {
"tags": [
"Object_Usergroupmembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupmembership-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupmembership_GetObject_V2",
"summary": "Retrieve an existing Usergroupmembership",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupmembershipID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupmembershipID"
},
"in": "path",
"required": true
}
]
},
"/1/object/usergroupmembership/{pkiUsergroupmembershipID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupmembership-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Usergroupmembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupmembership-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupmembership_EditObject_V1",
"summary": "Edit an existing Usergroupmembership",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"delete": {
"tags": [
"Object_Usergroupmembership"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/usergroupmembership-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Usergroupmembership_DeleteObject_V1",
"summary": "Delete an existing Usergroupmembership",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_Usergroup",
"Management_UsergroupDelegated"
],
"x-usertypeextra": [],
"x-presentations": []
},
"parameters": [
{
"name": "pkiUsergroupmembershipID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUsergroupmembershipID"
},
"in": "path",
"required": true
}
]
},
"/2/object/userstaged/{pkiUserstagedID}": {
"description": "",
"get": {
"tags": [
"Object_Userstaged"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Userstaged_GetObject_V2",
"summary": "Retrieve an existing Userstaged",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiUserstagedID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserstagedID"
},
"in": "path",
"required": true
}
]
},
"/1/object/userstaged/{pkiUserstagedID}": {
"description": "",
"delete": {
"tags": [
"Object_Userstaged"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Userstaged_DeleteObject_V1",
"summary": "Delete an existing Userstaged",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiUserstagedID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserstagedID"
},
"in": "path",
"required": true
}
]
},
"/1/object/userstaged/{pkiUserstagedID}/createUser": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-createUser-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Userstaged"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-createUser-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Userstaged_CreateUser_V1",
"summary": "Create a User from a Userstaged and then map it",
"description": "Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User.",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiUserstagedID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserstagedID"
},
"in": "path",
"required": true
}
]
},
"/1/object/userstaged/{pkiUserstagedID}/map": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-map-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Userstaged"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-map-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Userstaged_Map_V1",
"summary": "Map the Userstaged to an existing user",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
},
"parameters": [
{
"name": "pkiUserstagedID",
"schema": {
"$ref": "#/components/schemas/Field-pkiUserstagedID"
},
"in": "path",
"required": true
}
]
},
"/1/object/userstaged/getList": {
"description": "",
"get": {
"tags": [
"Object_Userstaged"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiUserstagedID_ASC",
"pkiUserstagedID_DESC",
"sEmailAddress_ASC",
"sEmailAddress_DESC",
"sUserstagedFirstname_ASC",
"sUserstagedFirstname_DESC",
"sUserstagedLastname_ASC",
"sUserstagedLastname_DESC",
"sUserstagedExternalid_ASC",
"sUserstagedExternalid_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/userstaged-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Userstaged_GetList_V1",
"summary": "Retrieve Userstaged list",
"description": "",
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-presentations": [
"Ezsign"
]
}
},
"/1/object/variableexpense": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Variableexpense"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Variableexpense_CreateObject_V1",
"summary": "Create a new Variableexpense",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [],
"x-permissions": [
"Management_VariableExpenses"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/variableexpense/{pkiVariableexpenseID}": {
"description": "",
"get": {
"tags": [
"Object_Variableexpense"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Variableexpense_GetObject_V2",
"summary": "Retrieve an existing Variableexpense",
"description": "",
"x-presentations": [],
"x-permissions": [
"Management_VariableExpenses"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiVariableexpenseID",
"schema": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
},
"in": "path",
"required": true
}
]
},
"/1/object/variableexpense/{pkiVariableexpenseID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Variableexpense"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"422": {
"$ref": "#/components/responses/Response-Error-422"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Variableexpense_EditObject_V1",
"summary": "Edit an existing Variableexpense",
"description": "",
"x-presentations": [],
"x-permissions": [
"Management_VariableExpenses"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiVariableexpenseID",
"schema": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
},
"in": "path",
"required": true
}
]
},
"/2/object/variableexpense/getAutocomplete/{sSelector}": {
"description": "",
"get": {
"tags": [
"Object_Variableexpense"
],
"parameters": [
{
"name": "eFilterActive",
"description": "Specify which results we want to display.",
"schema": {
"default": "Active",
"enum": [
"All",
"Active",
"Inactive"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/sQuery"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-getAutocomplete-v2-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Variableexpense_GetAutocomplete_V2",
"summary": "Retrieve Variableexpenses and IDs",
"description": "Get the list of Variableexpense to be used in a dropdown or autocomplete control.",
"x-presentations": [],
"x-permissions": [
"Purchases_CreationModification"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "sSelector",
"description": "The type of Variableexpenses to return",
"schema": {
"enum": [
"All"
],
"type": "string"
},
"in": "path",
"required": true
}
]
},
"/1/object/variableexpense/getList": {
"description": "",
"get": {
"tags": [
"Object_Variableexpense"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiVariableexpenseID_ASC",
"pkiVariableexpenseID_DESC",
"sVariableexpenseCode_ASC",
"sVariableexpenseCode_DESC",
"sVariableexpenseDescriptionX_ASC",
"sVariableexpenseDescriptionX_DESC",
"eVariableexpenseTaxable_ASC",
"eVariableexpenseTaxable_DESC",
"bVariableexpenseIsactive_ASC",
"bVariableexpenseIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/variableexpense-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Variableexpense_GetList_V1",
"summary": "Retrieve Variableexpense list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eVariableexpenseTaxable | Yes<br>No<br>Included |",
"x-presentations": [],
"x-permissions": [
"Management_VariableExpenses"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/versionhistory/{pkiVersionhistoryID}": {
"get": {
"tags": [
"Object_Versionhistory"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/versionhistory-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Versionhistory_GetObject_V2",
"summary": "Retrieve an existing Versionhistory",
"description": "",
"x-presentations": [],
"x-permissions": [
"All"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiVersionhistoryID",
"schema": {
"$ref": "#/components/schemas/Field-pkiVersionhistoryID"
},
"in": "path",
"required": true
}
]
},
"/1/object/webhook": {
"description": "",
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-createObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Webhook"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-createObject-v1-Response"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_CreateObject_V1",
"summary": "Create a new Webhook",
"description": "The endpoint allows to create one or many elements at once.",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/object/webhook/{pkiWebhookID}": {
"get": {
"tags": [
"Object_Webhook"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-getObject-v2-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_GetObject_V2",
"summary": "Retrieve an existing Webhook",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiWebhookID",
"schema": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"in": "path",
"required": true
}
]
},
"/1/object/webhook/{pkiWebhookID}": {
"description": "",
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-editObject-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Webhook"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-editObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_EditObject_V1",
"summary": "Edit an existing Webhook",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Object_Webhook"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-deleteObject-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_DeleteObject_V1",
"summary": "Delete an existing Webhook",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiWebhookID",
"schema": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"in": "path",
"required": true
}
]
},
"/1/object/webhook/{pkiWebhookID}/getHistory": {
"get": {
"tags": [
"Object_Webhook"
],
"parameters": [
{
"name": "eWebhookHistoryinterval",
"description": "The number of days to return",
"schema": {
"enum": [
"LastDay",
"LastWeek"
],
"type": "string"
},
"in": "query",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-getHistory-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
},
"429": {
"$ref": "#/components/responses/Response-Error-429"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_GetHistory_V1",
"summary": "Retrieve the logs for recent Webhook calls",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiWebhookID",
"schema": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"in": "path",
"required": true
}
]
},
"/1/object/webhook/{pkiWebhookID}/test": {
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-test-v1-Request"
}
}
},
"required": true
},
"tags": [
"Object_Webhook"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-test-v1-Response"
}
}
},
"description": "Successful response"
},
"404": {
"$ref": "#/components/responses/Response-Error-404"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_Test_V1",
"summary": "Test the Webhook by calling the Url",
"description": "",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"parameters": [
{
"name": "pkiWebhookID",
"schema": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"in": "path",
"required": true
}
]
},
"/1/object/webhook/getList": {
"description": "",
"get": {
"tags": [
"Object_Webhook"
],
"parameters": [
{
"name": "eOrderBy",
"description": "Specify how you want the results to be sorted",
"schema": {
"enum": [
"pkiWebhookID_ASC",
"pkiWebhookID_DESC",
"sWebhookDescription_ASC",
"sWebhookDescription_DESC",
"eWebhookEzsignevent_ASC",
"eWebhookEzsignevent_DESC",
"eWebhookManagementevent_ASC",
"eWebhookManagementevent_DESC",
"eWebhookModule_ASC",
"eWebhookModule_DESC",
"sWebhookEmailfailed_ASC",
"sWebhookEmailfailed_DESC",
"sWebhookEvent_ASC",
"sWebhookEvent_DESC",
"sWebhookUrl_ASC",
"sWebhookUrl_DESC",
"bWebhookIsactive_ASC",
"bWebhookIsactive_DESC"
],
"type": "string"
},
"in": "query",
"required": false
},
{
"$ref": "#/components/parameters/iRowMax"
},
{
"$ref": "#/components/parameters/iRowOffset"
},
{
"$ref": "#/components/parameters/AcceptLanguage"
},
{
"$ref": "#/components/parameters/sFilter"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/webhook-getList-v1-Response"
}
},
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
"schema": {
"$ref": "#/components/schemas/File-Xlsx"
}
}
},
"description": "Successful response"
},
"406": {
"$ref": "#/components/responses/Response-Error-406"
}
},
"security": [
{
"Authorization": []
}
],
"operationId": "Webhook_GetList_V1",
"summary": "Retrieve Webhook list",
"description": "Enum values that can be filtered in query parameter *sFilter*:\n\n| Variable | Valid values |\n|---|---|\n| eWebhookModule | Ezsign<br>Management |\n| eWebhookEzsignevent | DocumentCompleted<br>FolderCompleted |\n| eWebhookManagementevent | UserCreated |",
"x-presentations": [
"Ezsign"
],
"x-permissions": [
"Management_Webhook"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/scim/Groups": {
"get": {
"tags": [
"Scim_Groups"
],
"parameters": [
{
"name": "filter",
"description": "Filter expression for searching groups",
"schema": {
"type": "string"
},
"in": "query",
"required": false
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-Group"
}
}
},
"description": "OK"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Groups_GetListScim_V2",
"summary": "Retrieve Usergroup list",
"x-presentations": [],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-Group"
}
}
},
"required": true
},
"tags": [
"Scim_Groups"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-Group"
}
}
},
"description": "Created"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Groups_CreateObjectScim_V2",
"summary": "Create a new Usergroup",
"x-presentations": [],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/scim/Groups/{groupId}": {
"get": {
"tags": [
"Scim_Groups"
],
"parameters": [
{
"name": "groupId",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-Group"
}
}
},
"description": "OK"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Groups_GetObjectScim_V2",
"summary": "Retrieve an existing Usergroup",
"x-presentations": [],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-Group"
}
}
},
"required": true
},
"tags": [
"Scim_Groups"
],
"parameters": [
{
"name": "groupId",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-Group"
}
}
},
"description": "OK"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Groups_EditObjectScim_V2",
"summary": "Edit an existing Usergroup",
"x-presentations": [],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Scim_Groups"
],
"parameters": [
{
"name": "groupId",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Groups_DeleteObjectScim_V2",
"summary": "Delete an existing Usergroup",
"x-presentations": [],
"x-permissions": [
"Management_Usergroup"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/scim/ServiceProviderConfig": {
"get": {
"tags": [
"Scim_ServiceProviderConfig"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-ServiceProviderConfig"
}
}
},
"description": "OK"
}
},
"security": [
{}
],
"operationId": "ServiceProviderConfig_GetObjectScim_V2",
"summary": "Get Service Provider Configuration",
"x-presentations": [],
"x-permissions": [],
"x-usertypeextra": [],
"x-apikeyrequire": false,
"x-authorizationsources": [
"NoAuthorization"
]
}
},
"/2/scim/Users": {
"get": {
"tags": [
"Scim_Users"
],
"parameters": [
{
"name": "filter",
"description": "Filter expression for searching users",
"schema": {
"type": "string"
},
"in": "query",
"required": false
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-UserList"
}
}
},
"description": "OK"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Users_GetListScim_V2",
"summary": "Retrieve User list",
"x-presentations": [],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"post": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-User"
}
}
},
"required": true
},
"tags": [
"Scim_Users"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-User"
}
}
},
"description": "Created"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Users_CreateObjectScim_V2",
"summary": "Create a new User",
"x-presentations": [],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
},
"/2/scim/Users/{userId}": {
"get": {
"tags": [
"Scim_Users"
],
"parameters": [
{
"name": "userId",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-User"
}
}
},
"description": "OK"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Users_GetObjectScim_V2",
"summary": "Retrieve an existing User",
"x-presentations": [],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"put": {
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-User"
}
}
},
"required": true
},
"tags": [
"Scim_Users"
],
"parameters": [
{
"name": "userId",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Scim-User"
}
}
},
"description": "OK"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Users_EditObjectScim_V2",
"summary": "Edit an existing User",
"x-presentations": [],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
},
"delete": {
"tags": [
"Scim_Users"
],
"parameters": [
{
"name": "userId",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
],
"responses": {
"204": {
"description": "No Content"
}
},
"security": [
{
"Bearer": []
}
],
"operationId": "Users_DeleteObjectScim_V2",
"summary": "Delete an existing User",
"x-presentations": [],
"x-permissions": [
"Management_UsersEzsignUser",
"Management_UsersNormal"
],
"x-usertypeextra": [],
"x-apikeyrequire": true,
"x-authorizationsources": [
"Headers"
]
}
}
},
"components": {
"schemas": {
"Common-Audit": {
"description": "Gives informations about the user that created the object and the last user to have modified it.\n\nIf the object was never modified after creation, objAuditdetailModified won't be returned.\n",
"required": [
"objAuditdetailCreated"
],
"type": "object",
"properties": {
"objAuditdetailCreated": {
"$ref": "#/components/schemas/Common-Auditdetail"
},
"objAuditdetailModified": {
"$ref": "#/components/schemas/Common-Auditdetail"
}
}
},
"Common-Auditdetail": {
"description": "Gives informations about the user that created the object or the last user to have modified it.\n\nIf the object was never modified after creation, both Created and Modified informations will be the same.\n",
"required": [
"fkiUserID",
"sUserLoginname",
"sUserFirstname",
"sUserLastname",
"dtAuditdetailDate"
],
"type": "object",
"properties": {
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sApikeyDescriptionX": {
"$ref": "#/components/schemas/Field-sApikeyDescriptionX"
},
"dtAuditdetailDate": {
"$ref": "#/components/schemas/Common-Format-DateTime"
}
}
},
"Common-File": {
"description": "Object representing a file used in a request or response context\n",
"required": [
"sFileName",
"eFileSource"
],
"type": "object",
"properties": {
"sFileName": {
"description": "The name of the file",
"type": "string",
"example": "example.pdf"
},
"sFileUrl": {
"format": "iri",
"description": "The URL used to reach the File",
"type": "string"
},
"sFileBase64": {
"format": "byte",
"description": "The Base64 encoded binary content of the File",
"type": "string",
"example": {
"$ref": "#/components/examples/PdfAsBase64/value"
}
},
"eFileSource": {
"description": "The source of the File",
"enum": [
"Base64",
"Url"
],
"type": "string"
}
}
},
"Common-Format-CustomDateFormat": {
"description": "The custom date format to use\n\nYou can use the codes below and they will be replaced at signature time.\nText values like month and day names will be rendered in the proper language.\nOther text will be left as-is.\n\nThe codes examples below are based on the following datetime: Thursday, January 6, 2022 at 08:07:09 EST\n\nFor example, the format \"Signature date: {MM}/{DD}/{YYYY} {hh}:{mm}\" would become \"Signature date: 01/06/2022 08:07\"\n\n**Year**\n\n| Code | Example |\n| - | - |\n| {YYYY} | 2022 |\n| {YY} | 22 |\n\n**Month**\n\n| Code | Example |\n| - | - |\n| {MonthCapitalize} | Janvier |\n| {Month} | janvier |\n| {MM} | 01 |\n| {M} | 1 |\n\n**Day**\n\n| Code | Example |\n| - | - |\n| {DayCapitalize} | Jeudi |\n| {Day} | jeudi |\n| {DD} | 06 |\n| {D} | 6 |\n\n**Hour**\n\n| Code | Example |\n| - | - |\n| {hh} | 08 |\n\n**Minute**\n\n| Code | Example |\n| - | - |\n| {mm} | 07 |\n\n**Second**\n\n| Code | Example |\n| - | - |\n| {ss} | 09 | \n\n**Timezone**\n\n| Code | Example |\n| - | - |\n| {Z} | EST | \n\n**Time**\n\n| Code | Example |\n| - | - |\n| {Time} | 08:07:09 | \n| {TimeZ} | 08:07:09 EST |\n \n**Date**\n\n| Code | Example |\n| - | - |\n| {Date} | 2022-01-06 | \n| {DateText} | 1er Janvier 2022 |\n\n**Full**\n\n| Code | Example |\n| - | - |\n| {DateTime} | 2022-01-06 08:07:09 | \n| {DateTimeZ} | 2022-01-06 08:07:09 EST |\n",
"type": "string",
"example": "Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}"
},
"Common-Format-DateTime": {
"description": "Represent a Date Time.\nThe timezone is the one configured in the User's profile.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Common-Format-ExternalID": {
"description": "This field can be used to store an External ID from the client's system.\n\nAnything can be stored in this field, it will never be evaluated by the eZmax system and will be returned\nAS-IS.\n\nTo store multiple values, consider using a JSON formatted structure, a URL encoded string, a CSV or any other custom format.\n",
"pattern": "^.{0,64}$",
"type": "string",
"example": "{\"ID\": 1234, \"TAGS\": [\"tag1\", \"tag2\", \"tag3\"]}"
},
"Common-Format-IP": {
"description": "Represent an IP address.",
"type": "string",
"example": "127.0.0.1"
},
"Common-Report": {
"description": "A Report containing Reportsections\n",
"required": [
"a_objReportsection"
],
"type": "object",
"properties": {
"a_objReportsection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Reportsection"
}
}
}
},
"Common-Reportcell": {
"description": "A cell in a Reportrow\n",
"required": [
"iReportcellColumnspan",
"iReportcellRowspan"
],
"type": "object",
"properties": {
"iReportcellColumnspan": {
"description": "The number of Reportcolumns the Reportcell spans",
"type": "integer",
"example": 1
},
"iReportcellRowspan": {
"description": "The number of Reportrows the Reportcell spans",
"type": "integer",
"example": 1
}
}
},
"Common-Reportcellstyle": {
"description": "Styles applied to a Reportcell\n",
"required": [
"bReportcellstyleBordertop",
"bReportcellstyleBorderbottom",
"bReportcellstyleBorderleft",
"bReportcellstyleBorderright",
"eReportcellHorizontalalignment",
"eReportcellVerticalalignment",
"eReportcellFontweight",
"eReportcellFontunderline"
],
"type": "object",
"properties": {
"bReportcellstyleBordertop": {
"description": "Whether there is a border at the top of the Reportcell",
"type": "boolean",
"example": true
},
"bReportcellstyleBorderbottom": {
"description": "Whether there is a border at the bottom of the Reportcell",
"type": "boolean",
"example": true
},
"bReportcellstyleBorderleft": {
"description": "Whether there is a border at the left of the Reportcell",
"type": "boolean",
"example": true
},
"bReportcellstyleBorderright": {
"description": "Whether there is a border at the right of the Reportcell",
"type": "boolean",
"example": true
},
"eReportcellHorizontalalignment": {
"$ref": "#/components/schemas/Enum-Horizontalalignment"
},
"eReportcellVerticalalignment": {
"$ref": "#/components/schemas/Enum-Verticalalignment"
},
"eReportcellFontweight": {
"$ref": "#/components/schemas/Enum-Fontweight"
},
"eReportcellFontunderline": {
"$ref": "#/components/schemas/Enum-Fontunderline"
}
}
},
"Common-Reportcolumn": {
"description": "A column in a Reportsection\n",
"required": [
"objReportcellstyleDefault",
"iReportcolumnWidth"
],
"type": "object",
"properties": {
"objReportcellstyleDefault": {
"$ref": "#/components/schemas/Common-Reportcellstyle"
},
"iReportcolumnWidth": {
"description": "The Reportcolumn width in pixels",
"type": "integer",
"example": 120
}
}
},
"Common-Reportgroup": {
"description": "A group of reports\n\nEach Reportgroup is for a specific recipient or for a specific context.",
"required": [
"a_objReport",
"a_objReportcellstyleCustom"
],
"type": "object",
"properties": {
"a_objReport": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Report"
}
},
"a_objReportcellstyleCustom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Reportcellstyle"
}
}
}
},
"Common-Reportrow": {
"description": "A row in a Reportsubsectionpart\n",
"required": [
"a_objReportcell",
"iReportrowHeight"
],
"type": "object",
"properties": {
"a_objReportcell": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Reportcell"
}
},
"iReportrowHeight": {
"description": "The reportrow height in pixels",
"type": "integer",
"example": 20
}
}
},
"Common-Reportsection": {
"description": "A section in a Report. Each Reportsection shares Reportcolumns disposition with all its Reportsubsection\n",
"required": [
"a_objReportsubsection",
"a_objReportcolumn",
"eReportsectionHorizontalalignment",
"iReportsectionColumncount",
"iReportsectionWidth"
],
"type": "object",
"properties": {
"a_objReportsubsection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Reportsubsection"
}
},
"a_objReportcolumn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Reportcolumn"
}
},
"eReportsectionHorizontalalignment": {
"$ref": "#/components/schemas/Enum-Horizontalalignment"
},
"iReportsectionColumncount": {
"description": "The number of Reportcolumns in the Reportsection",
"type": "integer",
"example": 5
},
"iReportsectionWidth": {
"description": "The combined width of all the Reportcolumns in the Reportsection",
"type": "integer",
"example": 1200
}
}
},
"Common-Reportsubsection": {
"description": "A Subsection in a Reportsection. It contains 3 Reportsubsectionparts (Header, Body and Footer)\n",
"required": [
"objReportsubsectionpartHeader",
"objReportsubsectionpartBody",
"objReportsubsectionpartFooter"
],
"type": "object",
"properties": {
"objReportsubsectionpartHeader": {
"$ref": "#/components/schemas/Common-Reportsubsectionpart"
},
"objReportsubsectionpartBody": {
"$ref": "#/components/schemas/Common-Reportsubsectionpart"
},
"objReportsubsectionpartFooter": {
"$ref": "#/components/schemas/Common-Reportsubsectionpart"
}
}
},
"Common-Reportsubsectionpart": {
"description": "A part in the Reportsubsection\n",
"required": [
"eReportsubsectionpartType",
"a_objReportrow"
],
"type": "object",
"properties": {
"eReportsubsectionpartType": {
"description": "The type of the Reportsubsectionpart",
"enum": [
"Header",
"Body",
"Footer"
],
"type": "string"
},
"a_objReportrow": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Reportrow"
}
}
}
},
"Common-Response": {
"description": "All API response will inherit this based Response",
"required": [
"objDebugPayload"
],
"type": "object",
"properties": {
"objDebugPayload": {
"$ref": "#/components/schemas/Common-Response-objDebugPayload"
},
"objDebug": {
"$ref": "#/components/schemas/Common-Response-objDebug"
}
}
},
"Common-Response-Error": {
"description": "Generic Error Message",
"required": [
"sErrorMessage",
"eErrorCode"
],
"type": "object",
"properties": {
"sErrorMessage": {
"$ref": "#/components/schemas/Field-sErrorMessage"
},
"eErrorCode": {
"$ref": "#/components/schemas/Field-eErrorCode"
}
}
},
"Common-Response-Error-EzsignformValidation": {
"description": "Generic Error Message",
"required": [
"a_objEzsignformfielderror"
],
"type": "object",
"allOf": [
{
"type": "object"
},
{
"$ref": "#/components/schemas/Common-Response-Error"
}
],
"properties": {
"a_objEzsignformfielderror": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignformfielderror-Response"
}
}
}
},
"Common-Response-Error-TooManyRequests": {
"description": "Generic Error Message",
"type": "object",
"allOf": [
{
"type": "object"
},
{
"$ref": "#/components/schemas/Common-Response-Error"
}
]
},
"Common-Response-Error-sTemporaryFileUrl": {
"description": "Generic Error Message",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"sTemporaryFileUrl": {
"description": "The Temporary File Url of the document that was uploaded. That url can be reused instead of uploading the file again.",
"type": "string",
"example": "http://www.example.com/document.pdf"
}
}
},
{
"$ref": "#/components/schemas/Common-Response-Error"
}
]
},
"Common-Response-Filter": {
"description": "Definition of Filters for getList",
"type": "object",
"properties": {
"a_AutoType": {
"description": "List of filters that can be used in *sFilter* (Automatic types)",
"type": "object",
"additionalProperties": {
"description": "The actual field name being filtered",
"type": "string"
}
},
"a_Enum": {
"$ref": "#/components/schemas/Common-Response-FilterEnum"
}
}
},
"Common-Response-FilterEnum": {
"description": "List of filters that can be used in *sFilter* (Enum types)",
"type": "object",
"additionalProperties": {
"description": "List of valid enum values",
"type": "object",
"additionalProperties": {
"description": "Corresponding sql statement",
"type": "string"
}
}
},
"Common-Response-Redirect-sSecretquestionTextX": {
"description": "352 Redirect Message containing secret question",
"required": [
"sSecretquestionTextX"
],
"type": "object",
"properties": {
"sSecretquestionTextX": {
"$ref": "#/components/schemas/Field-sSecretquestionTextX"
}
}
},
"Common-Response-Warning": {
"description": "Generic Warning Message",
"required": [
"sWarningMessage",
"eWarningCode"
],
"type": "object",
"properties": {
"sWarningMessage": {
"description": "More detail about the warning",
"type": "string"
},
"eWarningCode": {
"description": "The warning code. See documentation for valid values",
"type": "string"
}
}
},
"Common-Response-objDebug": {
"description": "This is a generic debug object that is returned by all API requests",
"required": [
"a_objSQLQuery",
"iSQLQueries",
"iSQLSelects",
"sMemoryUsage",
"sRunTime"
],
"type": "object",
"properties": {
"sMemoryUsage": {
"description": "The peak memory allocated during the API request execution. Formatted as a human readable string",
"type": "string"
},
"sRunTime": {
"description": "The total server execution time of the API request execution. Formatted as a human readable string",
"type": "string"
},
"iSQLSelects": {
"description": "The number of SQL SELECT queries that were sent to the database server during the API request execution",
"type": "integer"
},
"iSQLQueries": {
"description": "The number of SQL INSERT/UPDATE/DELETE queries that were sent to the database server during the API request execution",
"type": "integer"
},
"a_objSQLQuery": {
"description": "An array of the SQL Queries that were executed during the API request execution",
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Response-objSQLQuery"
}
}
},
"example": {
"sMemoryUsage": "11,923MB",
"sRunTime": "0.6084s",
"iSQLSelects": 3,
"iSQLQueries": 6,
"a_objSQLQuery": [
{
"sQuery": "SELECT * FROM table",
"fDuration": 0.0001
},
{
"sQuery": "SELECT * FROM table",
"fDuration": 0.0001
}
]
}
},
"Common-Response-objDebugPayload": {
"description": "This is a debug object containing debugging information on the actual function",
"required": [
"a_RequiredPermission",
"iVersionMax",
"iVersionMin",
"bVersionDeprecated"
],
"type": "object",
"properties": {
"iVersionMin": {
"description": "The minimum version of the function that can be called",
"type": "integer",
"example": 1
},
"iVersionMax": {
"description": "The maximum version of the function that can be called",
"type": "integer",
"example": 2
},
"a_RequiredPermission": {
"description": "An array of permissions required to access this function.\n\nIf the value \"0\" is present in the array, anyone can call this function.\n\nYou must have one of the permission to access the function. You don't need to have all of them.",
"type": "array",
"items": {
"type": "integer",
"example": 117
}
},
"bVersionDeprecated": {
"description": "Wheter the current route is deprecated or not",
"type": "boolean",
"example": false
}
}
},
"Common-Response-objDebugPayload_getList": {
"description": "This is a debug object containing debugging information on the actual function",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response-objDebugPayload"
},
{
"required": [
"a_Filter",
"a_OrderBy"
],
"type": "object",
"properties": {
"a_Filter": {
"$ref": "#/components/schemas/Common-Response-Filter"
},
"a_OrderBy": {
"description": "List of available values for *eOrderBy*",
"type": "object",
"additionalProperties": {
"description": "Corresponding sql statement",
"type": "string"
}
}
}
}
]
},
"Common-Response-objSQLQuery": {
"description": "Definition of objSQLQuery Object",
"required": [
"fDuration",
"sQuery"
],
"type": "object",
"properties": {
"sQuery": {
"description": "The SQL Query",
"type": "string"
},
"fDuration": {
"format": "float",
"description": "Execution time of the SQL Query in seconds",
"type": "number"
}
},
"example": {
"sQuery": "SELECT * FROM table",
"fDuration": 0.0001
}
},
"Common-Response_getList": {
"description": "All API response will inherit this based Response",
"required": [
"objDebugPayload"
],
"type": "object",
"properties": {
"objDebugPayload": {
"$ref": "#/components/schemas/Common-Response-objDebugPayload_getList"
},
"objDebug": {
"$ref": "#/components/schemas/Common-Response-objDebug"
}
}
},
"Common-Webhook": {
"description": "This is the base Webhook object",
"required": [
"objWebhook",
"a_objAttempt"
],
"type": "object",
"properties": {
"objWebhook": {
"$ref": "#/components/schemas/Custom-Webhook-Response"
},
"a_objAttempt": {
"description": "An array containing details of previous attempts that were made to deliver the message.\nThe array is empty if it's the first attempt.",
"type": "array",
"items": {
"$ref": "#/components/schemas/attempt-ResponseCompound"
}
}
}
},
"Common-getAutocomplete-v1-Response": {
"description": "Response for GET /1/object/xxx/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/Common-getAutocomplete-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"Common-getAutocomplete-v1-Response-mPayload": {
"description": "Generic Autocomplete Response",
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-AutocompleteElement-Response"
}
},
"Common-getList-v1-Response-mPayload": {
"description": "Generic List Response",
"required": [
"iRowReturned",
"iRowFiltered"
],
"type": "object",
"properties": {
"iRowReturned": {
"description": "The number of rows returned",
"type": "integer",
"example": 100
},
"iRowFiltered": {
"description": "The number of rows matching your filters (if any) or the total number of rows",
"type": "integer",
"example": 533
}
}
},
"Common-getReport-v1-Response": {
"description": "Response for POST /1/report/xxx/xxx and /1/module/report/getReportFromCache",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/Common-getReport-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"Common-getReport-v1-Response-mPayload": {
"description": "Payload for POST /1/report/xxx/xxx and and /1/module/report/getReportFromCache",
"required": [
"objReportgroup"
],
"type": "object",
"properties": {
"objReportgroup": {
"$ref": "#/components/schemas/Common-Reportgroup"
}
}
},
"Computed-bEzsigndocumentEzsignform": {
"description": "If the Ezsigndocument contains an Ezsignform or not",
"type": "boolean",
"example": true
},
"Computed-bEzsignfolderIsdisposable": {
"description": "If the Ezsigndocument can be disposed",
"type": "boolean",
"example": false
},
"Computed-bEzsigntemplateIncomplete": {
"description": "Indicate the Ezsigntemplate is incomplete and cannot be used",
"type": "boolean",
"example": false
},
"Computed-dtEzsignfolderDuedate": {
"description": "The maximum date and time at which the Ezsignfolder can be signed.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Computed-dtEzsignfolderScheduledarchive": {
"description": "The scheduled date and time at which the Ezsignfolder should be archived.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Computed-dtEzsignfolderScheduleddispose": {
"description": "The scheduled date at which the Ezsignfolder should be Disposed.",
"type": "string",
"example": "2020-12-31"
},
"Computed-eCommunicationDirection": {
"description": "The direction of the Communication",
"enum": [
"Outbound",
"Inbound"
],
"type": "string",
"example": "Outbound"
},
"Computed-eEzsigndocumentSteptype": {
"description": "Indicates whether the current step is a form or signatures.",
"enum": [
"Form",
"Sign",
"None"
],
"type": "string",
"example": "Sign"
},
"Computed-iCommunicationCount": {
"description": "The count of Communication.",
"type": "integer",
"example": 8
},
"Computed-iCommunicationrecipientCount": {
"description": "The count of Communicationrecipient",
"type": "integer",
"example": 8
},
"Computed-iEzsigndocumentStepformcurrent": {
"description": "The current step in the form filling phase",
"type": "integer",
"example": 1
},
"Computed-iEzsigndocumentStepformtotal": {
"description": "The total number of steps in the form filling phase",
"type": "integer",
"example": 2
},
"Computed-iEzsigndocumentStepsignatureCurrent": {
"description": "The current step in the signature phase",
"type": "integer",
"example": 0
},
"Computed-iEzsigndocumentStepsignaturetotal": {
"description": "The total number of steps in the signature filling phase",
"type": "integer",
"example": 2
},
"Computed-iEzsignfolderSignaturesigned": {
"description": "The number of signatures that were signed in the Ezsignfolder.",
"type": "integer",
"example": 3
},
"Computed-iEzsignfolderSignaturetotal": {
"description": "The number of total signatures that were requested in the Ezsignfolder",
"type": "integer",
"example": 4
},
"Computed-iEzsignsignatureattachmentCount": {
"description": "The count of Ezsignsignatureattachment",
"type": "integer",
"example": 7
},
"Computed-iEzsigntemplateFormfieldtotal": {
"description": "The number of total form fields in the Ezsigntemplate.",
"type": "integer",
"example": 8
},
"Computed-iEzsigntemplateSignaturetotal": {
"description": "The number of total signatures in the Ezsigntemplate.",
"type": "integer",
"example": 8
},
"Computed-iNotificationtest": {
"description": "The number of elements returned by the Notificationtest",
"type": "integer",
"example": 27
},
"Computed-sAvatarUrl": {
"description": "The url of the picture used as avatar",
"type": "string",
"example": "http://www.website.com/avatar.jpg"
},
"Computed-sBrandingLogourl": {
"description": "The url of the picture used as logo in the Branding",
"type": "string",
"example": "http://www.example.com/logo.jpg"
},
"Computed-sCommunicationBodyurl": {
"description": "The url of the body used as body in the Communication",
"type": "string",
"example": "http://www.example.com/4526.html"
},
"Computed-sCommunicationRecipient": {
"description": "The recipients' name of the Communication",
"type": "string",
"example": "Jane Doe"
},
"Computed-sCommunicationSender": {
"description": "The sender name of the Communication",
"type": "string",
"example": "John Doe"
},
"Computed-sSessionhistoryDuration": {
"description": "The duration of the session",
"pattern": "^(0[0-9]{1}|\\d{2,}):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "01:52:01"
},
"Computed-sSignatureUrl": {
"description": "The URL of the SVG file for the Signature",
"pattern": "^.{0,2048}$",
"type": "string",
"example": "https://www.example.com/signature.svg"
},
"Computed-sUserName": {
"description": "The description of the User in the language of the requester",
"type": "string",
"example": "Default"
},
"Computed-sWebhookEvent": {
"description": "The concatenated string to describe the Webhook event",
"type": "string",
"example": "Ezsign-DocumentCompleted"
},
"Custom-AutocompleteElement-Response": {
"description": "Generic AutocompleteElement Response",
"required": [
"sCategory",
"sLabel",
"sValue",
"bActive"
],
"type": "object",
"properties": {
"sCategory": {
"description": "The Category for the dropdown or an empty string if not categorized",
"type": "string"
},
"sLabel": {
"description": "The Description of the element",
"type": "string"
},
"sValue": {
"description": "The Unique ID of the element",
"type": "string"
},
"mValue": {
"deprecated": true,
"description": "The Unique ID of the element",
"type": "string"
},
"bActive": {
"description": "Indicates if the element is active",
"type": "boolean"
}
}
},
"Custom-CommunicationListElement-Response": {
"description": "A Communication List Element",
"required": [
"pkiCommunicationID",
"pkiCommunicationID",
"dtCreatedDate",
"eCommunicationDirection",
"eCommunicationImportance",
"eCommunicationType",
"iCommunicationrecipientCount",
"sCommunicationSubject",
"sCommunicationSender",
"sCommunicationRecipient"
],
"type": "object",
"properties": {
"pkiCommunicationID": {
"$ref": "#/components/schemas/Field-pkiCommunicationID"
},
"dtCreatedDate": {
"$ref": "#/components/schemas/Field-dtCreatedDate"
},
"eCommunicationDirection": {
"$ref": "#/components/schemas/Computed-eCommunicationDirection"
},
"eCommunicationImportance": {
"$ref": "#/components/schemas/Field-eCommunicationImportance"
},
"eCommunicationType": {
"$ref": "#/components/schemas/Field-eCommunicationType"
},
"iCommunicationrecipientCount": {
"$ref": "#/components/schemas/Computed-iCommunicationrecipientCount"
},
"sCommunicationSubject": {
"$ref": "#/components/schemas/Field-sCommunicationSubject"
},
"sCommunicationSender": {
"$ref": "#/components/schemas/Computed-sCommunicationSender"
},
"sCommunicationRecipient": {
"$ref": "#/components/schemas/Computed-sCommunicationRecipient"
}
}
},
"Custom-ContactName-Response": {
"description": "A Custom ContactName Object",
"required": [],
"type": "object",
"properties": {
"sContactFirstname": {
"$ref": "#/components/schemas/Field-sContactFirstname"
},
"sContactLastname": {
"$ref": "#/components/schemas/Field-sContactLastname"
},
"sContactCompany": {
"$ref": "#/components/schemas/Field-sContactCompany"
}
}
},
"Custom-Creditcardtransaction-Response": {
"description": "A custom Creditcardtransaction Object",
"required": [
"sCreditcardtypeCodename",
"dCreditcardtransactionAmount",
"sCreditcardtransactionPartiallydecryptednumber",
"sCreditcardtransactionReferencenumber"
],
"type": "object",
"properties": {
"eCreditcardtypeCodename": {
"$ref": "#/components/schemas/Field-eCreditcardtypeCodename"
},
"dCreditcardtransactionAmount": {
"$ref": "#/components/schemas/Field-dCreditcardtransactionAmount"
},
"sCreditcardtransactionPartiallydecryptednumber": {
"$ref": "#/components/schemas/Field-sCreditcardtransactionPartiallydecryptednumber"
},
"sCreditcardtransactionReferencenumber": {
"$ref": "#/components/schemas/Field-sCreditcardtransactionReferencenumber"
}
}
},
"Custom-DropdownElement-Request": {
"description": "Generic DropdownElement Request",
"required": [
"sLabel",
"sValue"
],
"type": "object",
"properties": {
"sLabel": {
"description": "The Description of the element",
"type": "string"
},
"sValue": {
"description": "The Value of the element",
"type": "string"
}
}
},
"Custom-DropdownElement-RequestCompound": {
"description": "A Generic DropdownElement Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Custom-DropdownElement-Request"
}
]
},
"Custom-DropdownElement-Response": {
"description": "Generic DropdownElement Response",
"required": [
"sLabel",
"sValue"
],
"type": "object",
"properties": {
"sLabel": {
"description": "The Description of the element",
"type": "string"
},
"sValue": {
"description": "The Value of the element",
"type": "string"
}
}
},
"Custom-DropdownElement-ResponseCompound": {
"description": "A Generic DropdownElement Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Custom-DropdownElement-Response"
}
]
},
"Custom-EzmaxinvoicingEzsigndocument-Response": {
"description": "An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinvoicing for an Ezsigndocument",
"type": "object",
"allOf": [
{
"required": [
"fkiEzsignfolderID",
"sName",
"sEzsignfolderDescription",
"sEzsigndocumentName",
"bEzsignfolderAllowed"
],
"type": "object",
"properties": {
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"sName": {
"type": "string"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"sEzsigndocumentName": {
"$ref": "#/components/schemas/Field-sEzsigndocumentName"
},
"bEzsignfolderAllowed": {
"description": "Whether you have access to the Ezsignfolder or not",
"type": "boolean"
}
}
}
]
},
"Custom-EzmaxinvoicingEzsignfolder-Response": {
"description": "An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoicing for an Ezsignfolder",
"type": "object",
"allOf": [
{
"required": [
"fkiEzsignfolderID",
"sEzsignfolderDescription",
"bEzsigntsarequirementBillable",
"bEzsignfolderMfaused",
"bEzsignfolderPaymentused",
"bEzsignfolderAllowed"
],
"type": "object",
"properties": {
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"bEzsigntsarequirementBillable": {
"$ref": "#/components/schemas/Field-bEzsigntsarequirementBillable"
},
"bEzsignfolderMfaused": {
"$ref": "#/components/schemas/Field-bEzsignfolderMfaused"
},
"bEzsignfolderPaymentused": {
"$ref": "#/components/schemas/Field-bEzsignfolderPaymentused"
},
"bEzsignfolderAllowed": {
"description": "Whether you have access to the Ezsignfolder or not",
"type": "boolean"
}
}
}
]
},
"Custom-Ezmaxpricing-Response": {
"description": "A Custom Ezmaxpricing Object",
"required": [
"pkiEzmaxpricingID",
"dEzmaxpricingRebateezsignallagents",
"dtEzmaxpricingStart"
],
"type": "object",
"properties": {
"pkiEzmaxpricingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxpricingID"
},
"dEzmaxpricingRebateezsignallagents": {
"$ref": "#/components/schemas/Field-dEzmaxpricingRebateezsignallagents"
},
"dtEzmaxpricingStart": {
"$ref": "#/components/schemas/Field-dtEzmaxpricingStart"
},
"dtEzmaxpricingEnd": {
"$ref": "#/components/schemas/Field-dtEzmaxpricingEnd"
}
}
},
"Custom-EzsigndocumentEzsignsignaturesAutomatic-Response": {
"description": "An Ezsigndocument Object in the context of an EzsignsignaturesAutomatic path",
"required": [
"pkiEzsigndocumentID",
"sEzsigndocumentName",
"a_objEzsignsignature"
],
"type": "object",
"properties": {
"pkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"sEzsigndocumentName": {
"$ref": "#/components/schemas/Field-sEzsigndocumentName"
},
"a_objEzsignsignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignsignatureEzsignsignaturesAutomatic-Response"
}
}
}
},
"Custom-EzsignfolderEzsignsignaturesAutomatic-Response": {
"description": "An Ezsignfolder Object in the context of an EzsignsignaturesAutomatic path",
"required": [
"pkiEzsignfolderID",
"sEzsignfolderDescription",
"a_objEzsigndocument"
],
"type": "object",
"properties": {
"pkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"a_objEzsigndocument": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsigndocumentEzsignsignaturesAutomatic-Response"
}
}
}
},
"Custom-EzsignfoldersignerassociationActionableElement-Response": {
"description": "A Ezsignfoldersignerassociation Object with actionable elements",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound"
},
{
"required": [
"bEzsignfoldersignerassociationHasactionableelementsCurrent",
"bEzsignfoldersignerassociationHasctionableelementsFuture"
],
"type": "object",
"properties": {
"bEzsignfoldersignerassociationHasactionableelementsCurrent": {
"description": "Indicates if the Ezsignfoldersignerassociation has actionable elements in the current step",
"type": "boolean"
},
"bEzsignfoldersignerassociationHasactionableelementsFuture": {
"description": "Indicates if the Ezsignfoldersignerassociation has actionable elements in a future step",
"type": "boolean"
}
}
}
]
},
"Custom-Ezsignfoldersignerassociationmessage-Request": {
"description": "A custom message Object in the context of an Ezsignfolder's send function",
"required": [
"fkiEzsignfoldersignerassociationID",
"tEzignfoldersignerassociationMessage"
],
"type": "object",
"properties": {
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"tEzsignfoldersignerassociationMessage": {
"$ref": "#/components/schemas/Field-tEzsignfoldersignerassociationMessage"
}
}
},
"Custom-Ezsignfoldersignerassociationmine-Response": {
"description": "A custom Ezsignfoldersignerassociation Object",
"required": [
"pkiEzsignfoldersignerassociationID",
"fkiEzsignfolderID"
],
"type": "object",
"properties": {
"pkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
}
}
},
"Custom-Ezsignfoldersignerassociationstatus-Response": {
"description": "A Ezsignfoldersignerassociationstatus Object and children to create a complete structure",
"required": [
"fkiEzsignfoldersignerassociationID",
"a_objEzsignsignaturestatus"
],
"type": "object",
"properties": {
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"sEzsignfoldersignerassociationstatusLastname": {
"deprecated": true,
"description": "The last name of the Ezsignsigner",
"type": "string",
"example": "Doe"
},
"sEzsignfoldersignerassociationstatusFirstname": {
"deprecated": true,
"description": "The first name of the Ezsignsigner",
"type": "string",
"example": "John"
},
"sEzsignfoldersignerassociationstatusDescriptionX": {
"description": "The description of the Ezsignsigner",
"type": "string",
"example": "John Doe"
},
"a_objEzsignsignaturestatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignsignaturestatus-Response"
}
}
}
},
"Custom-Ezsignfoldertransmission-Response": {
"description": "An Ezsignfolder Object in the context of an Ezsignbulksendtransmission",
"required": [
"pkiEzsignfolderID",
"sEzsignfolderDescription",
"eEzsignfolderStep",
"iEzsignfolderSignaturetotal",
"iEzsignfolderSignaturesigned",
"a_objEzsignfoldertransmissionSigner"
],
"type": "object",
"properties": {
"pkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"eEzsignfolderStep": {
"$ref": "#/components/schemas/Field-eEzsignfolderStep"
},
"iEzsignfolderSignaturetotal": {
"$ref": "#/components/schemas/Computed-iEzsignfolderSignaturetotal"
},
"iEzsignfolderSignaturesigned": {
"$ref": "#/components/schemas/Computed-iEzsignfolderSignaturesigned"
},
"a_objEzsignfoldertransmissionSigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfoldertransmissionSigner-Response"
}
}
}
},
"Custom-EzsignfoldertransmissionSigner-Response": {
"description": "A form Signer Object in the context of an Ezsignfoldertransmissions",
"required": [
"sContactFirstname",
"sContactLastname"
],
"type": "object",
"properties": {
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sContactFirstname": {
"$ref": "#/components/schemas/Field-sContactFirstname"
},
"sContactLastname": {
"$ref": "#/components/schemas/Field-sContactLastname"
}
}
},
"Custom-Ezsignformfield-Request": {
"description": "A Custom Ezsignformfield Object to fill an Ezsignform using submitForm",
"type": "object",
"allOf": [
{
"type": "object",
"properties": {
"pkiEzsignformfieldID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldID"
},
"sEzsignformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldLabel"
},
"bEzsignformfieldSelected": {
"$ref": "#/components/schemas/Field-bEzsignformfieldSelected"
},
"sEzsignformfieldEnteredvalue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldEnteredvalue"
}
}
}
]
},
"Custom-Ezsignformfielderror-Response": {
"description": "A Custom Ezsignformfield Object to contain an error list",
"type": "object",
"allOf": [
{
"required": [
"sEzsignformfieldLabel",
"a_objEzsignformfielderrortest"
],
"type": "object",
"properties": {
"sEzsignformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldLabel"
},
"a_objEzsignformfielderrortest": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignformfielderrortest-Response"
}
}
}
}
]
},
"Custom-Ezsignformfielderrortest-Response": {
"description": "A Custom Ezsignformfielderrortest Object to contain the detail of the test error",
"type": "object",
"allOf": [
{
"required": [
"sEzsignformfielderrortestName",
"sEzsignformfielderrortestDetail"
],
"type": "object",
"properties": {
"sEzsignformfielderrortestName": {
"description": "The name of the test",
"pattern": "^.{0,50}$",
"type": "string"
},
"sEzsignformfielderrortestDetail": {
"description": "The detail why the test failed",
"pattern": "^.{0,255}$",
"type": "string"
}
}
}
]
},
"Custom-Ezsignformfieldgroup-Request": {
"description": "A Custom Ezsignformfieldgroup Object to fill an Ezsignform using submitForm",
"type": "object",
"allOf": [
{
"required": [
"a_objEzsignformfield"
],
"type": "object",
"properties": {
"pkiEzsignformfieldgroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
},
"sEzsignformfieldgroupLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupLabel"
},
"a_objEzsignformfield": {
"description": "An array containing all the values to fill the Ezsignform.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignformfield-Request"
}
}
}
}
]
},
"Custom-EzsignsignatureEzsignsignaturesAutomatic-Response": {
"description": "An Ezsignsignature Object in the context of an EzsignsignaturesAutomatic path",
"required": [
"pkiEzsignsignatureID",
"eEzsignsignatureType",
"iEzsignpagePagenumber"
],
"type": "object",
"properties": {
"pkiEzsignsignatureID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"eEzsignsignatureType": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
}
}
},
"Custom-Ezsignsignaturestatus-Response": {
"description": "A Ezsignsignaturestatus Object and children to create a complete structure",
"required": [
"eEzsignsignaturestatusSteptype",
"iEzsignsignaturestatusStep",
"iEzsignsignaturestatusTotal",
"iEzsignsignaturestatusSigned"
],
"type": "object",
"properties": {
"eEzsignsignaturestatusSteptype": {
"description": "Type of step",
"enum": [
"Form",
"Signature"
],
"type": "string"
},
"iEzsignsignaturestatusStep": {
"description": "The step at which the Ezsignsigner will be invited to sign or fill the form fields",
"type": "integer",
"example": 1
},
"iEzsignsignaturestatusTotal": {
"description": "The total number of signature or form fields the Ezsignsigner must process at the current step",
"type": "integer",
"example": 2
},
"iEzsignsignaturestatusSigned": {
"description": "The number of signature or form fields the Ezsignsigner has already processed at the current step",
"type": "integer",
"example": 1
}
}
},
"Custom-FormDataDocument-Response": {
"description": "A form Data Document Object ",
"required": [
"pkiEzsigndocumentID",
"fkiEzsignfolderID",
"sEzsigndocumentName",
"dtModifiedDate",
"a_objFormDataSigner"
],
"type": "object",
"properties": {
"pkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"sEzsigndocumentName": {
"$ref": "#/components/schemas/Field-sEzsigndocumentName"
},
"dtModifiedDate": {
"$ref": "#/components/schemas/Field-dtModifiedDate"
},
"a_objFormDataSigner": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-FormDataSigner-Response"
}
}
}
},
"Custom-FormDataEzsignformfield-Response": {
"description": "An Ezsignformfield Object",
"required": [
"sEzsignformfieldLabel",
"sEzsignformfieldValue"
],
"type": "object",
"properties": {
"sEzsignformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldLabel"
},
"sEzsignformfieldValue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldValue"
}
}
},
"Custom-FormDataEzsignformfieldgroup-Response": {
"description": "An FormDataSigner->Ezsignformfieldgroup Object and children to create a complete structure",
"required": [
"a_objEzsignformfield",
"sEzsignformfieldgroupLabel"
],
"type": "object",
"properties": {
"sEzsignformfieldgroupLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupLabel"
},
"a_objEzsignformfield": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-FormDataEzsignformfield-Response"
}
}
}
},
"Custom-FormDataSigner-Response": {
"description": "A form Data Signer Object",
"required": [
"a_objEzsignformfieldgroup",
"fkiEzsignfoldersignerassociationID",
"sContactFirstname",
"sContactLastname"
],
"type": "object",
"properties": {
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sContactFirstname": {
"$ref": "#/components/schemas/Field-sContactFirstname"
},
"sContactLastname": {
"$ref": "#/components/schemas/Field-sContactLastname"
},
"a_objEzsignformfieldgroup": {
"uniqueItems": false,
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-FormDataEzsignformfieldgroup-Response"
}
}
}
},
"Custom-FormsDataFolder-Response": {
"description": "A forms Data Folder Object",
"required": [
"pkiEzsignfolderID",
"sEzsignfolderDescription",
"a_objFormDataDocument"
],
"type": "object",
"properties": {
"pkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"a_objFormDataDocument": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-FormDataDocument-Response"
}
}
}
},
"Custom-ImportEzsigntemplatepackageRelation-Request": {
"description": "The object used in /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage Request",
"required": [
"fkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"fkiEzsigntemplatepackagesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"sEzsigntemplatepackagesignerDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackagesignerDescription"
}
}
},
"Custom-Notificationsubsectiongetnotificationtests-Response": {
"description": "A Notificationsubsection Object in the context of getNotificationtests",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/notificationsubsection-Response"
},
{
"required": [
"a_objNotificationtest"
],
"type": "object",
"properties": {
"a_objNotificationtest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Notificationtestgetnotificationtests-Response"
}
}
}
}
]
},
"Custom-Notificationtestgetnotificationtests-Response": {
"description": "A Notificationtest Object in the context of getNotificationtests",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/notificationtest-Response"
},
{
"required": [
"eNotificationpreferenceStatus",
"iNotificationtest"
],
"type": "object",
"properties": {
"eNotificationpreferenceStatus": {
"$ref": "#/components/schemas/Field-eNotificationpreferenceStatus"
},
"iNotificationtest": {
"$ref": "#/components/schemas/Computed-iNotificationtest"
}
}
}
]
},
"Custom-User-Response": {
"description": "A User Object",
"required": [
"pkiUserID",
"fkiEzsignfoldersignerassociationID",
"sContactFirstname",
"sContactLastname",
"sUserLastname",
"sUserFirstname",
"sEmailAddress"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
}
}
},
"Custom-Variableobject-Response": {
"description": "A Variable object without predefined property names",
"type": "object",
"additionalProperties": true
},
"Custom-Webhook-Response": {
"description": "A custom Webhook object",
"type": "object",
"allOf": [
{
"required": [
"pksCustomerCode",
"bWebhookTest"
],
"type": "object",
"properties": {
"pksCustomerCode": {
"$ref": "#/components/schemas/Field-pksCustomerCode"
},
"bWebhookTest": {
"description": "Wheter the webhook received is a manual test or a real event",
"type": "boolean"
}
}
},
{
"$ref": "#/components/schemas/webhook-Response"
}
]
},
"Custom-Webhooklog-Response": {
"description": "A custom Webhooklog object",
"type": "object",
"allOf": [
{
"required": [
"dtWebhooklogDate",
"tWebhooklogJson"
],
"type": "object",
"properties": {
"dtWebhooklogDate": {
"$ref": "#/components/schemas/Field-dtWebhooklogDate"
},
"tWebhooklogJson": {
"$ref": "#/components/schemas/Field-tWebhooklogJson"
}
}
}
]
},
"Custom-WordPositionOccurence-Response": {
"description": "A Word Position Object",
"type": "object",
"properties": {
"iPage": {
"description": "The page where the word occurence was found",
"minimum": 1,
"type": "integer"
},
"iX": {
"description": "The X coordinate (Horizontal) where the Word occurence was found.\n\nCoordinate is calculated at 100dpi (dot per inch).",
"minimum": 0,
"type": "integer"
},
"iY": {
"description": "The Y coordinate (Vertical) where the Word occurence was found.\n\nCoordinate is calculated at 100dpi (dot per inch).",
"minimum": 0,
"type": "integer"
}
}
},
"Custom-WordPositionWord-Response": {
"description": "A Word Position Object",
"required": [
"sWord",
"a_objWordPositionOccurence"
],
"type": "object",
"properties": {
"sWord": {
"description": "The searched word",
"type": "string"
},
"a_objWordPositionOccurence": {
"description": "The found occurences for the seached word",
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-WordPositionOccurence-Response"
}
}
}
},
"Enum-Fontunderline": {
"description": "The Font Underline style",
"enum": [
"None",
"Single",
"Double"
],
"type": "string",
"example": "None"
},
"Enum-Fontweight": {
"description": "The Font Weight",
"enum": [
"Normal",
"Bold"
],
"type": "string",
"example": "Normal"
},
"Enum-Horizontalalignment": {
"description": "The Horizontal alignment",
"enum": [
"Center",
"Left",
"Right"
],
"type": "string",
"example": "Center"
},
"Enum-Textvalidation": {
"description": "The text validation",
"enum": [
"None",
"Date (YYYY-MM-DD)",
"Date (MM/DD/YYYY)",
"Date (MM/DD/YY)",
"Date (DD/MM/YYYY)",
"Date (DD/MM/YY)",
"Email",
"Letters",
"Numbers",
"Zip",
"Zip+4",
"PostalCode",
"Custom"
],
"type": "string",
"example": "None"
},
"Enum-Verticalalignment": {
"description": "The Vertical alignment",
"enum": [
"Bottom",
"Middle",
"Top"
],
"type": "string",
"example": "Bottom"
},
"Field-bActivesessionDebug": {
"description": "Whether the active session is in debug or not",
"type": "boolean",
"example": false
},
"Field-bActivesessionIssuperadmin": {
"description": "Whether the active session is superadmin or not",
"type": "boolean",
"example": false
},
"Field-bApikeyIsactive": {
"description": "Whether the apikey is active or not",
"type": "boolean",
"example": true
},
"Field-bApikeyIssigned": {
"description": "Whether the apikey is signed or not",
"type": "boolean",
"example": true
},
"Field-bBillingentityexternalIsactive": {
"description": "Whether the Billingentityexternal is active or not",
"type": "boolean",
"example": true
},
"Field-bBillingentityinternalIsactive": {
"description": "Whether the Billingentityinternal is active or not",
"type": "boolean",
"example": true
},
"Field-bBrandingIsactive": {
"description": "Whether the Branding is active or not",
"type": "boolean",
"example": true
},
"Field-bCommunicationPrivate": {
"description": "Whether the Communication is private or not",
"type": "boolean",
"example": false
},
"Field-bCompanyIsactive": {
"description": "Whether the Company is active or not",
"type": "boolean",
"example": true
},
"Field-bDepartmentIsactive": {
"description": "Whether the Department is active or not",
"type": "boolean",
"example": true
},
"Field-bEmailtypeIsactive": {
"description": "Whether the Emailtype is active or not",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingIsactive": {
"description": "Whether the Ezmaxinvoicing is active or not",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingRebateEzsignallagents": {
"description": "Whether the rebate for eZsign is for all agents",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingagentBillableezmax": {
"description": "Whether it is billable for eZmax",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingagentBillableezsign": {
"description": "Whether it is billable for eZsign",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingagentEzsignaccount": {
"description": "Whether the agent has an eZsign account",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingcontractEzsignallagents": {
"description": "Whether eZsign is for all agents",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingsummaryexternaldetailAdjustment": {
"description": "Whether it's an adjustment",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingsummaryglobalAdjustment": {
"description": "Whether it is adjustment for the Ezmaxinvoicingsummaryglobal",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicingsummaryinternaldetailAdjustment": {
"description": "Whether if it's an adjustment",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicinguserBillableezsign": {
"description": "Whether it is billable for eZsign",
"type": "boolean",
"example": true
},
"Field-bEzmaxinvoicinguserEzsignaccount": {
"description": "Whether there is an eZsign account",
"type": "boolean",
"example": true
},
"Field-bEzmaxproductIsactive": {
"description": "Whether the Ezmaxproduct is active or not",
"type": "boolean",
"example": true
},
"Field-bEzsignbulksendIsactive": {
"description": "Whether the Ezsignbulksend is active or not",
"type": "boolean",
"example": true
},
"Field-bEzsignbulksendNeedvalidation": {
"description": "Whether the Ezsigntemplatepackage was automatically modified and needs a manual validation",
"type": "boolean"
},
"Field-bEzsigndocumentHassignedsignatures": {
"description": "If the Ezsigndocument contains signed signatures (From internal or external sources)",
"type": "boolean",
"example": true
},
"Field-bEzsignfolderMfaused": {
"description": "Whether the MFA was used or not for the Ezsignfolder",
"type": "boolean",
"example": true
},
"Field-bEzsignfolderPaymentused": {
"description": "Whether there was a signature is of type payment",
"type": "boolean",
"example": true
},
"Field-bEzsignfoldersignerassociationDelayedsend": {
"description": "If this flag is true the signatory is part of a delayed send.",
"type": "boolean"
},
"Field-bEzsignfoldersignerassociationReceivecopy": {
"description": "If this flag is true. The signatory will receive a copy of every signed Ezsigndocument even if it ain't required to sign the document.",
"type": "boolean"
},
"Field-bEzsignfoldertypeIncludeproofsigner": {
"description": "Whether we include the proof with the signed Ezsigndocument for Ezsignsigners",
"type": "boolean",
"example": true
},
"Field-bEzsignfoldertypeIncludeproofuser": {
"description": "Whether we include the proof with the signed Ezsigndocument for users",
"type": "boolean",
"example": true
},
"Field-bEzsignfoldertypeIsactive": {
"description": "Whether the Ezsignfoldertype is active or not",
"type": "boolean",
"example": true
},
"Field-bEzsignfoldertypeSendattatchmentsigner": {
"description": "Whether we send the Ezsigndocument and the proof as attachment in the email",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsignedtocolleague": {
"description": "Whether we send the signed Ezsigndocument to the colleagues",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsignedtodocumentowner": {
"description": "Whether we send the signed Ezsigndocument to the Ezsigndocument's owner",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsignedtofolderowner": {
"description": "Whether we send the signed Ezsigndocument to the Ezsignfolder's owner",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsignedtofullgroup": {
"description": "Whether we send the signed Ezsigndocument to the Usergroup that has acces to all Ezsignfolders",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsignedtolimitedgroup": {
"description": "Whether we send the signed Ezsigndocument to the Usergroup that has acces to only their own Ezsignfolders",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsummarytocolleague": {
"description": "Whether we send the summary to the colleagues",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsummarytodocumentowner": {
"description": "Whether we send the summary to the Ezsigndocument's owner",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsummarytofolderowner": {
"description": "Whether we send the summary to the Ezsignfolder's owner",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsummarytofullgroup": {
"description": "Whether we send the summary to the Usergroup that has acces to all Ezsignfolders",
"type": "boolean",
"example": false
},
"Field-bEzsignfoldertypeSendsummarytolimitedgroup": {
"description": "Whether we send the summary to the Usergroup that has acces to only their own Ezsignfolders",
"type": "boolean",
"example": false
},
"Field-bEzsignformfieldSelected": {
"description": "Whether the Ezsignformfield is selected or not by default.\n\nThis can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio**",
"type": "boolean"
},
"Field-bEzsignformfieldgroupEncrypted": {
"description": "Whether the Ezsignformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument.\nThis can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**",
"type": "boolean"
},
"Field-bEzsignformfieldgroupReadonly": {
"description": "Whether the Ezsignformfieldgroup is read only or not.",
"type": "boolean"
},
"Field-bEzsignsignatureCustomdate": {
"description": "Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**)",
"type": "boolean"
},
"Field-bEzsignsignatureRequired": {
"description": "Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments.",
"type": "boolean"
},
"Field-bEzsigntemplateAdminonly": {
"description": "Whether the Ezsigntemplate can be accessed by admin users only (eUserType=Normal)",
"type": "boolean"
},
"Field-bEzsigntemplateIsactive": {
"description": "Whether the Ezsigntemplate is active or not",
"type": "boolean",
"example": true
},
"Field-bEzsigntemplatedocumentHassignedsignatures": {
"description": "If the Ezsigntemplatedocument contains signed signatures (From internal or external sources)",
"type": "boolean",
"example": true
},
"Field-bEzsigntemplateformfieldSelected": {
"description": "Whether the Ezsigntemplateformfield is selected or not by default.\n\nThis can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio**",
"type": "boolean"
},
"Field-bEzsigntemplateformfieldgroupEncrypted": {
"description": "Whether the Ezsigntemplateformfieldgroup is encrypted in the database or not. Encrypted values are not displayed on the Ezsigndocument.\nThis can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**",
"type": "boolean"
},
"Field-bEzsigntemplateformfieldgroupReadonly": {
"description": "Whether the Ezsigntemplateformfieldgroup is read only or not.",
"type": "boolean"
},
"Field-bEzsigntemplatepackageAdminonly": {
"description": "Whether the Ezsigntemplatepackage can be accessed by admin users only (eUserType=Normal)",
"type": "boolean"
},
"Field-bEzsigntemplatepackageIsactive": {
"description": "Whether the Ezsigntemplatepackage is active or not",
"type": "boolean",
"example": true
},
"Field-bEzsigntemplatepackageNeedvalidation": {
"description": "Whether the Ezsignbulksend was automatically modified and needs a manual validation",
"type": "boolean"
},
"Field-bEzsigntemplatesignatureCustomdate": {
"description": "Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**)",
"type": "boolean"
},
"Field-bEzsigntemplatesignatureRequired": {
"description": "Whether the Ezsigntemplatesignature is required or not. This field is relevant only with Ezsigntemplatesignature with eEzsigntemplatesignatureType = Attachments.",
"type": "boolean"
},
"Field-bEzsigntsarequirementBillable": {
"description": "Whether the TSA requirement is billable or not",
"type": "boolean",
"example": true
},
"Field-bEzsigntsarequirementIsactive": {
"description": "Whether the Ezsigntsarequirement is active or not",
"type": "boolean",
"example": true
},
"Field-bFontIsactive": {
"description": "Whether the Font is active or not",
"type": "boolean",
"example": true
},
"Field-bFranchisebrokerIsactive": {
"description": "Whether the Franchisebroker is active or not",
"type": "boolean",
"example": true
},
"Field-bFranchiseofficeIsactive": {
"description": "Whether the Franchiseoffice is active or not",
"type": "boolean",
"example": true
},
"Field-bModuleRegistered": {
"description": "Whether the Module is registered or not",
"type": "boolean",
"example": true
},
"Field-bModuleRegisteredapi": {
"description": "Whether the Module is registered or not for api use",
"type": "boolean",
"example": true
},
"Field-bPaymenttermIsactive": {
"description": "Whether the Paymentterm is active or not",
"type": "boolean",
"example": true
},
"Field-bPeriodIsactive": {
"description": "Whether the Period is active or not",
"type": "boolean",
"example": true
},
"Field-bPhonetypeIsactive": {
"description": "Whether the Phonetype is active or not",
"type": "boolean",
"example": true
},
"Field-bSecretquestionIsactive": {
"description": "Whether the Secretquestion is active or not",
"type": "boolean",
"example": true
},
"Field-bSystemconfigurationEzsignpersonnal": {
"description": "Whether if we allow the creation of personal files in eZsign",
"type": "boolean",
"example": true
},
"Field-bSystemconfigurationSspr": {
"description": "Whether if we allow SSPR",
"type": "boolean",
"example": true
},
"Field-bTaxassignmentIsactive": {
"description": "Whether the Taxassignment is active or not",
"type": "boolean",
"example": true
},
"Field-bTextstylestaticBold": {
"description": "Whether the Textstylestatic is Bold or not",
"type": "boolean",
"example": true
},
"Field-bTextstylestaticItalic": {
"description": "Whether the Textstylestatic is Italic or not",
"type": "boolean",
"example": true
},
"Field-bTextstylestaticStrikethrough": {
"description": "Whether the Textstylestatic is Strikethrough or not",
"type": "boolean",
"example": true
},
"Field-bTextstylestaticUnderline": {
"description": "Whether the Textstylestatic is Underline or not",
"type": "boolean",
"example": true
},
"Field-bTimezoneIsactive": {
"description": "Whether the Timezone is active or not",
"type": "boolean",
"example": true
},
"Field-bUserAttachmentautoverified": {
"description": "Whether if Attachments uploaded by the User must be validated or not",
"type": "boolean",
"example": true
},
"Field-bUserChangepassword": {
"description": "Whether if the User is forced to change its password",
"type": "boolean",
"example": true
},
"Field-bUserInterfacedark": {
"description": "Whether to use a dark mode interface",
"type": "boolean",
"example": false
},
"Field-bUserIsactive": {
"description": "Whether the User is active or not",
"type": "boolean",
"example": true
},
"Field-bUserValidatebyadministration": {
"description": "Whether if the transactions in which the User is implicated must be validated by administrative personnel or not",
"type": "boolean",
"example": false
},
"Field-bUserValidatebydirector": {
"description": "Whether if the transactions in which the User is implicated must be validated by a director or not",
"type": "boolean",
"example": false
},
"Field-bUsergroupIsactive": {
"description": "Whether the Usergroup is active or not",
"type": "boolean",
"example": true
},
"Field-bVariableexpenseIsactive": {
"description": "Whether the variableexpense is active or not",
"type": "boolean",
"example": true
},
"Field-bVersionhistoryDraft": {
"description": "Whether the Versionhistory is published or still a draft",
"type": "boolean"
},
"Field-bWebhookIsactive": {
"description": "Whether the Webhook is active or not",
"type": "boolean",
"example": true
},
"Field-bWebhookSkipsslvalidation": {
"description": "Wheter the server's SSL certificate should be validated or not. Not recommended to skip for production use",
"type": "boolean",
"example": false
},
"Field-binEzsignsignatureattachmentMD5": {
"description": "The md5 of the Ezsignsignatureattachment",
"type": "string",
"example": "098f6bcd4621d373cade4e832627b4f6"
},
"Field-dCreditcardtransactionAmount": {
"description": "The amount of the Creditcardtransaction",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "167.58"
},
"Field-dEzmaxinvoicingRebatecontractlength": {
"description": "The percentage of rebate depending of the contract length",
"pattern": "^-{0,1}[\\d]{1,3}?\\.[\\d]{2}$",
"type": "string",
"example": "1.00"
},
"Field-dEzmaxinvoicingRebatepaymenttype": {
"description": "The percentage of rebate depending of the payment type",
"pattern": "^-{0,1}[\\d]{1,3}?\\.[\\d]{2}$",
"type": "string",
"example": "1.00"
},
"Field-dEzmaxinvoicingcommissionAmount": {
"description": "The amount of Ezmaxinvoicingcommission",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "450.34"
},
"Field-dEzmaxinvoicingcontract121qa": {
"description": "The price for 121QA",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "295.48"
},
"Field-dEzmaxinvoicingcontractLicense": {
"description": "The price of the license",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "335.42"
},
"Field-dEzmaxinvoicingsummaryexternaldetailCountreal": {
"description": "The count item invoiced for the product",
"pattern": "^-{0,1}[\\d]{1,6}?\\.[\\d]{2}$",
"type": "string",
"example": "815.61"
},
"Field-dEzmaxinvoicingsummaryexternaldetailRebate": {
"description": "The rebate for the product",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "608.18"
},
"Field-dEzmaxinvoicingsummaryexternaldetailSubtotal": {
"description": "The subtotal invoiced for the product",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "382.88"
},
"Field-dEzmaxinvoicingsummaryexternaldetailTotal": {
"description": "The total invoiced for the product",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "869.71"
},
"Field-dEzmaxinvoicingsummaryglobalCountbilled": {
"description": "The count item billed",
"pattern": "^-{0,1}[\\d]{1,6}?\\.[\\d]{2}$",
"type": "string",
"example": "581.56"
},
"Field-dEzmaxinvoicingsummaryglobalCountreal": {
"description": "The count item calculated",
"pattern": "^-{0,1}[\\d]{1,6}?\\.[\\d]{2}$",
"type": "string",
"example": "649.08"
},
"Field-dEzmaxinvoicingsummaryglobalNet": {
"description": "The net amount of the Ezmaxinvoicingsummaryglobal",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "521.71"
},
"Field-dEzmaxinvoicingsummaryglobalPartner": {
"description": "The amount of commission for the partner",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "266.49"
},
"Field-dEzmaxinvoicingsummaryglobalRebateamount": {
"description": "The rebate amount for the Ezmaxinvoicingsummaryglobal",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "0.00"
},
"Field-dEzmaxinvoicingsummaryglobalRebatepercent": {
"description": "The rebate percentage of the Ezmaxinvoicingsummaryglobal",
"pattern": "^-{0,1}[\\d]{1,3}?\\.[\\d]{2}$",
"type": "string",
"example": "0.00"
},
"Field-dEzmaxinvoicingsummaryglobalRebatetotal": {
"description": "The rebate amount total for the Ezmaxinvoicingsummaryglobal",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "2.00"
},
"Field-dEzmaxinvoicingsummaryglobalRepresentative": {
"description": "The amount of commission for the representative",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "685.88"
},
"Field-dEzmaxinvoicingsummaryglobalSubtotal": {
"description": "The Ezmaxinvoicingsummaryglobal subtotal",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "200.00"
},
"Field-dEzmaxinvoicingsummaryglobalTotal": {
"description": "The Ezmaxinvoicingsummaryglobal total",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "198.00"
},
"Field-dEzmaxinvoicingsummaryinternaldetailCountreal": {
"description": "The count item invoiced for the product",
"pattern": "^-{0,1}[\\d]{1,6}?\\.[\\d]{2}$",
"type": "string",
"example": "350.32"
},
"Field-dEzmaxinvoicingsummaryinternaldetailRebate": {
"description": "The rebate for the product",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "560.81"
},
"Field-dEzmaxinvoicingsummaryinternaldetailSubtotal": {
"description": "The subtotal invoiced for the product",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "625.41"
},
"Field-dEzmaxinvoicingsummaryinternaldetailTotal": {
"description": "The total invoiced for the product",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "510.77"
},
"Field-dEzmaxpricingRebateezsignallagents": {
"description": "The rebate offered when eZsign is taken for all agents",
"pattern": "^-{0,1}[\\d]{1,9}?\\.[\\d]{2}$",
"type": "string",
"example": "90.00"
},
"Field-dFranchisereferalincomeAgentamount": {
"description": "The amount that will be given to the agent",
"type": "string",
"example": "800.00"
},
"Field-dFranchisereferalincomeFranchiseamount": {
"description": "The amount that will be given to the franchise",
"type": "string",
"example": "275.00"
},
"Field-dFranchisereferalincomeFranchisoramount": {
"description": "The amount that will be kept by the franchisor",
"type": "string",
"example": "385.00"
},
"Field-dFranchisereferalincomeLoan": {
"description": "The loan amount",
"type": "string",
"example": "500275.62"
},
"Field-dtActivesessionFirsthit": {
"description": "The first hit of the Activesession",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtActivesessionLasthit": {
"description": "The last hit of the Activesession",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtClonehistoryFirsthit": {
"description": "The firsthit of the Clonehistory",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtClonehistoryLasthit": {
"description": "The lasthit of the Clonehistory",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtContactBirthdate": {
"description": "The Birth Date of the contact",
"type": "string",
"example": "1980-01-01"
},
"Field-dtCreatedDate": {
"description": "The date and time at which the object was created",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzmaxinvoicingcommissionEnd": {
"description": "The end date for the Ezmaxinvoicingcommission",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxinvoicingcommissionStart": {
"description": "The start date for the Ezmaxinvoicingcommission",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxinvoicingcontractEnd": {
"description": "The end date of the Ezmaxinvoicingcontract",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxinvoicingcontractStart": {
"description": "The start date of the Ezmaxinvoicingcontract",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxinvoicingsummaryglobalEnd": {
"description": "The end date for the Ezmaxinvoicingsummaryglobal",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxinvoicingsummaryglobalStart": {
"description": "The start date for the Ezmaxinvoicingsummaryglobal",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxpricingEnd": {
"description": "The end date of the Ezmaxpricing",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzmaxpricingStart": {
"description": "The start date of the Ezmaxpricing",
"type": "string",
"example": "2020-12-31"
},
"Field-dtEzsigndocumentDuedate": {
"description": "The maximum date and time at which the Ezsigndocument can be signed.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzsigndocumentFirstsend": {
"description": "The date and time when the Ezsigndocument was first sent.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzsigndocumentLastsend": {
"description": "The date and time when the Ezsigndocument was sent the last time.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzsigndocumentlogDatetime": {
"description": "The date and time at which the event was logged",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzsignfolderClose": {
"description": "The date and time at which the Ezsignfolder was closed. Either by applying the last signature or by completing it prematurely.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzsignfolderDelayedsenddate": {
"description": "The date and time at which the Ezsignfolder will be sent in the future.",
"type": "string",
"example": "2020-12-31T23:59:59.000Z"
},
"Field-dtEzsignfolderSentdate": {
"description": "The date and time at which the Ezsignfolder was sent the last time.",
"type": "string",
"example": "2020-12-31T23:59:59.000Z"
},
"Field-dtEzsignformCompleted": {
"description": "The date and time at which the Ezsignform has been completed.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtEzsignsignatureDate": {
"description": "The date the Ezsignsignature was signed",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtFranchisereferalincomeDisbursed": {
"description": "The date the amounts were disbursed",
"type": "string",
"example": "2020-12-31"
},
"Field-dtModifiedDate": {
"description": "The date and time at which the object was last modified",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtSessionhistoryFirsthit": {
"description": "The first hit of the Sessionhistory",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 17:35:37"
},
"Field-dtSessionhistoryLasthit": {
"description": "The last hit of the Sessionhistory",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 19:27:38"
},
"Field-dtSystemconfigurationReadonlyexpirationend": {
"description": "The end date where the system will be in read only",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$",
"type": "string",
"example": "2021-12-31"
},
"Field-dtSystemconfigurationReadonlyexpirationstart": {
"description": "The start date where the system will be in read only",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$",
"type": "string",
"example": "2020-12-31"
},
"Field-dtUserEzsignprepaidexpiration": {
"description": "The eZsign prepaid expiration date",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$",
"type": "string",
"example": "2020-12-31"
},
"Field-dtUserLastlogondate": {
"description": "The last logon date of the User",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtUserPasswordchanged": {
"description": "The date at which the User's password was last changed",
"pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) ([01]?[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-dtVersionhistoryDate": {
"description": "The date at which the Versionhistory was published or should be published",
"type": "string",
"example": "2020-12-31"
},
"Field-dtVersionhistoryDateend": {
"description": "The date at which the Versionhistory will no longer be visible",
"type": "string",
"example": "2020-12-31"
},
"Field-dtWebhooklogDate": {
"description": "The date and time at which the Webhooklog happened.",
"type": "string",
"example": "2020-12-31 23:59:59"
},
"Field-eActivesessionOrigin": {
"description": "The Origin of User for the Activesession",
"enum": [
"BuiltIn",
"External"
],
"type": "string",
"example": "BuiltIn"
},
"Field-eActivesessionUsertype": {
"description": "The Type of User for the Activesession",
"enum": [
"AgentBroker",
"Assistant",
"EzsignSigner",
"EzsignUser",
"Normal"
],
"type": "string",
"example": "Normal"
},
"Field-eActivesessionWeekdaystart": {
"description": "The weekday start of the User.",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"type": "string",
"example": "Sunday"
},
"Field-eBrandingLogo": {
"description": "The logo for the Branding. Select the value 'Default' if you want to use the default logo and delete the custom one if you used one",
"enum": [
"Default",
"JPEG",
"PNG"
],
"type": "string",
"example": "Default"
},
"Field-eCommunicationImportance": {
"description": "The importance of the Communication",
"enum": [
"High",
"Normal",
"Low"
],
"type": "string",
"example": "Normal"
},
"Field-eCommunicationType": {
"description": "The type of the Communication",
"enum": [
"Email",
"Fax",
"Sms"
],
"type": "string",
"example": "Email"
},
"Field-eCommunicationexternalrecipientType": {
"description": "The type of Communicationexternalrecipient",
"enum": [
"To",
"Cc",
"Bcc"
],
"type": "string",
"example": "To"
},
"Field-eCommunicationrecipientObjecttype": {
"description": "The object type for the Communicationrecipient",
"enum": [
"Agent",
"Agentincorporation",
"Assistant",
"Broker",
"Contact",
"Customer",
"Employee",
"Externalbroker",
"Ezcomagent",
"Ezcomcompany",
"Ezsignsigner",
"Franchiseoffice",
"Notary",
"Rewardmember",
"Supplier",
"User"
],
"type": "string",
"example": "User"
},
"Field-eCommunicationrecipientType": {
"description": "The type for the Communicationrecipient",
"enum": [
"To",
"Cc",
"Bcc"
],
"type": "string",
"example": "To"
},
"Field-eCreditcardtypeCodename": {
"description": "The codename of the Creditcardtype",
"enum": [
"Amex",
"Mastercard",
"Visa"
],
"type": "string",
"example": "visa"
},
"Field-eErrorCode": {
"description": "The error code. See documentation for valid values",
"enum": [
"BADREQUEST",
"BADREQUEST_CLOCKSKEW",
"UNAUTHORIZED_BADAUTH",
"UNAUTHORIZED_BADMFA",
"UNAUTHORIZED_EXPIRED",
"UNAUTHORIZED_REQUEST",
"FORBIDDEN",
"FORBIDDEN_CONFIGURATION",
"FORBIDDEN_MODULE",
"FORBIDDEN_NOACCESS",
"FORBIDDEN_PERMISSION",
"FORBIDDEN_SUBSCRIPTION",
"FORBIDDEN_USERTYPE",
"FORBIDDEN_USER_ORIGIN_EXTERNAL",
"NOTFOUND",
"NOTFOUND_OBJECT",
"NOTFOUND_ROUTE",
"METHODNOTALLOWED",
"NOTACCEPTABLE_CONTENT",
"NOTACCEPTABLE_LANGUAGE",
"UNPROCESSABLEENTITY_ACTIVESESSION_ALREADY_CLONING",
"UNPROCESSABLEENTITY_CANNOTDELETE",
"UNPROCESSABLEENTITY_CANNOTMODIFY",
"UNPROCESSABLEENTITY_CHANGEPASSWORD_INVALID_CURRENT",
"UNPROCESSABLEENTITY_CHANGEPASSWORD_SAME",
"UNPROCESSABLEENTITY_DATA_MISSING",
"UNPROCESSABLEENTITY_DATA_UNIQUE",
"UNPROCESSABLEENTITY_DATA_VALIDATION",
"UNPROCESSABLEENTITY_DATA_OUTOFBOUND",
"UNPROCESSABLEENTITY_DOWNLOAD_ERROR",
"UNPROCESSABLEENTITY_EZSIGNFORM_VALIDATION",
"UNPROCESSABLEENTITY_EZSIGNSIGNERCONNECTED",
"UNPROCESSABLEENTITY_NOTHINGTODO",
"UNPROCESSABLEENTITY_NOTREADY",
"UNPROCESSABLEENTITY_PDF_FORM",
"UNPROCESSABLEENTITY_PDF_SIGNATURE",
"UNPROCESSABLEENTITY_PDF_FORM_AND_SIGNATURE",
"UNPROCESSABLEENTITY_PDF_INCOMPATIBLE",
"UNPROCESSABLEENTITY_PDF_PASSWORD",
"UNPROCESSABLEENTITY_PDF_WRONG_PASSWORD",
"UNPROCESSABLEENTITY_PDF_REPAIRABLE",
"UNPROCESSABLEENTITY_PDF_XFA",
"UNPROCESSABLEENTITY_TEMPLATE_MISMATCH",
"UNPROCESSABLEENTITY_UNMODIFIABLE_FIELD",
"UNPROCESSABLEENTITY_USER_STAGED",
"TOOMANYREQUESTS",
"TOOMANYREQUESTS_THIRDPARTY",
"ERROR_INTERNAL",
"ERROR_CONFIGURATION",
"ERROR_NOTIMPLEMENTED"
],
"type": "string",
"example": "BADREQUEST"
},
"Field-eEzmaxinvoicingPaymenttype": {
"description": "The Ezmaxinvoicing payment type",
"enum": [
"Cheque",
"CreditCard",
"DirectDebit"
],
"type": "string",
"example": "Cheque"
},
"Field-eEzmaxinvoicingagentVariationezmax": {
"description": "Variation type for eZmax",
"enum": [
"Charge",
"Refund",
"Same"
],
"type": "string",
"example": "Charge"
},
"Field-eEzmaxinvoicingagentVariationezsign": {
"description": "Variation type for eZsign",
"enum": [
"Charge",
"Refund",
"Same"
],
"type": "string",
"example": "Charge"
},
"Field-eEzmaxinvoicingcontractPaymenttype": {
"description": "The Ezmaxinvoicingcontract payment type",
"enum": [
"Cheque",
"CreditCard",
"DirectDebit"
],
"type": "string",
"example": "Cheque"
},
"Field-eEzmaxinvoicinguserVariationezsign": {
"description": "The variation type for eZsign",
"enum": [
"Charge",
"Refund",
"Same"
],
"type": "string",
"example": "Charge"
},
"Field-eEzsignannotationType": {
"description": "The type of the Ezsignannotation.\n\n1. **StrikethroughBlock** is a box with hatching.\n2. **StrikethroughLine** is a red line to cross words.\n3. **Text** is a simple Text.",
"enum": [
"StrikethroughBlock",
"StrikethroughLine",
"Text"
],
"type": "string",
"example": "Text"
},
"Field-eEzsigndocumentStep": {
"description": "The signature step of the Ezsigndocument.",
"enum": [
"Unsent",
"Unsigned",
"PartiallySigned",
"DeclinedToSign",
"PrematurelyEnded",
"Completed",
"Disposed"
],
"type": "string",
"example": "Completed"
},
"Field-eEzsigndocumentlogType": {
"description": "The Ezsigndocumentlog Type.",
"enum": [
"Clone",
"Login",
"Sendcode",
"Badcode",
"Goodcode",
"Authentication",
"Createpage",
"Download",
"Send",
"Sign",
"Upload",
"View",
"Completion",
"Changelimitdate",
"Unsign",
"ImportFromInstanet",
"SendEmail",
"FormCompletion",
"SignatureAttachmentAdd",
"SignatureAttachmentValidation",
"SignatureAttachmentRefused",
"SignatureAttachmentDeleted",
"DeclinedToSign",
"DelayedSendEmail"
],
"type": "string",
"example": "Createpage"
},
"Field-eEzsignfolderSendreminderfrequency": {
"description": "Frequency at which reminders will be sent to signers that haven't signed the documents",
"enum": [
"None",
"Daily",
"Weekly"
],
"type": "string",
"example": "None"
},
"Field-eEzsignfolderStep": {
"description": "The signature step of the Ezsignfolder.",
"enum": [
"Unsent",
"PendingSend",
"Sent",
"PartiallySigned",
"Expired",
"Completed",
"Archived",
"Disposed"
],
"type": "string",
"example": "Completed"
},
"Field-eEzsignfoldertypeDisposal": {
"description": "The type of disposal",
"enum": [
"No",
"Manual",
"Automatic"
],
"type": "string",
"example": "Manual"
},
"Field-eEzsignfoldertypePrivacylevel": {
"description": "The Privacy level of the Ezsignfolder type.\n\n* **User** is for personal folders use and cannot be shared\n* **Usergroup** is for shared folders and complex permission can be configured to control access",
"enum": [
"User",
"Usergroup"
],
"type": "string"
},
"Field-eEzsignfoldertypeSendreminderfrequency": {
"description": "Frequency at which reminders will be sent to signers that haven't signed the documents",
"enum": [
"None",
"Daily",
"Weekly"
],
"type": "string",
"example": "None"
},
"Field-eEzsignformfieldgroupSignerrequirement": {
"description": "The Signer requirement of the Ezsignformfieldgroup. **All** means anyone can fill it, **One** means a specific person must fill it.",
"enum": [
"All",
"One"
],
"type": "string",
"example": "One"
},
"Field-eEzsignformfieldgroupTooltipposition": {
"description": "The location of the tooltip relative to the Ezsignformfieldgroup's location.",
"enum": [
"TopLeft",
"TopCenter",
"TopRight",
"MiddleLeft",
"MiddleRight",
"BottomLeft",
"BottomCenter",
"BottomRight"
],
"type": "string",
"example": "TopLeft"
},
"Field-eEzsignformfieldgroupType": {
"description": "The Type of Ezsignformfieldgroup",
"enum": [
"Text",
"Textarea",
"Dropdown",
"Radio",
"Checkbox"
],
"type": "string",
"example": "Text"
},
"Field-eEzsignsignatureAttachmentnamesource": {
"description": "The source of the name of the attachment added to the Ezsignsignature",
"enum": [
"Description",
"Customer",
"DescriptionCustomer"
],
"type": "string",
"example": "Description"
},
"Field-eEzsignsignatureFont": {
"description": "The font of the signature.\nThis can only be set if eEzsignsignatureType is **Name** or **Initials**",
"enum": [
"Normal",
"Cursive"
],
"type": "string",
"example": "Normal"
},
"Field-eEzsignsignatureTooltipposition": {
"description": "The location of the tooltip relative to the Ezsignsignature's location.",
"enum": [
"TopLeft",
"TopCenter",
"TopRight",
"MiddleLeft",
"MiddleRight",
"BottomLeft",
"BottomCenter",
"BottomRight"
],
"type": "string",
"example": "TopLeft"
},
"Field-eEzsignsignatureType": {
"description": "The type of signature.\n\n1. **Acknowledgement** is for an acknowledgment of receipt.\n2. **City** is to request the city where the document is signed.\n3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen.\n4. **Initials** is a simple \"click to add initials\" block.\n5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature.\n6. **Attachments** is to ask for files as attachment that may be validate in another step. \n7. **FieldText** is to ask for a short text.\n8. **Fieldtextarea** is to ask for a text",
"enum": [
"Acknowledgement",
"City",
"Handwritten",
"Initials",
"Name",
"Attachments",
"AttachmentsConfirmation",
"FieldText",
"FieldTextarea"
],
"type": "string",
"example": "Name"
},
"Field-eEzsigntemplateformfieldgroupSignerrequirement": {
"description": "The Signer requirement of the Ezsigntemplateformfieldgroup. **All** means anyone can fill it, **One** means a specific person must fill it.",
"enum": [
"All",
"One"
],
"type": "string",
"example": "One"
},
"Field-eEzsigntemplateformfieldgroupTooltipposition": {
"description": "The location of the tooltip relative to the Ezsigntemplateformfieldgroup's location.",
"enum": [
"TopLeft",
"TopCenter",
"TopRight",
"MiddleLeft",
"MiddleRight",
"BottomLeft",
"BottomCenter",
"BottomRight"
],
"type": "string",
"example": "TopLeft"
},
"Field-eEzsigntemplateformfieldgroupType": {
"description": "The Type of Ezsigntemplateformfieldgroup",
"enum": [
"Text",
"Textarea",
"Dropdown",
"Radio",
"Checkbox"
],
"type": "string",
"example": "Text"
},
"Field-eEzsigntemplatesignatureAttachmentnamesource": {
"description": "The source of the name of the attachment added to the Ezsigntemplatesignature",
"enum": [
"Description",
"Customer",
"DescriptionCustomer"
],
"type": "string",
"example": "Description"
},
"Field-eEzsigntemplatesignatureFont": {
"description": "The font of the signature.\nThis can only be set if eEzsigntemplatesignatureType is **Name** or **Initials**",
"enum": [
"Normal",
"Cursive"
],
"type": "string",
"example": "Normal"
},
"Field-eEzsigntemplatesignatureTooltipposition": {
"description": "The location of the tooltip relative to the Ezsigntemplatesignature's location.",
"enum": [
"TopLeft",
"TopCenter",
"TopRight",
"MiddleLeft",
"MiddleRight",
"BottomLeft",
"BottomCenter",
"BottomRight"
],
"type": "string",
"example": "TopLeft"
},
"Field-eEzsigntemplatesignatureType": {
"description": "The type of signature.\n\n1. **Acknowledgement** is for an acknowledgment of receipt.\n2. **City** is to request the city where the document is signed.\n3. **Handwritten** is for a handwritten kind of signature where users needs to \"draw\" their signature on screen.\n4. **Initials** is a simple \"click to add initials\" block.\n5. **Name** is a simple \"Click to sign\" block. This is the most common block of signature.\n6. **Attachments** is to ask for files as attachment that may be validate in another step. ",
"enum": [
"Acknowledgement",
"City",
"Handwritten",
"Initials",
"Name",
"Attachments",
"FieldText",
"FieldTextarea"
],
"type": "string",
"example": "Name"
},
"Field-eModuleInternalname": {
"description": "The Internal name of the Module.\n\nThis is theoretically an enum field but there are so many possibles values we decided not to list them all.",
"type": "string",
"example": "Purchases"
},
"Field-eNotificationpreferenceStatus": {
"description": "The display status for the Notificationtest.",
"enum": [
"Show",
"Hide",
"Pin"
],
"type": "string",
"example": "Show"
},
"Field-ePaymenttermType": {
"description": "The type of the Paymentterm",
"enum": [
"Days",
"Dayofthemonth"
],
"type": "string",
"example": "Days"
},
"Field-ePhoneType": {
"deprecated": true,
"description": "The type of phone number.\n\n**Local** refers to a north American phone number. You would then need to specify sPhoneRegion, sPhoneExchange, sPhoneNumber.\n**International** would be used for numbers outside of north america. You would then need to specify sPhoneInternational",
"enum": [
"Local",
"International"
],
"type": "string",
"example": "Local"
},
"Field-eSessionhistoryEndby": {
"description": "The Type of the Sessionhistory",
"enum": [
"Decryption",
"Hack",
"Expired",
"Hijack",
"DoubleLogon",
"Garbage",
"Logoff",
"BadAuth",
"Locked",
"Inactive",
"InvalidUser",
"BadUserType",
"BadIP",
"ForcedLogoff"
],
"type": "string",
"example": "Logoff"
},
"Field-eSystemconfigurationEzsign": {
"description": "Whether if Ezsign is paid by the company or not",
"enum": [
"No",
"Yes"
],
"type": "string",
"example": "Yes"
},
"Field-eSystemconfigurationLanguage1": {
"description": "The type of the french for the client",
"enum": [
"fr_QC"
],
"type": "string",
"example": "fr_QC"
},
"Field-eSystemconfigurationLanguage2": {
"description": "The type of the english for the client",
"enum": [
"en_CA",
"en_QC",
"en_US"
],
"type": "string",
"example": "en_CA"
},
"Field-eSystemconfigurationNewexternaluseraction": {
"description": "The action we do when a new external user connects itself",
"enum": [
"Stage",
"AutoCreate"
],
"type": "string",
"example": "Stage"
},
"Field-eUserEzsignaccess": {
"description": "The type or eZsign access the User has",
"enum": [
"No",
"PaidByOffice",
"PerDocument",
"Prepaid"
],
"type": "string",
"example": "PaidByOffice"
},
"Field-eUserEzsignsendreminderfrequency": {
"description": "Frequency at which reminders will be sent to signers that haven't signed the documents",
"enum": [
"None",
"Daily",
"Weekly"
],
"type": "string",
"example": "None"
},
"Field-eUserLogintype": {
"description": "The type of authentication for the User",
"enum": [
"Password",
"PasswordPhone",
"PasswordQuestion"
],
"type": "string",
"example": "Password"
},
"Field-eUserOrigin": {
"description": "The origin of the User",
"enum": [
"BuiltIn",
"External"
],
"type": "string",
"example": "BuiltIn"
},
"Field-eUserType": {
"description": "The user type of the User.",
"enum": [
"AgentBroker",
"Assistant",
"Employee",
"EzsignUser",
"Normal"
],
"type": "string",
"example": "EzsignUser"
},
"Field-eVariableexpenseTaxable": {
"description": "The taxable of the Variableexpense",
"enum": [
"Yes",
"No",
"Included"
],
"type": "string",
"example": "Yes"
},
"Field-eVersionhistoryType": {
"description": "The type of Versionhistory.",
"enum": [
"AgentBroker",
"NewFeature",
"Correction",
"Modification",
"ImportantMessage"
],
"type": "string",
"example": "NewFeature"
},
"Field-eVersionhistoryUsertype": {
"description": "The Usertype by which the Versionhistory should be visible",
"enum": [
"",
"AgentBroker",
"EzsignUser",
"Normal"
],
"type": "string",
"example": "Normal"
},
"Field-eWebhookEzsignevent": {
"description": "This Ezsign Event. This property will be set only if the Module is \"Ezsign\"",
"enum": [
"DocumentCompleted",
"EzsignsignerAcceptclause",
"EzsignsignerConnect",
"FolderCompleted"
],
"type": "string",
"example": "FolderCompleted"
},
"Field-eWebhookManagementevent": {
"description": "This Management Event. This property will be set only if the Module is \"Management\".",
"enum": [
"UserCreated",
"UserstagedCreated"
],
"type": "string",
"example": "UserCreated"
},
"Field-eWebhookModule": {
"description": "The module for the Webhook",
"enum": [
"Ezsign",
"Management"
],
"type": "string",
"example": "Ezsign"
},
"Field-iBrandingColorbackground": {
"description": "The color of the background. This is a RGB color converted into integer",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 15658734
},
"Field-iBrandingColorbackgroundbutton": {
"description": "The color of the background of the button. This is a RGB color converted into integer",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 13577007
},
"Field-iBrandingColorbackgroundsmallbox": {
"description": "The color of the background of the small box. This is a RGB color converted into integer",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 16777215
},
"Field-iBrandingColortext": {
"description": "The color of the text. This is a RGB color converted into integer",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 3752795
},
"Field-iBrandingColortextbutton": {
"description": "The color of the text in the button. This is a RGB color converted into integer",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 16777215
},
"Field-iBrandingColortextlinkbox": {
"description": "The color of the text in the link box. This is a RGB color converted into integer",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 0
},
"Field-iCountUser": {
"description": "Number of users in group",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 15
},
"Field-iEzmaxinvoicingContractlength": {
"description": "The length of the contract in years",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzmaxinvoicingDays": {
"description": "The number of days invoiced",
"minimum": 1,
"type": "integer",
"example": 28
},
"Field-iEzmaxinvoicingagentCloned": {
"description": "The number of times this user was cloned",
"minimum": 0,
"type": "integer",
"example": 157
},
"Field-iEzmaxinvoicingagentCommissioncalculation": {
"description": "The number of commission calculations",
"minimum": 0,
"type": "integer",
"example": 107
},
"Field-iEzmaxinvoicingagentEzsigndocument": {
"description": "The number of ezsign documents",
"minimum": 0,
"type": "integer",
"example": 160
},
"Field-iEzmaxinvoicingagentInscription": {
"description": "The number of inscriptions",
"minimum": 0,
"type": "integer",
"example": 113
},
"Field-iEzmaxinvoicingagentInscriptionactive": {
"description": "The number of active inscriptions",
"minimum": 0,
"type": "integer",
"example": 51
},
"Field-iEzmaxinvoicingagentInvoice": {
"description": "The number of invoices",
"minimum": 0,
"type": "integer",
"example": 30
},
"Field-iEzmaxinvoicingagentOtherincome": {
"description": "The number of otherincomes",
"minimum": 0,
"type": "integer",
"example": 198
},
"Field-iEzmaxinvoicingagentSale": {
"description": "The number of sales",
"minimum": 0,
"type": "integer",
"example": 213
},
"Field-iEzmaxinvoicingagentSession": {
"description": "The number of sessions",
"minimum": 0,
"type": "integer",
"example": 42
},
"Field-iEzmaxinvoicingcommissionDays": {
"description": "This is the number of days during the month on which the Ezmaxinvoigcommission applies",
"minimum": 0,
"type": "integer",
"example": 30
},
"Field-iEzmaxinvoicingcontractLength": {
"description": "The length in years of the Ezmaxinvoicingcontract",
"minimum": 1,
"type": "integer",
"example": 3
},
"Field-iEzmaxinvoicingsummaryglobalDays": {
"description": "The number of days for the Ezmaxinvoicingsummaryglobal",
"minimum": 1,
"type": "integer",
"example": 30
},
"Field-iEzmaxinvoicinguserEzsigndocument": {
"description": "The number of ezsign documents",
"minimum": 0,
"type": "integer",
"example": 243
},
"Field-iEzsignannotationHeight": {
"description": "The Height of the Ezsignannotation.\n\nHeight is calculated at 100dpi (dot per inch). So for example, if you want to have the height of the Ezsignannotation to be 2 inches, you would use \"200\" for the Height.\n\nThis can only be set if eEzsignannotationType is **StrikethroughBlock** or **Text**",
"minimum": 0,
"type": "integer",
"example": 25
},
"Field-iEzsignannotationWidth": {
"description": "The Width of the Ezsignannotation.\n\nWidth is calculated at 100dpi (dot per inch). So for example, if you want to have the width of the Ezsignannotation to be 3 inches, you would use \"300\" for the Width.",
"minimum": 0,
"type": "integer",
"example": 75
},
"Field-iEzsignannotationX": {
"description": "The X coordinate (Horizontal) where to put the Ezsignannotation on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 50
},
"Field-iEzsignannotationY": {
"description": "The Y coordinate (Vertical) where to put the Ezsignannotation on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignannotation 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 50
},
"Field-iEzsignbulksenddocumentmappingOrder": {
"description": "The order in which the Ezsigntemplate or Ezsigntemplatepackage will be presented to the signatory in the Ezsignfolder.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-iEzsignbulksendtransmissionErrors": {
"description": "The number of errors during the Ezsignbulksendtransmission",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-iEzsigndocumentOrder": {
"description": "The order in which the Ezsigndocument will be presented to the signatory in the Ezsignfolder.",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsigndocumentPagetotal": {
"description": "The number of pages in the Ezsigndocument.",
"minimum": 1,
"type": "integer",
"example": 4
},
"Field-iEzsigndocumentSignaturesigned": {
"description": "The number of signatures that were signed in the document.",
"minimum": 0,
"type": "integer",
"example": 3
},
"Field-iEzsigndocumentSignaturetotal": {
"description": "The number of total signatures that were requested in the Ezsigndocument.",
"minimum": 0,
"type": "integer",
"example": 4
},
"Field-iEzsignfoldertypeArchivaldays": {
"description": "The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype",
"maximum": 180,
"minimum": 0,
"type": "integer",
"example": 30
},
"Field-iEzsignfoldertypeDeadlinedays": {
"description": "The number of days to get all Ezsignsignatures",
"maximum": 60,
"minimum": 1,
"type": "integer",
"example": 5
},
"Field-iEzsignfoldertypeDisposaldays": {
"description": "The number of days after the archival before the disposal of the Ezsignfolder",
"maximum": 9999,
"minimum": 0,
"type": "integer",
"example": 365
},
"Field-iEzsignformfieldHeight": {
"description": "The Height of the Ezsignformfield in pixels calculated at 100 DPI\n\nThe allowed values are varying based on the eEzsignformfieldgroupType.\n\n| eEzsignformfieldgroupType | Valid values |\n| ------------------------- | ------------ |\n| Checkbox | 22 |\n| Dropdown | 22 |\n| Radio | 22 |\n| Text | 22 |\n| Textarea | 22-65535 |\n",
"minimum": 0,
"type": "integer",
"example": 22
},
"Field-iEzsignformfieldWidth": {
"description": "The Width of the Ezsignformfield in pixels calculated at 100 DPI\n\nThe allowed values are varying based on the eEzsignformfieldgroupType.\n\n| eEzsignformfieldgroupType | Valid values |\n| ------------------------- | ------------ |\n| Checkbox | 22 |\n| Dropdown | 22-65535 |\n| Radio | 22 |\n| Text | 22-65535 |\n| Textarea | 22-65535 |",
"minimum": 0,
"type": "integer",
"example": 102
},
"Field-iEzsignformfieldX": {
"description": "The X coordinate (Horizontal) where to put the Ezsignformfield on the Ezsignpage.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsignformfieldY": {
"description": "The Y coordinate (Vertical) where to put the Ezsignformfield on the Ezsignpage.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 300
},
"Field-iEzsignformfieldgroupFilledmax": {
"description": "The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup",
"minimum": 0,
"type": "integer",
"example": 2
},
"Field-iEzsignformfieldgroupFilledmin": {
"description": "The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-iEzsignformfieldgroupMaxlength": {
"description": "The maximum length for the value in the Ezsignformfieldgroup\n\nThis can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 75
},
"Field-iEzsignformfieldgroupStep": {
"description": "The step when the Ezsignsigner will be invited to fill the form fields",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsignpageHeightimage": {
"description": "The Height of the page's image in pixels calculated at 100 DPI",
"minimum": 0,
"type": "integer",
"example": 1100
},
"Field-iEzsignpageHeightpdf": {
"description": "The Height of the page in points calculated at 72 DPI",
"minimum": 0,
"type": "integer",
"example": 792
},
"Field-iEzsignpagePagenumber": {
"description": "The page number in the Ezsigndocument",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsignpageWidthimage": {
"description": "The Width of the page's image in pixels calculated at 100 DPI",
"minimum": 0,
"type": "integer",
"example": 850
},
"Field-iEzsignpageWidthpdf": {
"description": "The Width of the page in points calculated at 72 DPI",
"minimum": 0,
"type": "integer",
"example": 612
},
"Field-iEzsignsignatureHeight": {
"description": "The height of the Ezsignsignature.\n\nSize is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have an height of 2 inches, you would use \"200\" for the iEzsignsignatureHeight.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsignsignatureMaxlength": {
"description": "The maximum length for the value in the Ezsignsignature\n\nThis can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea**",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 75
},
"Field-iEzsignsignatureStep": {
"description": "The step when the Ezsignsigner will be invited to sign",
"type": "integer",
"example": 1
},
"Field-iEzsignsignatureValidationstep": {
"description": "The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments",
"type": "integer",
"example": 1
},
"Field-iEzsignsignatureWidth": {
"description": "The width of the Ezsignsignature.\n\nSize is calculated at 100dpi (dot per inch). So for example, if you want the Ezsignsignature to have a width of 2 inches, you would use \"200\" for the iEzsignsignatureWidth.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsignsignatureX": {
"description": "The X coordinate (Horizontal) where to put the Ezsignsignature on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsignsignatureY": {
"description": "The Y coordinate (Vertical) where to put the Ezsignsignature on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 300
},
"Field-iEzsignsignaturecustomdateX": {
"description": "The X coordinate (Horizontal) where to put the Ezsignsignaturecustomdate on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsignsignaturecustomdateY": {
"description": "The Y coordinate (Vertical) where to put the Ezsignsignaturecustomdate on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsignsignaturecustomdate block 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 300
},
"Field-iEzsigntemplatedocumentPagetotal": {
"description": "The number of pages in the Ezsigntemplatedocument.",
"minimum": 1,
"type": "integer",
"example": 5
},
"Field-iEzsigntemplatedocumentpageHeightimage": {
"description": "The Height of the page's image in pixels calculated at 100 DPI",
"minimum": 0,
"type": "integer",
"example": 1100
},
"Field-iEzsigntemplatedocumentpageHeightpdf": {
"description": "The Height of the page in points calculated at 72 DPI",
"minimum": 0,
"type": "integer",
"example": 792
},
"Field-iEzsigntemplatedocumentpagePagenumber": {
"description": "The page number in the Ezsigntemplatedocument",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsigntemplatedocumentpageWidthimage": {
"description": "The Width of the page's image in pixels calculated at 100 DPI",
"minimum": 0,
"type": "integer",
"example": 850
},
"Field-iEzsigntemplatedocumentpageWidthpdf": {
"description": "The Width of the page in points calculated at 72 DPI",
"minimum": 0,
"type": "integer",
"example": 612
},
"Field-iEzsigntemplateformfieldHeight": {
"description": "The Height of the Ezsigntemplateformfield in pixels calculated at 100 DPI\n\nThe allowed values are varying based on the eEzsigntemplateformfieldgroupType.\n\n| eEzsigntemplateformfieldgroupType | Valid values |\n| ------------------------- | ------------ |\n| Checkbox | 22 |\n| Dropdown | 22 |\n| Radio | 22 |\n| Text | 22 |\n| Textarea | 22-65535 |\n",
"minimum": 0,
"type": "integer",
"example": 22
},
"Field-iEzsigntemplateformfieldWidth": {
"description": "The Width of the Ezsigntemplateformfield in pixels calculated at 100 DPI\n\nThe allowed values are varying based on the eEzsigntemplateformfieldgroupType.\n\n| eEzsigntemplateformfieldgroupType | Valid values |\n| ------------------------- | ------------ |\n| Checkbox | 22 |\n| Dropdown | 22-65535 |\n| Radio | 22 |\n| Text | 22-65535 |\n| Textarea | 22-65535 |",
"minimum": 0,
"type": "integer",
"example": 102
},
"Field-iEzsigntemplateformfieldX": {
"description": "The X coordinate (Horizontal) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsigntemplateformfieldY": {
"description": "The Y coordinate (Vertical) where to put the Ezsigntemplateformfield on the Ezsigntemplatepage.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplateformfield 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 300
},
"Field-iEzsigntemplateformfieldgroupFilledmax": {
"description": "The maximum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup",
"minimum": 0,
"type": "integer",
"example": 2
},
"Field-iEzsigntemplateformfieldgroupFilledmin": {
"description": "The minimum number of Ezsigntemplateformfield that must be filled in the Ezsigntemplateformfieldgroup",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-iEzsigntemplateformfieldgroupMaxlength": {
"description": "The maximum length for the value in the Ezsigntemplateformfieldgroup\n\nThis can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 75
},
"Field-iEzsigntemplateformfieldgroupStep": {
"description": "The step when the Ezsigntemplatesigner will be invited to fill the form fields",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsigntemplatepackagemembershipOrder": {
"description": "The order in which the Ezsigntemplate will be imported when using an Ezsigntemplatepackage.",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsigntemplatepackagesignermembershipCopy": {
"description": "The Copy number in case of multiple copies.",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsigntemplatesignatureHeight": {
"description": "The height of the Ezsigntemplatesignature.\n\nSize is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have an height of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureHeight.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsigntemplatesignatureMaxlength": {
"description": "The maximum length for the value in the Ezsigntemplatesignature\n\nThis can only be set if eEzsigntemplatesignatureType is **FieldText** or **FieldTextarea**",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 75
},
"Field-iEzsigntemplatesignatureStep": {
"description": "The step when the Ezsigntemplatesigner will be invited to sign",
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-iEzsigntemplatesignatureValidationstep": {
"description": "The step when the Ezsigntemplatesigner will be invited to validate the Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments",
"type": "integer",
"example": 1
},
"Field-iEzsigntemplatesignatureWidth": {
"description": "The width of the Ezsigntemplatesignature.\n\nSize is calculated at 100dpi (dot per inch). So for example, if you want the Ezsigntemplatesignature to have a width of 2 inches, you would use \"200\" for the iEzsigntemplatesignatureWidth.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsigntemplatesignatureX": {
"description": "The X coordinate (Horizontal) where to put the Ezsigntemplatesignature on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsigntemplatesignatureY": {
"description": "The Y coordinate (Vertical) where to put the Ezsigntemplatesignature on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignature 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 300
},
"Field-iEzsigntemplatesignaturecustomdateX": {
"description": "The X coordinate (Horizontal) where to put the Ezsigntemplatesignaturecustomdate on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 2 inches from the left border of the page, you would use \"200\" for the X coordinate.",
"minimum": 0,
"type": "integer",
"example": 200
},
"Field-iEzsigntemplatesignaturecustomdateY": {
"description": "The Y coordinate (Vertical) where to put the Ezsigntemplatesignaturecustomdate on the page.\n\nCoordinate is calculated at 100dpi (dot per inch). So for example, if you want to put the Ezsigntemplatesignaturecustomdate 3 inches from the top border of the page, you would use \"300\" for the Y coordinate.",
"minimum": 0,
"type": "integer",
"example": 300
},
"Field-iPaymenttermDay": {
"description": "The day of the Paymentterm",
"maximum": 255,
"minimum": 0,
"type": "integer",
"example": 30
},
"Field-iPhoneNumber": {
"deprecated": true,
"description": "The number of the phone number. (For a North America Number only)\n\nThe number is the \"1516\" section in this sample phone number: (514) 990-1516 x123",
"type": "string",
"example": "1516"
},
"Field-iRowMax": {
"description": "The maximum numbers of results to be returned",
"default": 10000,
"maximum": 10000,
"minimum": 1,
"type": "integer",
"example": 100
},
"Field-iRowOffset": {
"description": "The starting element from where to start retrieving the results. For example if you started at iRowOffset=0 and asked for iRowMax=100, to get the next 100 results, you could specify iRowOffset=100&iRowMax=100,",
"default": 0,
"minimum": 0,
"type": "integer",
"example": 0
},
"Field-iSubnetMask": {
"format": "int64",
"description": "The mask of the Subnet in integer form. For example 255.255.255.0 would be 4294967040",
"maximum": 4294967295,
"minimum": 0,
"type": "integer",
"example": 4294967040
},
"Field-iSubnetNetwork": {
"format": "int64",
"description": "The network of the Subnet in integer form. For example 8.8.8.0 would be 134744064",
"maximum": 4294967295,
"minimum": 0,
"type": "integer",
"example": 134744064
},
"Field-iTextstylestaticFontcolor": {
"description": "The int32 representation of the Fontcolor. For example, RGB color #39435B would be 3752795",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 3752795
},
"Field-iTextstylestaticSize": {
"description": "The Size for the Font of the Textstylestatic",
"maximum": 255,
"minimum": 1,
"type": "integer",
"example": 12
},
"Field-iUserInterfacecolor": {
"format": "int32",
"description": "The int32 representation of the interface color. For example, RGB color #39435B would be 3752795",
"minimum": 0,
"type": "integer",
"example": 3752795
},
"Field-iUserListresult": {
"description": "The number of rows to return by default in lists",
"maximum": 500,
"minimum": 5,
"type": "integer",
"example": 25
},
"Field-pkiActivesessionID": {
"description": "The unique ID of the Activesession",
"type": "integer",
"example": 16
},
"Field-pkiAddresstypeID": {
"description": "The unique ID of the Addresstype.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|Office|\n|2|Home|\n|3|Real Estate Invoice|\n|4|Invoicing|\n|5|Shipping|",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiAgentID": {
"description": "The unique ID of the Agent.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiAgentincorporationID": {
"description": "The unique ID of the Agentincorporation.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiApikeyID": {
"description": "The unique ID of the Apikey",
"minimum": 0,
"type": "integer",
"example": 99
},
"Field-pkiAssistantID": {
"description": "The unique ID of the Assistant.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiAttachmentID": {
"description": "The unique ID of the Attachment.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiBillingentityexternalID": {
"description": "The unique ID of the Billingentityexternal",
"minimum": 1,
"type": "integer",
"example": 83
},
"Field-pkiBillingentityinternalID": {
"description": "The unique ID of the Billingentityinternal.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiBillingentityinternalproductID": {
"description": "The unique ID of the Billingentityinternalproduct",
"maximum": 255,
"minimum": 0,
"type": "integer",
"example": 254
},
"Field-pkiBrandingID": {
"description": "The unique ID of the Branding",
"minimum": 0,
"type": "integer",
"example": 78
},
"Field-pkiBrokerID": {
"description": "The unique ID of the Broker.",
"minimum": 0,
"type": "integer",
"example": 26
},
"Field-pkiClonehistoryID": {
"description": "The unique ID of the Clonehistory",
"maximum": 16777215,
"minimum": 1,
"type": "integer",
"example": 12
},
"Field-pkiCommunicationID": {
"description": "The unique ID of the Communication.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiCommunicationattachmentID": {
"description": "The unique ID of the Communicationattachment",
"type": "integer",
"example": 203
},
"Field-pkiCommunicationexternalrecipientID": {
"description": "The unique ID of the Communicationexternalrecipient",
"type": "integer",
"example": 9
},
"Field-pkiCommunicationrecipientID": {
"description": "The unique ID of the Communicationrecipient.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiCompanyID": {
"description": "The unique ID of the Company",
"maximum": 255,
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-pkiComputerID": {
"description": "The unique ID of the Computer",
"maximum": 65535,
"minimum": 1,
"type": "integer",
"example": 249
},
"Field-pkiContactID": {
"description": "The unique ID of the Contact",
"minimum": 0,
"type": "integer",
"example": 21
},
"Field-pkiContacttitleID": {
"description": "The unique ID of the Contacttitle.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|Ms.|\n|2|Mr.|\n|4|(Blank)|\n|5|Me (For Notaries)|",
"minimum": 0,
"type": "integer",
"example": 2
},
"Field-pkiCorsID": {
"description": "The unique ID of the Cors",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 228
},
"Field-pkiCountryID": {
"description": "The unique ID of the Country.\n\nHere are some common values (Complete list must be retrieved from API):\n\n|Value|Description|\n|-|-|\n|1|Canada|\n|2|United-States|",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiCustomerID": {
"description": "The unique ID of the Customer.",
"minimum": 0,
"type": "integer",
"example": 18
},
"Field-pkiDepartmentID": {
"description": "The unique ID of the Department",
"minimum": 0,
"type": "integer",
"example": 21
},
"Field-pkiDescriptionstaticID": {
"description": "The unique ID of the Descriptionstatic",
"minimum": 0,
"type": "integer",
"example": 37
},
"Field-pkiEmailID": {
"description": "The unique ID of the Email",
"maximum": 16777215,
"minimum": 1,
"type": "integer",
"example": 22
},
"Field-pkiEmailstaticID": {
"description": "The unique ID of the Emailstatic",
"minimum": 0,
"type": "integer",
"example": 99
},
"Field-pkiEmailtypeID": {
"description": "The unique ID of the Emailtype.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|Office|\n|2|Home|",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiEmployeeID": {
"description": "The unique ID of the Employee.",
"minimum": 0,
"type": "integer",
"example": 31
},
"Field-pkiExternalbrokerID": {
"description": "The unique ID of the Externalbroker.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiEzcomagentID": {
"description": "The unique ID of the Ezcomagent.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiEzmaxinvoicingID": {
"description": "The unique ID of the Ezmaxinvoicing",
"minimum": 0,
"type": "integer",
"example": 28
},
"Field-pkiEzmaxinvoicingagentID": {
"description": "The unique ID of the Ezmaxinvoicingagent",
"minimum": 0,
"type": "integer",
"example": 181
},
"Field-pkiEzmaxinvoicingcommissionID": {
"description": "The unique ID of the Ezmaxinvoicingcommission",
"type": "integer",
"example": 36
},
"Field-pkiEzmaxinvoicingcontractID": {
"description": "The unique ID of the Ezmaxinvoicingcontract",
"minimum": 1,
"type": "integer",
"example": 28
},
"Field-pkiEzmaxinvoicingsummaryexternalID": {
"description": "The unique ID of the Ezmaxinvoicingsummaryexternal",
"minimum": 0,
"type": "integer",
"example": 177
},
"Field-pkiEzmaxinvoicingsummaryexternaldetailID": {
"description": "The unique ID of the Ezmaxinvoicingsummaryexternaldetail",
"minimum": 0,
"type": "integer",
"example": 163
},
"Field-pkiEzmaxinvoicingsummaryglobalID": {
"description": "The unique ID of the Ezmaxinvoicingsummaryglobal",
"minimum": 0,
"type": "integer",
"example": 241
},
"Field-pkiEzmaxinvoicingsummaryinternalID": {
"description": "The unique ID of the Ezmaxinvoicingsummaryinternal",
"minimum": 0,
"type": "integer",
"example": 57
},
"Field-pkiEzmaxinvoicingsummaryinternaldetailID": {
"description": "The unique ID of the Ezmaxinvoicingsummaryinternaldetail",
"minimum": 0,
"type": "integer",
"example": 73
},
"Field-pkiEzmaxinvoicinguserID": {
"description": "The unique ID of the Ezmaxinvoicinguser",
"minimum": 0,
"type": "integer",
"example": 202
},
"Field-pkiEzmaxpartnerID": {
"description": "The unique ID of the Ezmaxpartner",
"minimum": 1,
"type": "integer",
"example": 12
},
"Field-pkiEzmaxpricingID": {
"description": "The unique ID of the Ezmaxpricing",
"minimum": 1,
"type": "integer",
"example": 28
},
"Field-pkiEzmaxproductID": {
"description": "The unique ID of the Ezmaxproduct",
"minimum": 1,
"type": "integer",
"example": 172
},
"Field-pkiEzmaxrepresentativeID": {
"description": "The unique ID of the Ezmaxrepresentative",
"minimum": 1,
"type": "integer",
"example": 21
},
"Field-pkiEzsignannotationID": {
"description": "The unique ID of the Ezsignannotation",
"type": "integer",
"example": 113
},
"Field-pkiEzsignbulksendID": {
"description": "The unique ID of the Ezsignbulksend",
"minimum": 0,
"type": "integer",
"example": 8
},
"Field-pkiEzsignbulksenddocumentmappingID": {
"description": "The unique ID of the Ezsignbulksenddocumentmapping.",
"minimum": 0,
"type": "integer",
"example": 48
},
"Field-pkiEzsignbulksendsignermappingID": {
"description": "The unique ID of the Ezsignbulksendsignermapping",
"minimum": 0,
"type": "integer",
"example": 57
},
"Field-pkiEzsignbulksendtransmissionID": {
"description": "The unique ID of the Ezsignbulksendtransmission",
"minimum": 0,
"type": "integer",
"example": 21
},
"Field-pkiEzsigndocumentID": {
"description": "The unique ID of the Ezsigndocument",
"minimum": 0,
"type": "integer",
"example": 97
},
"Field-pkiEzsignfolderID": {
"description": "The unique ID of the Ezsignfolder",
"minimum": 0,
"type": "integer",
"example": 33
},
"Field-pkiEzsignfoldersignerassociationID": {
"description": "The unique ID of the Ezsignfoldersignerassociation",
"minimum": 0,
"type": "integer",
"example": 20
},
"Field-pkiEzsignfoldertypeID": {
"description": "The unique ID of the Ezsignfoldertype.",
"minimum": 0,
"type": "integer",
"example": 5
},
"Field-pkiEzsignformfieldID": {
"description": "The unique ID of the Ezsignformfield",
"minimum": 0,
"type": "integer",
"example": 32
},
"Field-pkiEzsignformfieldgroupID": {
"description": "The unique ID of the Ezsignformfieldgroup",
"minimum": 0,
"type": "integer",
"example": 26
},
"Field-pkiEzsignformfieldgroupsignerID": {
"description": "The unique ID of the Ezsignformfieldgroupsigner",
"minimum": 0,
"type": "integer",
"example": 81
},
"Field-pkiEzsignpageID": {
"description": "The unique ID of the Ezsignpage",
"minimum": 0,
"type": "integer",
"example": 64
},
"Field-pkiEzsignsignatureID": {
"description": "The unique ID of the Ezsignsignature",
"minimum": 0,
"type": "integer",
"example": 49
},
"Field-pkiEzsignsignatureattachmentID": {
"description": "The unique ID of the Ezsignsignatureattachment",
"maximum": 16777215,
"minimum": 1,
"type": "integer",
"example": 177
},
"Field-pkiEzsignsignaturecustomdateID": {
"description": "The unique ID of the Ezsignsignaturecustomdate",
"minimum": 0,
"type": "integer",
"example": 27
},
"Field-pkiEzsignsignerID": {
"description": "The unique ID of the Ezsignsigner",
"minimum": 0,
"type": "integer",
"example": 89
},
"Field-pkiEzsignsignergroupID": {
"description": "The unique ID of the Ezsignsignergroup",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 27
},
"Field-pkiEzsignsignergroupmembershipID": {
"description": "The unique ID of the Ezsignsignergroupmembership",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 153
},
"Field-pkiEzsigntemplateID": {
"description": "The unique ID of the Ezsigntemplate",
"minimum": 0,
"type": "integer",
"example": 36
},
"Field-pkiEzsigntemplatedocumentID": {
"description": "The unique ID of the Ezsigntemplatedocument",
"minimum": 0,
"type": "integer",
"example": 133
},
"Field-pkiEzsigntemplatedocumentpageID": {
"description": "The unique ID of the Ezsigntemplatedocumentpage",
"minimum": 0,
"type": "integer",
"example": 85
},
"Field-pkiEzsigntemplateformfieldID": {
"description": "The unique ID of the Ezsigntemplateformfield",
"minimum": 0,
"type": "integer",
"example": 71
},
"Field-pkiEzsigntemplateformfieldgroupID": {
"description": "The unique ID of the Ezsigntemplateformfieldgroup",
"minimum": 0,
"type": "integer",
"example": 64
},
"Field-pkiEzsigntemplateformfieldgroupsignerID": {
"description": "The unique ID of the Ezsigntemplateformfieldgroupsigner",
"minimum": 0,
"type": "integer",
"example": 87
},
"Field-pkiEzsigntemplatepackageID": {
"description": "The unique ID of the Ezsigntemplatepackage",
"minimum": 0,
"type": "integer",
"example": 99
},
"Field-pkiEzsigntemplatepackagemembershipID": {
"description": "The unique ID of the Ezsigntemplatepackagemembership",
"minimum": 0,
"type": "integer",
"example": 194
},
"Field-pkiEzsigntemplatepackagesignerID": {
"description": "The unique ID of the Ezsigntemplatepackagesigner",
"minimum": 0,
"type": "integer",
"example": 174
},
"Field-pkiEzsigntemplatepackagesignermembershipID": {
"description": "The unique ID of the Ezsigntemplatepackagesignermembership",
"minimum": 0,
"type": "integer",
"example": 237
},
"Field-pkiEzsigntemplatesignatureID": {
"description": "The unique ID of the Ezsigntemplatesignature",
"minimum": 0,
"type": "integer",
"example": 99
},
"Field-pkiEzsigntemplatesignaturecustomdateID": {
"description": "The unique ID of the Ezsigntemplatesignaturecustomdate",
"minimum": 0,
"type": "integer",
"example": 58
},
"Field-pkiEzsigntemplatesignerID": {
"description": "The unique ID of the Ezsigntemplatesigner",
"minimum": 0,
"type": "integer",
"example": 9
},
"Field-pkiEzsigntsarequirementID": {
"description": "The unique ID of the Ezsigntsarequirement.\n\nDetermine if a Time Stamping Authority should add a timestamp on each of the signature.\nValid values:\n\n|Value|Description|\n|-|-|\n|1|No. TSA Timestamping will requested. This will make all signatures a lot faster since no round-trip to the TSA server will be required. Timestamping will be made using eZsign server's time.|\n|2|Best effort. Timestamping from a Time Stamping Authority will be requested but is not mandatory. In the very improbable case it cannot be completed, the timestamping will be made using eZsign server's time. **Additional fee applies**|\n|3|Mandatory. Timestamping from a Time Stamping Authority will be requested and is mandatory. In the very improbable case it cannot be completed, the signature will fail and the user will be asked to retry. **Additional fee applies**|",
"maximum": 3,
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-pkiFontID": {
"description": "The unique ID of the Font",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiFranchisebrokerID": {
"description": "The unique ID of the Franchisebroker",
"minimum": 0,
"type": "integer",
"example": 61
},
"Field-pkiFranchiseofficeID": {
"description": "The unique ID of the Franchisereoffice",
"minimum": 0,
"type": "integer",
"example": 50
},
"Field-pkiFranchisereferalincomeID": {
"description": "The unique ID of the Franchisereferalincome",
"minimum": 0,
"type": "integer",
"example": 35
},
"Field-pkiFranchisereferalincomeprogramID": {
"description": "The unique ID of the Franchisereferalincomeprogram",
"minimum": 0,
"type": "integer",
"example": 51
},
"Field-pkiInvoiceID": {
"description": "The unique ID of the Invoice.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiLanguageID": {
"description": "The unique ID of the Language.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|French|\n|2|English|",
"maximum": 2,
"minimum": 1,
"type": "integer",
"example": 2
},
"Field-pkiModuleID": {
"description": "The unique ID of the Module",
"minimum": 0,
"type": "integer",
"example": 40
},
"Field-pkiModulegroupID": {
"description": "The unique ID of the Modulegroup",
"maximum": 255,
"minimum": 1,
"type": "integer",
"example": 46
},
"Field-pkiModulesectionID": {
"description": "The unique ID of the Modulesection",
"minimum": 0,
"type": "integer",
"example": 53
},
"Field-pkiNotaryID": {
"description": "The unique ID of the Notary.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiNotificationsectionID": {
"description": "The unique ID of the Notificationsection",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiNotificationsubsectionID": {
"description": "The unique ID of the Notificationsubsection",
"minimum": 0,
"type": "integer",
"example": 3
},
"Field-pkiNotificationtestID": {
"description": "The unique ID of the Notificationtest",
"minimum": 0,
"type": "integer",
"example": 14
},
"Field-pkiPaymenttermID": {
"description": "The unique ID of the Paymentterm",
"type": "integer",
"example": 46
},
"Field-pkiPeriodID": {
"description": "The unique ID of the Period",
"minimum": 0,
"type": "integer",
"example": 21
},
"Field-pkiPermissionID": {
"description": "The unique ID of the Permission",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 31
},
"Field-pkiPhoneID": {
"description": "The unique ID of the Phone.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiPhonestaticID": {
"description": "The unique ID of the Phone.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiPhonetypeID": {
"description": "The unique ID of the Phonetype.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|Office|\n|2|Home|\n|3|Mobile|\n|4|Fax|\n|5|Pager|\n|6|Toll Free|",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiProvinceID": {
"description": "The unique ID of the Province.\n\nHere are some common values (Complete list must be retrieved from API):\n\n|Value|Description|\n|-|-|\n|1|(Canada) Alberta\n|2|(Canada) British Columbia|\n|3|(Canada) Manitoba|\n|3|(Canada) Manitoba|\n|4|(Canada) New Brunswick|\n|5|(Canada) Newfoundland|\n|6|(Canada) Northwest Territories|\n|7|(Canada) Nova Scotia|\n|8|(Canada) Nunavut|\n|9|(Canada) Ontario|\n|10|(Canada) Prince Edward Island|\n|11|(Canada) Quebec|\n|12|(Canada) Saskatchewan|\n|13|(Canada) Yukon|\n|14|(United-States) Alabama|\n|15|(United-States) Alaska|\n|16|(United-States) Arizona|\n|17|(United-States) Arkansas|\n|18|(United-States) California|\n|19|(United-States) Colorado|\n|20|(United-States) Connecticut|\n|21|(United-States) Delaware|\n|22|(United-States) District of Columbia|\n|23|(United-States) Florida|\n|24|(United-States) Georgia|\n|25|(United-States) Hawaii|\n|26|(United-States) Idaho|\n|27|(United-States) Illinois|\n|28|(United-States) Indiana|\n|29|(United-States) Iowa|\n|30|(United-States) Kansas|\n|31|(United-States) Kentucky|\n|32|(United-States) Louisiane|\n|33|(United-States) Maine|\n|34|(United-States) Maryland|\n|35|(United-States) Massachusetts|\n|36|(United-States) Michigan|\n|37|(United-States) Minnesota|\n|38|(United-States) Mississippi|\n|39|(United-States) Missouri|\n|40|(United-States) Montana|\n|41|(United-States) Nebraska|\n|42|(United-States) Nevada|\n|43|(United-States) New Hampshire|\n|44|(United-States) New Jersey|\n|45|(United-States) New Mexico|\n|46|(United-States) New York|\n|47|(United-States) North Carolina|\n|48|(United-States) North Dakota|\n|49|(United-States) Ohio|\n|50|(United-States) Oklahoma|\n|51|(United-States) Oregon|\n|52|(United-States) Pennsylvania|\n|53|(United-States) Rhode Island|\n|54|(United-States) South Carolina|\n|55|(United-States) South Dakota|\n|56|(United-States) Tennessee|\n|57|(United-States) Texas|\n|58|(United-States) Utah|\n|60|(United-States) Vermont|\n|59|(United-States) Virginia|\n|61|(United-States) Washington|\n|62|(United-States) West Virginia|\n|63|(United-States) Wisconsin|\n|64|(United-States) Wyoming|",
"minimum": 0,
"type": "integer",
"example": 11
},
"Field-pkiRewardmemberID": {
"description": "The unique ID of the Rewardmember.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiSalarypreparationID": {
"description": "The unique ID of the Salarypreparation.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiSecretquestionID": {
"description": "The unique ID of the Secretquestion.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|The name of the hospital in which you were born|\n|2|The name of your grade school|\n|3|The last name of your favorite teacher|\n|4|Your favorite sports team|\n|5|Your favorite TV show|\n|6|Your favorite movie|\n|7|The name of the street on which you grew up|\n|8|The name of your first employer|\n|9|Your first car|\n|10|Your favorite food|\n|11|The name of your first pet|\n|12|Favorite musician/band|\n|13|What instrument you play|\n|14|Your father's middle name|\n|15|Your mother's maiden name|\n|16|Name of your eldest child|\n|17|Your spouse's middle name|\n|18|Favorite restaurant|\n|19|Childhood nickname|\n|20|Favorite vacation destination|\n|21|Your boat's name|\n|22|Date of Birth (YYYY-MM-DD)|",
"minimum": 0,
"type": "integer",
"example": 7
},
"Field-pkiSessionhistoryID": {
"description": "The unique ID of the Sessionhistory",
"maximum": 2147483647,
"minimum": 1,
"type": "integer",
"example": 259
},
"Field-pkiSignatureID": {
"description": "The unique ID of the Signature",
"maximum": 16777215,
"minimum": 0,
"type": "integer",
"example": 12
},
"Field-pkiSubnetID": {
"description": "The unique ID of the Subnet",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 3
},
"Field-pkiSupplierID": {
"description": "The unique ID of the Supplier.",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiSystemconfigurationID": {
"description": "The unique ID of the Systemconfiguration",
"maximum": 1,
"minimum": 1,
"type": "integer",
"example": 1
},
"Field-pkiSystemconfigurationtypeID": {
"description": "The unique ID of the Systemconfigurationtype",
"minimum": 1,
"type": "integer",
"example": 28
},
"Field-pkiTaxassignmentID": {
"description": "The unique ID of the Taxassignment.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|No tax|\n|2|GST|\n|3|HST (ON)|\n|4|HST (NB)|\n|5|HST (NS)|\n|6|HST (NL)|\n|7|HST (PE)|\n|8|GST + QST (QC)|\n|9|GST + QST (QC) Non-Recoverable|\n|10|GST + PST (BC)|\n|11|GST + PST (SK)|\n|12|GST + RST (MB)|\n|13|GST + PST (BC) Non-Recoverable|\n|14|GST + PST (SK) Non-Recoverable|\n|15|GST + RST (MB) Non-Recoverable|",
"maximum": 15,
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pkiTextstylestaticID": {
"description": "The unique ID of the Textstylestatic",
"minimum": 0,
"type": "integer",
"example": 216
},
"Field-pkiTimezoneID": {
"description": "The unique ID of the Timezone",
"minimum": 0,
"type": "integer",
"example": 247
},
"Field-pkiUserID": {
"description": "The unique ID of the User",
"minimum": 0,
"type": "integer",
"example": 70
},
"Field-pkiUsergroupID": {
"description": "The unique ID of the Usergroup",
"maximum": 255,
"minimum": 0,
"type": "integer",
"example": 2
},
"Field-pkiUsergroupdelegationID": {
"description": "The unique ID of the Usergroupdelegation",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 141
},
"Field-pkiUsergroupmembershipID": {
"description": "The unique ID of the Usergroupmembership",
"maximum": 65535,
"minimum": 0,
"type": "integer",
"example": 21
},
"Field-pkiUserlogintypeID": {
"description": "The unique ID of the Userlogintype\n\nValid values:\n\n|Value|Description|Detail|\n|-|-|-|\n|1|**Email Only**|The Ezsignsigner will receive a secure link by email|\n|2|**Email and phone or SMS**|The Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**|\n|3|**Email and secret question**|The Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer|\n|4|**In person only**|The Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type|\n|5|**In person with phone or SMS**|The Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**|",
"minimum": 0,
"type": "integer",
"example": 2
},
"Field-pkiUserstagedID": {
"description": "The unique ID of the Userstaged",
"maximum": 65535,
"minimum": 1,
"type": "integer",
"example": 90
},
"Field-pkiVariableexpenseID": {
"description": "The unique ID of the Variableexpense",
"maximum": 255,
"minimum": 1,
"type": "integer",
"example": 2
},
"Field-pkiVersionhistoryID": {
"description": "The unique ID of the Versionhistory",
"minimum": 0,
"type": "integer",
"example": 42
},
"Field-pkiWebhookID": {
"description": "The unique ID of the Webhook",
"type": "integer",
"example": 77
},
"Field-pkiWebsitetypeID": {
"description": "The unique ID of the Websitetype.\n\nValid values:\n\n|Value|Description|\n|-|-|\n|1|Website|\n|2|Twitter|\n|3|Facebook|\n|4|Survey|",
"minimum": 0,
"type": "integer",
"example": 1
},
"Field-pksCustomerCode": {
"description": "The customer code assigned to your account",
"maxLength": 6,
"minLength": 2,
"type": "string",
"example": "demo"
},
"Field-pksEzmaxclientOs": {
"description": "The OS of the system running the application",
"enum": [
"iOS",
"macOS",
"Windows"
],
"type": "string",
"example": "Windows"
},
"Field-pksEzmaxcustomerCode": {
"description": "The Ezmaxcustomer code",
"maxLength": 6,
"minLength": 2,
"pattern": "^[a-z\\d]{2,6}$",
"type": "string",
"example": "demo"
},
"Field-sActivesessionLoginname": {
"description": "The loginname of the Activesession",
"pattern": "^.{0,32}$",
"type": "string",
"example": "doej"
},
"Field-sAddressCity": {
"description": "The City name",
"type": "string",
"example": "Laval"
},
"Field-sAddressCivic": {
"description": "The Civic number.",
"type": "string",
"example": "2540"
},
"Field-sAddressStreet": {
"description": "The Street Name",
"type": "string",
"example": "Daniel-Johnson Blvd."
},
"Field-sAddressSuite": {
"description": "The Suite or appartment number",
"type": "string",
"example": "610"
},
"Field-sAddressZip": {
"description": "The Postal/Zip Code\n\nThe value must be entered without spaces",
"type": "string",
"example": "H7T2S3"
},
"Field-sApikeyDescription1": {
"description": "The description of the Apikey in French",
"type": "string",
"example": "Projet X"
},
"Field-sApikeyDescription2": {
"description": "The description of the Apikey in English",
"type": "string",
"example": "Project X"
},
"Field-sApikeyDescriptionX": {
"description": "The description of the Apikey in the language of the requester",
"type": "string",
"example": "Project X"
},
"Field-sBillingentityexternalDescription": {
"description": "The description of the Billingentityexternal",
"type": "string",
"example": "ACME Inc"
},
"Field-sBillingentityinternalDescription1": {
"description": "The description of the Billingentityinternal in French",
"pattern": "^.{0,70}$",
"type": "string",
"example": "Défaut"
},
"Field-sBillingentityinternalDescription2": {
"description": "The description of the Billingentityinternal in English",
"pattern": "^.{0,70}$",
"type": "string",
"example": "Default"
},
"Field-sBillingentityinternalDescriptionX": {
"description": "The description of the Billingentityinternal in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sBrandingDescription1": {
"description": "The description of the Branding in French",
"type": "string",
"example": "Compagnie X"
},
"Field-sBrandingDescription2": {
"description": "The description of the Branding in English",
"type": "string",
"example": "Company X"
},
"Field-sBrandingDescriptionX": {
"description": "The Description of the Branding in the language of the requester",
"type": "string",
"example": "Company X"
},
"Field-sBrandingName": {
"description": "The name of the Branding\n\nThis value will only be set if you wish to overwrite the default name. If you want to keep the default name, leave this property empty",
"pattern": "^.{0,55}$",
"type": "string",
"example": "eZmax (Corp)"
},
"Field-sCognitoClientID": {
"description": "The ID of the client in Cognito",
"type": "string",
"example": "6kivk421lhteuktijfsvv4r1cl"
},
"Field-sCommunicationSubject": {
"description": "The subject of the Communication",
"type": "string",
"example": "This is an example of subject"
},
"Field-sCommunicationattachmentName": {
"description": "The name of the Communicationattachment",
"type": "string",
"example": "File.pdf"
},
"Field-sCompanyNameX": {
"description": "The Name of the Company in the language of the requester",
"type": "string",
"example": "Acme inc."
},
"Field-sComputerDescription": {
"description": "The description of the Computer",
"pattern": "^.{0,50}$",
"type": "string",
"example": "PC001"
},
"Field-sContactCompany": {
"description": "The Company name of the contact",
"type": "string",
"example": "eZmax Solutions Inc."
},
"Field-sContactFirstname": {
"description": "The First name of the contact",
"type": "string",
"example": "John"
},
"Field-sContactLastname": {
"description": "The Last name of the contact",
"type": "string",
"example": "Doe"
},
"Field-sCorsEntryurl": {
"description": "The entryurl of the Cors",
"pattern": "^.{0,2048}$",
"type": "string",
"example": "Https://www.example.com"
},
"Field-sCreditcardtransactionPartiallydecryptednumber": {
"description": "The partially decrypted credit card number used in the Creditcardtransaction",
"pattern": "^([X]{4}[ ]){3}(\\d){4}$",
"type": "string",
"example": "XXXX XXXX XXXX 1234"
},
"Field-sCreditcardtransactionReferencenumber": {
"description": "The reference number on the creditcard service for the Creditcardtransaction",
"pattern": "^[\\d]{18}$",
"type": "string",
"example": "651447854715478415"
},
"Field-sDepartmentNameX": {
"description": "The Name of the Department in the language of the requester",
"type": "string",
"example": "Head Office"
},
"Field-sDescriptionstaticDescription": {
"description": "The description of the Descriptionstatic",
"type": "string",
"example": "Static description"
},
"Field-sEmailAddress": {
"description": "The email address.",
"type": "string",
"example": "email@example.com"
},
"Field-sEmailstaticAddress": {
"description": "The email address.",
"type": "string",
"example": "email@example.com"
},
"Field-sEmailtypeNameX": {
"description": "The name of the Emailtype in the language of the requester",
"pattern": "^.{0,15}$",
"type": "string",
"example": "Office"
},
"Field-sErrorMessage": {
"description": "The message giving details about the error",
"pattern": "^.{0,500}$",
"type": "string",
"example": "Invalid Signature Headers"
},
"Field-sEzmaxinvoicingsummaryexternalDescription": {
"description": "The description of the Ezmaxinvoicingsummaryexternal",
"maxLength": 70,
"type": "string",
"example": "Company Demo"
},
"Field-sEzmaxinvoicingsummaryinternalDescription1": {
"description": "The Ezmaxinvoicingsummaryinternal description in French",
"maxLength": 70,
"type": "string",
"example": "Défaut"
},
"Field-sEzmaxinvoicingsummaryinternalDescription2": {
"description": "The Ezmaxinvoicingsummaryinternal description in English",
"maxLength": 70,
"type": "string",
"example": "Défault"
},
"Field-sEzmaxinvoicingsummaryinternalDescriptionX": {
"description": "The Ezmaxinvoicingsummaryinternal description in the language of the requester",
"maxLength": 70,
"type": "string",
"example": "Défaut"
},
"Field-sEzmaxproductDescriptionX": {
"description": "The description of the Ezmaxproduct in the language of the requester",
"type": "string",
"example": "eZmax (License)"
},
"Field-sEzsignannotationText": {
"description": "The Text of the Ezsignannotation",
"type": "string",
"example": "Sample"
},
"Field-sEzsignbulksendDescription": {
"description": "The description of the Ezsignbulksend",
"type": "string",
"example": "Test eZsign Bulk Send"
},
"Field-sEzsignbulksendsignermappingDescription": {
"description": "The description of the Ezsignbulksendsignermapping",
"type": "string",
"example": "Supervisor"
},
"Field-sEzsignbulksendtransmissionDescription": {
"description": "The description of the Ezsignbulksendtransmission",
"type": "string",
"example": "Test eZsign Bulk Send Transmission #1"
},
"Field-sEzsigndocumentMD5initial": {
"description": "MD5 Hash of the initial PDF Document before signatures were applied to it.",
"type": "string",
"example": "012345678901234567890123456789AB"
},
"Field-sEzsigndocumentMD5signed": {
"description": "MD5 Hash of the final PDF Document after all signatures were applied to it.",
"type": "string",
"example": "012345678901234567890123456789AB"
},
"Field-sEzsigndocumentName": {
"description": "The name of the document that will be presented to Ezsignfoldersignerassociations",
"type": "string",
"example": "Contract #123"
},
"Field-sEzsigndocumentlogDetail": {
"description": "The detail of the Ezsigndocumentlog",
"type": "string",
"example": "Page 1 MD5: a56bbc742ba2a4d074f2493550cf6ea5"
},
"Field-sEzsignfolderDescription": {
"description": "The description of the Ezsignfolder",
"type": "string",
"example": "Test eZsign Folder"
},
"Field-sEzsignfoldertypeName1": {
"description": "The name of the Ezsignfoldertype in French",
"type": "string",
"example": "Embauche"
},
"Field-sEzsignfoldertypeName2": {
"description": "The name of the Ezsignfoldertype in English",
"type": "string",
"example": "Recruitment"
},
"Field-sEzsignfoldertypeNameX": {
"description": "The name of the Ezsignfoldertype in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sEzsignformfieldEnteredvalue": {
"description": "This is the value enterred for the Ezsignformfield\n\nThis can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea**",
"type": "string",
"example": "Montreal"
},
"Field-sEzsignformfieldLabel": {
"description": "The Label for the Ezsignformfield",
"type": "string",
"example": "Peanuts"
},
"Field-sEzsignformfieldValue": {
"description": "The value for the Ezsignformfield\n\nThis can only be set if eEzsignformfieldgroupType is Checkbox or Radio",
"type": "string",
"example": "Yes"
},
"Field-sEzsignformfieldgroupDefaultvalue": {
"description": "The default value for the Ezsignformfieldgroup",
"type": "string",
"example": "Foo"
},
"Field-sEzsignformfieldgroupLabel": {
"description": "The Label for the Ezsignformfieldgroup",
"maxLength": 50,
"minLength": 1,
"type": "string",
"example": "Allergies"
},
"Field-sEzsignformfieldgroupRegexp": {
"description": "A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup.\n\nThis can only be set if eEzsignformfieldgroupType is **Text** or **Textarea**",
"type": "string",
"example": "/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/"
},
"Field-sEzsignsignatureAttachmentdescription": {
"description": "The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments",
"type": "string",
"example": "Attachment"
},
"Field-sEzsignsignatureDescription": {
"description": "The value entered while signing Ezsignsignature of eEzsignsignatureType **City**, **FieldText** and **FieldTextarea**",
"type": "string",
"example": "Montreal"
},
"Field-sEzsignsignatureRegexp": {
"description": "A regular expression to indicate what values are acceptable for the Ezsignsignature.\n\nThis can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** and eEzsignsignatureTextvalidation is **Custom**",
"type": "string",
"example": "/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/"
},
"Field-sEzsignsignatureattachmentName": {
"description": "The name of the Ezsignsignatureattachment",
"pattern": "^.{0,75}$",
"type": "string",
"example": "document.pdf"
},
"Field-sEzsignsignergroupDescription1": {
"description": "The description of the Ezsignsignergroup in French",
"type": "string",
"example": "RH"
},
"Field-sEzsignsignergroupDescription2": {
"description": "The description of the Ezsignsignergroup in English",
"type": "string",
"example": "HR"
},
"Field-sEzsignsignergroupDescriptionX": {
"description": "The Description of the Ezsignsignergroup in the language of the requester",
"type": "string",
"example": "HR"
},
"Field-sEzsigntemplateDescription": {
"description": "The description of the Ezsigntemplate",
"type": "string",
"example": "Standard Contract"
},
"Field-sEzsigntemplatedocumentName": {
"description": "The name of the Ezsigntemplatedocument.",
"type": "string",
"example": "Standard Contract"
},
"Field-sEzsigntemplateformfieldLabel": {
"description": "The Label for the Ezsigntemplateformfield",
"type": "string",
"example": "Peanuts"
},
"Field-sEzsigntemplateformfieldValue": {
"description": "The value for the Ezsigntemplateformfield",
"type": "string",
"example": "Yes"
},
"Field-sEzsigntemplateformfieldgroupDefaultvalue": {
"description": "The default value for the Ezsigntemplateformfieldgroup",
"type": "string",
"example": "Foo"
},
"Field-sEzsigntemplateformfieldgroupLabel": {
"description": "The Label for the Ezsigntemplateformfieldgroup",
"maxLength": 50,
"minLength": 1,
"type": "string",
"example": "Allergies"
},
"Field-sEzsigntemplateformfieldgroupRegexp": {
"description": "A regular expression to indicate what values are acceptable for the Ezsigntemplateformfieldgroup.\n\nThis can only be set if eEzsigntemplateformfieldgroupType is **Text** or **Textarea**",
"type": "string",
"example": "/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/"
},
"Field-sEzsigntemplatepackageDescription": {
"description": "The description of the Ezsigntemplatepackage",
"type": "string",
"example": "Package for new clients"
},
"Field-sEzsigntemplatepackagesignerDescription": {
"description": "The description of the Ezsigntemplatepackagesigner",
"type": "string",
"example": "Customer"
},
"Field-sEzsigntemplatesignatureAttachmentdescription": {
"description": "The description attached to the attachment name added in Ezsigntemplatesignature of eEzsigntemplatesignatureType Attachments",
"type": "string",
"example": "Attachment"
},
"Field-sEzsigntemplatesignatureRegexp": {
"description": "A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature.\n\nThis can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea**",
"type": "string",
"example": "/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/"
},
"Field-sEzsigntemplatesigner": {
"description": "The First name of the user",
"type": "string",
"example": "John"
},
"Field-sEzsigntemplatesignerDescription": {
"description": "The description of the Ezsigntemplatesigner",
"type": "string",
"example": "Customer"
},
"Field-sEzsigntsarequirementDescriptionX": {
"description": "The description of the Ezsigntsarequirement in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sFilter": {
"description": "The filter to apply to the request to limit results.",
"type": "string",
"example": "bField1 eq true and iField2 gte 0 and iField2 lte 1000 and sField3 eq 'Other' and eField4 eq 'Paid' and sField5 like '%needle%' and iField6 in '1,2,3' and dtField7 rg '=m,=3mm'"
},
"Field-sFontName": {
"description": "The name of the Font",
"pattern": "^.{0,50}$",
"type": "string",
"example": "Arial"
},
"Field-sFranchisebrokerName": {
"description": "The name of the Franchisebroker in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sFranchiseofficeDescription": {
"description": "The description of the Franchiseoffice in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sInfrastructureenvironmenttypeDescription": {
"description": "The environment type Description",
"type": "string",
"example": "prod"
},
"Field-sInfrastructureregionCode": {
"description": "The region code",
"type": "string",
"example": "ca-central-1"
},
"Field-sLanguageNameX": {
"description": "The Name of the Language in the language of the requester",
"type": "string",
"example": "English"
},
"Field-sModuleNameX": {
"description": "The Name of the Module in the language of the requester",
"type": "string",
"example": "Purchase"
},
"Field-sModulegroupNameX": {
"description": "The name of the Modulegroup in the language of the requester",
"pattern": "^.{0,25}$",
"type": "string",
"example": "Management"
},
"Field-sModulesectionInternalname": {
"description": "The Internal name of the Module section.",
"type": "string",
"example": "Access"
},
"Field-sModulesectionNameX": {
"description": "The Name of the Modulesection in the language of the requester",
"type": "string",
"example": "Access"
},
"Field-sNotificationsectionNameX": {
"description": "The name of the Notificationsection in the language of the requester",
"type": "string",
"example": "Homepage"
},
"Field-sNotificationsubsectionName1": {
"description": "The name of the Notificationsubsection in French",
"type": "string",
"example": "Signature électronique"
},
"Field-sNotificationsubsectionName2": {
"description": "The name of the Notificationsubsection in English",
"type": "string",
"example": "Electronic signature"
},
"Field-sNotificationsubsectionNameX": {
"description": "The name of the Notificationsubsection in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sNotificationtestFunction": {
"description": "The function name of the Notificationtest",
"type": "string",
"example": "Default"
},
"Field-sNotificationtestName1": {
"description": "The name of the Notificationtest in French",
"type": "string",
"example": "Default"
},
"Field-sNotificationtestName2": {
"description": "The name of the Notificationtest in English",
"type": "string",
"example": "Default"
},
"Field-sNotificationtestNameX": {
"description": "The name of the Notificationtest in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sPaymenttermCode": {
"description": "The code of the Paymentterm",
"pattern": "^[A-Z0-9]{1,4}$",
"type": "string",
"example": "0030"
},
"Field-sPaymenttermDescription1": {
"description": "The description of the Paymentterm in French",
"pattern": "^.{1,40}$",
"type": "string",
"example": "Net 30 jours"
},
"Field-sPaymenttermDescription2": {
"description": "The description of the Paymentterm in English",
"pattern": "^.{1,40}$",
"type": "string",
"example": "Net 30 days"
},
"Field-sPaymenttermDescriptionX": {
"description": "The description of the Paymentterm in the language of the requester",
"pattern": "^.{1,40}$",
"type": "string",
"example": "Net 30 days"
},
"Field-sPeriodYYYYMM": {
"description": "The YYYYMM of the Period",
"type": "string",
"example": "2202-12"
},
"Field-sPhoneE164": {
"description": "A phone number in E.164 Format",
"pattern": "^\\+[1-9]\\d{1,14}$",
"type": "string",
"example": "+15149901516"
},
"Field-sPhoneExchange": {
"deprecated": true,
"description": "The exchange of the phone number. (For a North America Number only)\n\nThe exchange is the \"990\" section in this sample phone number: (514) 990-1516 x123",
"type": "string",
"example": "990"
},
"Field-sPhoneExtension": {
"description": "The extension of the phone number.\n\nThe extension is the \"123\" section in this sample phone number: (514) 990-1516 x123.\n\nIt can also be used with international phone numbers",
"type": "string",
"example": "123"
},
"Field-sPhoneInternational": {
"deprecated": true,
"description": "The international phone number.",
"type": "string",
"example": "15149901516"
},
"Field-sPhoneRegion": {
"deprecated": true,
"description": "The region of the phone number. (For a North America Number only)\n\nThe region is the \"514\" section in this sample phone number: (514) 990-1516 x123",
"type": "string",
"example": "514"
},
"Field-sPhonestaticE164": {
"description": "A phone number in E.164 Format",
"pattern": "^\\+[1-9]\\d{1,14}$",
"type": "string",
"example": "+15149901516"
},
"Field-sPhonestaticExtension": {
"description": "The extension of the phone number.",
"pattern": "^\\d",
"type": "string",
"example": "123"
},
"Field-sPhonetypeNameX": {
"description": "The name of the Phonetype in the language of the requester",
"pattern": "^.{0,20}$",
"type": "string",
"example": "Office"
},
"Field-sReportgroupCacheID": {
"description": "A cache ID to regenerate the same report without computing the data again.",
"pattern": "^[a-f\\\\d]{64}$",
"type": "string",
"example": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"
},
"Field-sSecretquestionTextX": {
"description": "The text of the Secretquestion in the language of the requester",
"type": "string",
"example": "The name of the hospital in which you were born"
},
"Field-sSubnetDescription1": {
"description": "The description of the Subnet in French",
"pattern": "^.{0,50}$",
"type": "string",
"example": "Bureau chef"
},
"Field-sSubnetDescription2": {
"description": "The description of the Subnet in English",
"pattern": "^.{0,50}$",
"type": "string",
"example": "Head office"
},
"Field-sSystemconfigurationtypeDescriptionX": {
"description": "The description of the Systemconfigurationtype in the language of the requester",
"type": "string",
"example": "eZsign (Pro)"
},
"Field-sTaxassignmentDescriptionX": {
"description": "The description of the Taxassignment in the language of the requester",
"type": "string",
"example": "Default"
},
"Field-sTimezoneName": {
"description": "The description of the Timezone",
"type": "string",
"example": "Default"
},
"Field-sUserFirstname": {
"description": "The first name of the user",
"type": "string",
"example": "John"
},
"Field-sUserLastname": {
"description": "The last name of the user",
"type": "string",
"example": "Doe"
},
"Field-sUserLoginname": {
"description": "The login name of the User.",
"pattern": "^(?:([\\w\\.-]+@[\\w\\.-]+\\.\\w{2,4})|([a-zA-Z0-9]){1,32})$",
"type": "string",
"example": "JohnDoe"
},
"Field-sUserSecretresponse": {
"description": "The answer to the Secretquestion",
"type": "string",
"example": "Montreal General Hospital"
},
"Field-sUsergroupName1": {
"description": "The name of the Usergroup in French",
"pattern": "^.{0,50}$",
"type": "string",
"example": "Direction"
},
"Field-sUsergroupName2": {
"description": "The name of the Usergroup in English",
"pattern": "^.{0,50}$",
"type": "string",
"example": "Management"
},
"Field-sUsergroupNameX": {
"description": "The Name of the Usergroup in the language of the requester",
"pattern": "^.{0,50}$",
"type": "string",
"example": "Administration"
},
"Field-sUserlogintypeDescriptionX": {
"description": "The description of the Userlogintype in the language of the requester",
"type": "string",
"example": "Email and phone or SMS"
},
"Field-sUserstagedExternalid": {
"description": "The externalid of the Userstaged",
"pattern": "^.{1,60}$",
"type": "string",
"example": "azuread_6b303ca8-9e34-4c21-9a53-0856342dec5e"
},
"Field-sUserstagedFirstname": {
"description": "The firstname of the Userstaged",
"pattern": "^.{0,20}$",
"type": "string",
"example": "Jane"
},
"Field-sUserstagedLastname": {
"description": "The lastname of the Userstaged",
"pattern": "^.{0,25}$",
"type": "string",
"example": "Doe"
},
"Field-sVariableexpenseCode": {
"description": "The code of the Variableexpense",
"pattern": "^.{0,5}$",
"type": "string",
"example": "EQBUR"
},
"Field-sVariableexpenseDescription1": {
"description": "The description of the Variableexpense in French",
"pattern": "^.{0,40}$",
"type": "string",
"example": "Équipements de bureau"
},
"Field-sVariableexpenseDescription2": {
"description": "The description of the Variableexpense in English",
"pattern": "^.{0,40}$",
"type": "string",
"example": "Office equipment"
},
"Field-sVariableexpenseDescriptionX": {
"description": "The description of the Variableexpense in the language of the requester",
"pattern": "^.{0,40}$",
"type": "string",
"example": "Équipements de bureau"
},
"Field-sVariableobjectProperty": {
"description": "The name of the Property used in the Variableobject",
"type": "string",
"example": "PropertyName1"
},
"Field-sWebhookDescription": {
"description": "The description of the Webhook",
"type": "string",
"example": "Import into our system"
},
"Field-sWebhookEmailfailed": {
"description": "The email that will receive the Webhook in case all attempts fail",
"type": "string",
"example": "email@example.com"
},
"Field-sWebhookUrl": {
"description": "The URL of the Webhook callback",
"type": "string",
"example": "https://www.example.com"
},
"Field-sWebsiteAddress": {
"description": "The URL of the website.",
"type": "string",
"example": "https://www.example.com"
},
"Field-sWebsocketID": {
"description": "The Unique ID of the Websocket Connection",
"pattern": "^[a-zA-Z0-9_-]{15}=$",
"type": "string",
"example": "G_omidyY4osCFEQ="
},
"Field-tExtraMessage": {
"description": "A custom text message that will be added to the email sent.",
"type": "string",
"example": "Hi John,\n\nThis is the document I need you to review.\n\nCould you sign it before Monday please.\n\nBest Regards.\n\nMary"
},
"Field-tEzmaxproductHelpX": {
"description": "The help message of the Ezmaxproduct in the language of the requester",
"type": "string",
"example": "This is an exemple of help message"
},
"Field-tEzsignbulksendNote": {
"description": "Note about the Ezsignbulksend",
"type": "string",
"example": "This is a note"
},
"Field-tEzsigndocumentDeclinedtosignreason": {
"description": "A custom text message that will contain the refusal message if the Ezsigndocument is declined to sign",
"type": "string",
"example": "The conditions in the contract are different than those discuted"
},
"Field-tEzsignfolderMessage": {
"description": "A custom text message that will be added to the email sent.",
"type": "string",
"example": "Hi everyone,\n\nThis is the document I need you to review.\n\nCould you sign it before Monday please.\n\nBest Regards.\n\nMary"
},
"Field-tEzsignfolderNote": {
"description": "Note about the Ezsignfolder",
"type": "string",
"example": "This is a note"
},
"Field-tEzsignfoldersignerassociationMessage": {
"description": "A custom text message that will be added to the email sent.",
"type": "string",
"example": "Hi John,\n\nThis is the document I need you to review.\n\nCould you sign it before Monday please.\n\nBest Regards.\n\nMary"
},
"Field-tEzsignformfieldgroupTooltip": {
"description": "A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup",
"type": "string",
"example": "Please enter a valid email address"
},
"Field-tEzsignsignatureTooltip": {
"description": "A tooltip that will be presented to Ezsignsigner about the Ezsignsignature",
"type": "string",
"example": "Please sign here if you agree to the terms"
},
"Field-tEzsigntemplateformfieldgroupTooltip": {
"description": "A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplateformfieldgroup",
"type": "string",
"example": "Please enter a valid email address"
},
"Field-tEzsigntemplatesignatureTooltip": {
"description": "A tooltip that will be presented to Ezsigntemplatesigner about the Ezsigntemplatesignature",
"type": "string",
"example": "Please sign here if you agree to the terms"
},
"Field-tFranchisereferalincomeComment": {
"description": "Comment about the transaction",
"type": "string",
"example": "This is a comment"
},
"Field-tSignatureSvg": {
"description": "The svg of the Signature",
"pattern": "^.{0,32767}$",
"type": "string",
"example": {
"$ref": "#/components/examples/Svg/value"
}
},
"Field-tVersionhistoryDetail1": {
"description": "Detail of the Versionhistory in French",
"type": "string",
"example": "Message important"
},
"Field-tVersionhistoryDetail2": {
"description": "Detail of the Versionhistory in English",
"type": "string",
"example": "Important message"
},
"Field-tWebhooklogJson": {
"description": "The Json containing the Webhook call and return",
"type": "string",
"example": "{}"
},
"Field-yyyymmEzmaxinvoicing": {
"description": "The YYYYMM period of the Ezmaxinvoicing",
"maxLength": 7,
"type": "string",
"example": "2022-01"
},
"File-Csv": {
"description": "A Comma separated values text file",
"type": "string"
},
"File-Html": {
"description": "An HTML File",
"type": "string"
},
"File-Pdf": {
"format": "binary",
"description": "A PDF File",
"type": "string"
},
"File-Xlsx": {
"format": "binary",
"description": "A Microsoft Excel File",
"type": "string"
},
"File-Zip": {
"format": "binary",
"description": "A Zip compressed archive",
"type": "string"
},
"Header-Accept-Language": {
"description": "The language of the returned content.\n\n1. **\\*** (or header not defined) Default language\n2. **en** English\n2. **fr** French\n\n",
"enum": [
"*",
"en",
"fr"
],
"type": "string",
"example": "en"
},
"Multilingual-ApikeyDescription": {
"description": "Description of the API Key",
"type": "object",
"properties": {
"sApikeyDescription1": {
"$ref": "#/components/schemas/Field-sApikeyDescription1"
},
"sApikeyDescription2": {
"$ref": "#/components/schemas/Field-sApikeyDescription2"
}
}
},
"Multilingual-BillingentityinternalDescription": {
"description": "The description of the Billingentityinternal",
"type": "object",
"properties": {
"sBillingentityinternalDescription1": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescription1"
},
"sBillingentityinternalDescription2": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescription2"
}
}
},
"Multilingual-BrandingDescription": {
"description": "Description of the Branding",
"type": "object",
"properties": {
"sBrandingDescription1": {
"$ref": "#/components/schemas/Field-sBrandingDescription1"
},
"sBrandingDescription2": {
"$ref": "#/components/schemas/Field-sBrandingDescription2"
}
}
},
"Multilingual-EzmaxinvoicingsummaryinternalDescription": {
"description": "Description of the Ezmaxinvoicingsummaryinternal",
"type": "object",
"properties": {
"sEzmaxinvoicingsummaryinternalDescription1": {
"$ref": "#/components/schemas/Field-sEzmaxinvoicingsummaryinternalDescription1"
},
"sEzmaxinvoicingsummaryinternalDescription2": {
"$ref": "#/components/schemas/Field-sEzmaxinvoicingsummaryinternalDescription2"
}
}
},
"Multilingual-EzsignfoldertypeName": {
"description": "Name of the Ezsignfoldertype",
"type": "object",
"properties": {
"sEzsignfoldertypeName1": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeName1"
},
"sEzsignfoldertypeName2": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeName2"
}
}
},
"Multilingual-EzsignsignergroupDescription": {
"description": "Description of the Ezsignsignergroup",
"type": "object",
"properties": {
"sEzsignsignergroupDescription1": {
"$ref": "#/components/schemas/Field-sEzsignsignergroupDescription1"
},
"sEzsignsignergroupDescription2": {
"$ref": "#/components/schemas/Field-sEzsignsignergroupDescription2"
}
}
},
"Multilingual-NotificationsubsectionName": {
"description": "Name of the Notificationsubsection",
"type": "object",
"properties": {
"sNotificationsubsectionName1": {
"$ref": "#/components/schemas/Field-sNotificationsubsectionName1"
},
"sNotificationsubsectionName2": {
"$ref": "#/components/schemas/Field-sNotificationsubsectionName2"
}
}
},
"Multilingual-NotificationtestName": {
"description": "Name of the Notificationtest",
"type": "object",
"properties": {
"sNotificationtestName1": {
"$ref": "#/components/schemas/Field-sNotificationtestName1"
},
"sNotificationtestName2": {
"$ref": "#/components/schemas/Field-sNotificationtestName2"
}
}
},
"Multilingual-PaymenttermDescription": {
"description": "Description of the Paymentterm",
"type": "object",
"properties": {
"sPaymenttermDescription1": {
"$ref": "#/components/schemas/Field-sPaymenttermDescription1"
},
"sPaymenttermDescription2": {
"$ref": "#/components/schemas/Field-sPaymenttermDescription2"
}
}
},
"Multilingual-SubnetDescription": {
"description": "The description of the Subnet",
"type": "object",
"properties": {
"sSubnetDescription1": {
"$ref": "#/components/schemas/Field-sSubnetDescription1"
},
"sSubnetDescription2": {
"$ref": "#/components/schemas/Field-sSubnetDescription2"
}
}
},
"Multilingual-UsergroupName": {
"description": "The name of the Usergroup",
"type": "object",
"properties": {
"sUsergroupName1": {
"$ref": "#/components/schemas/Field-sUsergroupName1"
},
"sUsergroupName2": {
"$ref": "#/components/schemas/Field-sUsergroupName2"
}
}
},
"Multilingual-VariableexpenseDescription": {
"description": "The description of the Variableexpense",
"type": "object",
"properties": {
"sVariableexpenseDescription1": {
"$ref": "#/components/schemas/Field-sVariableexpenseDescription1"
},
"sVariableexpenseDescription2": {
"$ref": "#/components/schemas/Field-sVariableexpenseDescription2"
}
}
},
"Multilingual-VersionhistoryDetail": {
"description": "Detail of the Versionhistory",
"type": "object",
"properties": {
"tVersionhistoryDetail1": {
"$ref": "#/components/schemas/Field-tVersionhistoryDetail1"
},
"tVersionhistoryDetail2": {
"$ref": "#/components/schemas/Field-tVersionhistoryDetail2"
}
}
},
"Scim-AuthenticationScheme": {
"required": [
"description",
"name",
"type"
],
"type": "object",
"properties": {
"description": {
"description": "A description of the authentication scheme.",
"type": "string",
"example": "Bearer token in the Authorization header"
},
"name": {
"description": "The common authentication scheme name",
"type": "string",
"example": "Bearer"
},
"type": {
"description": "The authentication scheme.",
"enum": [
"oauth",
"oauth2",
"oauthbearertoken",
"httpbasic",
"httpdigest"
],
"type": "string",
"example": "oauthbearertoken"
}
}
},
"Scim-Email": {
"type": "object",
"properties": {
"value": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"primary": {
"type": "boolean"
}
}
},
"Scim-Group": {
"required": [
"displayName"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"displayName": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Scim-GroupMember"
}
}
}
},
"Scim-GroupMember": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"display": {
"type": "string"
},
"type": {
"type": "string"
},
"$ref": {
"type": "string"
}
}
},
"Scim-ServiceProviderConfig": {
"required": [
"authenticationSchemes",
"bulk",
"changePassword",
"documentationUri",
"etag",
"filter",
"patch",
"sort"
],
"type": "object",
"properties": {
"authenticationSchemes": {
"description": "A multi-valued complex type that specifies supported authentication scheme properties.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Scim-AuthenticationScheme"
}
},
"bulk": {
"description": "A complex type that specifies bulk configuration options.",
"required": [
"supported",
"maxOperations",
"maxPayloadSize"
],
"type": "object",
"properties": {
"supported": {
"description": "A Boolean value specifying whether or not the operation is supported.",
"type": "boolean",
"example": false
},
"maxOperations": {
"description": "An integer value specifying the maximum number of operations.",
"type": "integer",
"example": 0
},
"maxPayloadSize": {
"description": "An integer value specifying the maximum payload size in bytes.",
"type": "integer",
"example": 0
}
}
},
"changePassword": {
"description": "A complex type that specifies configuration options related to changing a password.",
"required": [
"supported"
],
"type": "object",
"properties": {
"supported": {
"description": "A Boolean value specifying whether or not the operation is supported.",
"type": "boolean",
"example": false
}
}
},
"documentationUri": {
"description": "An HTTP-addressable URL pointing to the service provider's human-consumable help documentation",
"type": "string",
"example": "https://github.com/eZmaxinc/eZmax-API"
},
"etag": {
"description": "A complex type that specifies ETag configuration options.",
"required": [
"supported"
],
"type": "object",
"properties": {
"supported": {
"description": "A Boolean value specifying whether or not the operation is supported.",
"type": "boolean",
"example": false
}
}
},
"filter": {
"description": "A complex type that specifies FILTER options.",
"required": [
"supported",
"maxResults"
],
"type": "object",
"properties": {
"supported": {
"description": "A Boolean value specifying whether or not the operation is supported.",
"type": "boolean",
"example": true
},
"maxResults": {
"description": "An integer value specifying the maximum number of resources returned in a response.",
"type": "integer",
"example": 10000
}
}
},
"patch": {
"description": "A complex type that specifies PATCH configuration options.",
"required": [
"supported"
],
"type": "object",
"properties": {
"supported": {
"description": "A Boolean value specifying whether or not the operation is supported.",
"type": "boolean",
"example": false
}
}
},
"sort": {
"description": "A complex type that specifies Sort configuration options.",
"required": [
"supported"
],
"type": "object",
"properties": {
"supported": {
"description": "A Boolean value specifying whether or not sorting is supported.",
"type": "boolean",
"example": false
}
}
}
}
},
"Scim-User": {
"required": [
"userName"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userName": {
"description": "A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider.\r\nOften displayed to the user as their unique identifier within the system (as opposed to \"id\" or \"externalId\", which are generally opaque and not user-friendly identifiers).\r\nEach User MUST include a non-empty userName value.\r\nThis identifier MUST be unique across the service provider's entire set of Users.\r\nThis attribute is REQUIRED and is case insensitive.",
"type": "string"
},
"displayName": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Scim-Email"
}
}
}
},
"Scim-UserList": {
"type": "object",
"properties": {
"totalResults": {
"type": "integer"
},
"itemsPerPage": {
"type": "integer"
},
"startIndex": {
"type": "integer"
},
"schemas": {
"type": "array",
"items": {
"type": "string"
}
},
"Resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Scim-User"
}
}
}
},
"Webhook-Ezsign-DocumentCompleted": {
"description": "This is the base Webhook object",
"type": "object",
"allOf": [
{
"required": [
"objEzsigndocument"
],
"type": "object",
"properties": {
"objEzsigndocument": {
"$ref": "#/components/schemas/ezsigndocument-Response"
}
}
},
{
"$ref": "#/components/schemas/Common-Webhook"
}
]
},
"Webhook-Ezsign-EzsignsignerAcceptclause": {
"description": "This is the base Webhook object",
"type": "object",
"allOf": [
{
"required": [
"objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"objEzsignfolder": {
"$ref": "#/components/schemas/ezsignfolder-Response"
},
"objEzsignfoldersignerassociation": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound"
}
}
},
{
"$ref": "#/components/schemas/Common-Webhook"
}
]
},
"Webhook-Ezsign-EzsignsignerConnect": {
"description": "This is the base Webhook object",
"type": "object",
"allOf": [
{
"required": [
"objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"objEzsignfolder": {
"$ref": "#/components/schemas/ezsignfolder-Response"
},
"objEzsignfoldersignerassociation": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound"
}
}
},
{
"$ref": "#/components/schemas/Common-Webhook"
}
]
},
"Webhook-Ezsign-FolderCompleted": {
"description": "This is the base Webhook object",
"type": "object",
"allOf": [
{
"required": [
"objEzsignfolder"
],
"type": "object",
"properties": {
"objEzsignfolder": {
"$ref": "#/components/schemas/ezsignfolder-Response"
}
}
},
{
"$ref": "#/components/schemas/Common-Webhook"
}
]
},
"Webhook-User-UserCreated": {
"description": "This is the base Webhook object",
"type": "object",
"allOf": [
{
"required": [
"objUser"
],
"type": "object",
"properties": {
"objUser": {
"$ref": "#/components/schemas/user-ResponseCompound"
}
}
},
{
"$ref": "#/components/schemas/Common-Webhook"
}
]
},
"Webhook-Userstaged-UserstagedCreated": {
"description": "This is the base Webhook object",
"type": "object",
"allOf": [
{
"required": [
"objUserstaged"
],
"type": "object",
"properties": {
"objUserstaged": {
"$ref": "#/components/schemas/userstaged-ResponseCompound"
}
}
},
{
"$ref": "#/components/schemas/Common-Webhook"
}
]
},
"Websocket-RequestServer-GetWebsocketID-V1": {
"description": "Request for Websocket GetWebsocketID V1",
"required": [
"eWebsocketMessagetype"
],
"type": "object",
"properties": {
"eWebsocketMessagetype": {
"description": "The Type of message",
"enum": [
"RequestServer-GetWebsocketID-V1"
],
"type": "string"
}
}
},
"Websocket-Response-Error-V1": {
"description": "Response for Websocket Error V1",
"required": [
"eWebsocketMessagetype",
"mPayload"
],
"type": "object",
"properties": {
"eWebsocketMessagetype": {
"description": "The Type of message",
"enum": [
"Response-Error-V1"
],
"type": "string"
},
"mPayload": {
"$ref": "#/components/schemas/Websocket-Response-Error-V1-mPayload"
}
}
},
"Websocket-Response-Error-V1-mPayload": {
"description": "Payload for Websocket Error V1",
"required": [
"eErrorCode",
"sErrorMessage"
],
"type": "object",
"properties": {
"sErrorMessage": {
"$ref": "#/components/schemas/Field-sErrorMessage"
},
"eErrorCode": {
"$ref": "#/components/schemas/Field-eErrorCode"
}
}
},
"Websocket-Response-GetWebsocketID-V1": {
"description": "Response for Websocket GetWebsocketID V1",
"required": [
"eWebsocketMessagetype",
"mPayload"
],
"type": "object",
"properties": {
"eWebsocketMessagetype": {
"description": "The Type of message",
"enum": [
"Response-GetWebsocketID-V1"
],
"type": "string"
},
"mPayload": {
"$ref": "#/components/schemas/Websocket-Response-GetWebsocketID-V1-mPayload"
}
}
},
"Websocket-Response-GetWebsocketID-V1-mPayload": {
"description": "Payload for Websocket GetWebsocketID V1",
"required": [
"sWebsocketID"
],
"type": "object",
"properties": {
"sWebsocketID": {
"$ref": "#/components/schemas/Field-sWebsocketID"
}
}
},
"Websocket-Response-Information-V1": {
"description": "Response for Websocket Information V1",
"required": [
"eWebsocketMessagetype",
"mPayload"
],
"type": "object",
"properties": {
"eWebsocketMessagetype": {
"description": "The Type of message",
"enum": [
"Response-Information-V1"
],
"type": "string"
},
"mPayload": {
"$ref": "#/components/schemas/Websocket-Response-Information-V1-mPayload"
}
}
},
"Websocket-Response-Information-V1-mPayload": {
"description": "Payload for Websocket Information V1",
"required": [
"sInformationMessage"
],
"type": "object",
"properties": {
"sInformationMessage": {
"description": "Information message",
"type": "string",
"example": "Rasterizing pages"
}
}
},
"activesession-ListElement": {
"description": "A Activesession List Element",
"required": [
"pkiActivesessionID",
"fkiUserID",
"fkiComputerID",
"fkiCompanyID",
"fkiDepartmentID",
"sCompanyNameX",
"sDepartmentNameX",
"sActivesessionLoginname",
"sComputerDescription",
"dtActivesessionFirsthit",
"dtActivesessionLasthit",
"sActivesessionIP"
],
"type": "object",
"properties": {
"pkiActivesessionID": {
"$ref": "#/components/schemas/Field-pkiActivesessionID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiComputerID": {
"$ref": "#/components/schemas/Field-pkiComputerID"
},
"fkiCompanyID": {
"$ref": "#/components/schemas/Field-pkiCompanyID"
},
"fkiDepartmentID": {
"$ref": "#/components/schemas/Field-pkiDepartmentID"
},
"sCompanyNameX": {
"$ref": "#/components/schemas/Field-sCompanyNameX"
},
"sDepartmentNameX": {
"$ref": "#/components/schemas/Field-sDepartmentNameX"
},
"sActivesessionLoginname": {
"$ref": "#/components/schemas/Field-sActivesessionLoginname"
},
"sComputerDescription": {
"$ref": "#/components/schemas/Field-sComputerDescription"
},
"dtActivesessionFirsthit": {
"$ref": "#/components/schemas/Field-dtActivesessionFirsthit"
},
"dtActivesessionLasthit": {
"$ref": "#/components/schemas/Field-dtActivesessionLasthit"
},
"sActivesessionIP": {
"$ref": "#/components/schemas/Common-Format-IP"
}
}
},
"activesession-Response": {
"description": "An Activesession Object",
"required": [
"eActivesessionUsertype",
"eActivesessionOrigin",
"eActivesessionWeekdaystart",
"bActivesessionDebug",
"bActivesessionIssuperadmin",
"fkiLanguageID",
"sCompanyNameX",
"pksCustomerCode",
"sDepartmentNameX",
"pkiSystemconfigurationtypeID"
],
"type": "object",
"properties": {
"eActivesessionUsertype": {
"$ref": "#/components/schemas/Field-eActivesessionUsertype"
},
"eActivesessionOrigin": {
"$ref": "#/components/schemas/Field-eActivesessionOrigin"
},
"eActivesessionWeekdaystart": {
"$ref": "#/components/schemas/Field-eActivesessionWeekdaystart"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sCompanyNameX": {
"$ref": "#/components/schemas/Field-sCompanyNameX"
},
"sDepartmentNameX": {
"$ref": "#/components/schemas/Field-sDepartmentNameX"
},
"bActivesessionDebug": {
"$ref": "#/components/schemas/Field-bActivesessionDebug"
},
"bActivesessionIssuperadmin": {
"$ref": "#/components/schemas/Field-bActivesessionIssuperadmin"
},
"pksCustomerCode": {
"$ref": "#/components/schemas/Field-pksCustomerCode"
},
"fkiSystemconfigurationtypeID": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationtypeID"
},
"fkiSignatureID": {
"$ref": "#/components/schemas/Field-pkiSignatureID"
}
}
},
"activesession-ResponseCompound": {
"description": "Payload for GET /1/object/activesession/getCurrent",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/activesession-Response"
},
{
"required": [
"a_Permissions",
"a_eModuleInternalname",
"objUserReal",
"a_pkiPermissionID"
],
"type": "object",
"properties": {
"a_pkiPermissionID": {
"description": "An array of permissions granted to the user or api key",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiModulesectionID"
}
},
"objUserReal": {
"$ref": "#/components/schemas/activesession-ResponseCompound-User"
},
"objUserCloned": {
"$ref": "#/components/schemas/activesession-ResponseCompound-User"
},
"objApikey": {
"$ref": "#/components/schemas/activesession-ResponseCompound-Apikey"
},
"a_eModuleInternalname": {
"description": "An Array of Registered modules.\n\nThese are the modules that are Licensed to be used by the User or the API Key.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-eModuleInternalname"
}
}
}
}
]
},
"activesession-ResponseCompound-Apikey": {
"description": "An Activesession->Apikey object and children to create a complete structure",
"required": [
"pkiApikeyID",
"sApikeyDescriptionX"
],
"type": "object",
"properties": {
"pkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"sApikeyDescriptionX": {
"$ref": "#/components/schemas/Field-sApikeyDescriptionX"
}
}
},
"activesession-ResponseCompound-User": {
"description": "An Activesession->User Object and children to create a complete structure",
"required": [
"pkiUserID",
"fkiTimezoneID",
"sUserFirstname",
"sUserLastname",
"sEmailAddress",
"sAvatarUrl",
"eUserEzsignsendreminderfrequency",
"iUserInterfacecolor",
"bUserInterfacedark",
"iUserListresult"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiTimezoneID": {
"$ref": "#/components/schemas/Field-pkiTimezoneID"
},
"sAvatarUrl": {
"$ref": "#/components/schemas/Computed-sAvatarUrl"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"eUserEzsignsendreminderfrequency": {
"$ref": "#/components/schemas/Field-eUserEzsignsendreminderfrequency"
},
"iUserInterfacecolor": {
"$ref": "#/components/schemas/Field-iUserInterfacecolor"
},
"bUserInterfacedark": {
"$ref": "#/components/schemas/Field-bUserInterfacedark"
},
"iUserListresult": {
"$ref": "#/components/schemas/Field-iUserListresult"
}
}
},
"activesession-getCurrent-v1-Response": {
"description": "Response for GET /1/object/activesession/getCurrent",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/activesession-getCurrent-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"activesession-getCurrent-v1-Response-mPayload": {
"description": "Payload for GET /1/object/activesession/getCurrent",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/activesession-ResponseCompound"
}
]
},
"activesession-getList-v1-Response": {
"description": "Response for GET /1/object/activesession/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/activesession-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"activesession-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/activesession/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objActivesession"
],
"type": "object",
"properties": {
"a_objActivesession": {
"type": "array",
"items": {
"$ref": "#/components/schemas/activesession-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"address-Request": {
"description": "An Address Object",
"required": [
"fkiAddresstypeID",
"sAddressCivic",
"sAddressStreet",
"sAddressSuite",
"sAddressCity",
"fkiProvinceID",
"fkiCountryID",
"sAddressZip"
],
"type": "object",
"properties": {
"fkiAddresstypeID": {
"$ref": "#/components/schemas/Field-pkiAddresstypeID"
},
"sAddressCivic": {
"$ref": "#/components/schemas/Field-sAddressCivic"
},
"sAddressStreet": {
"$ref": "#/components/schemas/Field-sAddressStreet"
},
"sAddressSuite": {
"$ref": "#/components/schemas/Field-sAddressSuite"
},
"sAddressCity": {
"$ref": "#/components/schemas/Field-sAddressCity"
},
"fkiProvinceID": {
"$ref": "#/components/schemas/Field-pkiProvinceID"
},
"fkiCountryID": {
"$ref": "#/components/schemas/Field-pkiCountryID"
},
"sAddressZip": {
"$ref": "#/components/schemas/Field-sAddressZip"
}
}
},
"address-RequestCompound": {
"description": "An Address Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/address-Request"
}
]
},
"apikey-ListElement": {
"description": "A Branding List Element",
"required": [
"pkiApikeyID",
"sApikeyDescriptionX",
"sUserFirstname",
"sUserLastname",
"bApikeyIsactive",
"bApikeyIssigned"
],
"type": "object",
"properties": {
"pkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"sApikeyDescriptionX": {
"$ref": "#/components/schemas/Field-sApikeyDescriptionX"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"bApikeyIsactive": {
"$ref": "#/components/schemas/Field-bApikeyIsactive"
},
"bApikeyIssigned": {
"$ref": "#/components/schemas/Field-bApikeyIssigned"
}
}
},
"apikey-Request": {
"description": "An Apikey Object",
"required": [
"fkiUserID",
"objApikeyDescription"
],
"type": "object",
"properties": {
"pkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"objApikeyDescription": {
"$ref": "#/components/schemas/Multilingual-ApikeyDescription"
},
"bApikeyIsactive": {
"$ref": "#/components/schemas/Field-bApikeyIsactive"
},
"bApikeyIssigned": {
"$ref": "#/components/schemas/Field-bApikeyIssigned"
}
}
},
"apikey-RequestCompound": {
"description": "An Apikey Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/apikey-Request"
}
]
},
"apikey-Response": {
"description": "An Apikey Object",
"required": [
"pkiApikeyID",
"fkiUserID",
"objApikeyDescription",
"objContactName",
"bApikeyIsactive",
"objAudit"
],
"type": "object",
"properties": {
"pkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"objApikeyDescription": {
"$ref": "#/components/schemas/Multilingual-ApikeyDescription"
},
"objContactName": {
"$ref": "#/components/schemas/Custom-ContactName-Response"
},
"sApikeyApikey": {
"description": "The Apikey for the API key.\n\nThis will be hidden if we are not creating or regenerating the Apikey.",
"type": "string"
},
"sApikeySecret": {
"description": "The Secret for the API key.\n\nThis will be hidden if we are not creating or regenerating the Apikey.",
"type": "string"
},
"bApikeyIsactive": {
"$ref": "#/components/schemas/Field-bApikeyIsactive"
},
"bApikeyIssigned": {
"$ref": "#/components/schemas/Field-bApikeyIssigned"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"apikey-ResponseCompound": {
"description": "An Apikey Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/apikey-Response"
}
]
},
"apikey-createObject-v2-Request": {
"description": "Request for POST /2/object/apikey",
"required": [
"a_objApikey"
],
"type": "object",
"properties": {
"a_objApikey": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/apikey-RequestCompound"
}
}
}
},
"apikey-createObject-v2-Response": {
"description": "Response for POST /2/object/apikey",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-createObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-createObject-v2-Response-mPayload": {
"description": "Payload for POST /2/object/apikey",
"required": [
"a_objApikey"
],
"type": "object",
"properties": {
"a_objApikey": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/apikey-ResponseCompound"
}
}
}
},
"apikey-editObject-v1-Request": {
"description": "Request for PUT /1/object/apikey/{pkiApikeyID}",
"required": [
"objApikey"
],
"type": "object",
"properties": {
"objApikey": {
"$ref": "#/components/schemas/apikey-RequestCompound"
}
}
},
"apikey-editObject-v1-Response": {
"description": "Response for PUT /1/object/apikey/{pkiApikeyID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-editPermissions-v1-Request": {
"description": "Request for PUT /1/object/apikey/{pkiApikeyID}/editPermissions",
"required": [
"a_objPermission"
],
"type": "object",
"properties": {
"a_objPermission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission-RequestCompound"
}
}
}
},
"apikey-editPermissions-v1-Response": {
"description": "Response for PUT /1/object/apikey/{pkiApikeyID}/editPermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-editPermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-editPermissions-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/apikey/{pkiApikeyID}/editPermissions",
"required": [
"a_pkiPermissionID"
],
"type": "object",
"properties": {
"a_pkiPermissionID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
}
}
}
},
"apikey-getCors-v1-Response": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/getCors",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-getCors-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-getCors-v1-Response-mPayload": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/getCors",
"required": [
"a_objCors"
],
"type": "object",
"properties": {
"a_objCors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/cors-ResponseCompound"
}
}
}
},
"apikey-getList-v1-Response": {
"description": "Response for GET /1/object/apikey/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"apikey-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/apikey/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objApikey"
],
"type": "object",
"properties": {
"a_objApikey": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apikey-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"apikey-getObject-v2-Response": {
"description": "Response for GET /2/object/apikey/{pkiApikeyID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/apikey/{pkiApikeyID}",
"required": [
"objApikey"
],
"type": "object",
"properties": {
"objApikey": {
"$ref": "#/components/schemas/apikey-ResponseCompound"
}
}
},
"apikey-getPermissions-v1-Response": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-getPermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-getPermissions-v1-Response-mPayload": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/getPermissions",
"required": [
"a_objModulegroup"
],
"type": "object",
"properties": {
"a_objModulegroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulegroup-ResponseCompound"
}
}
}
},
"apikey-getSubnets-v1-Response": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-getSubnets-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-getSubnets-v1-Response-mPayload": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/getSubnets",
"required": [
"a_objSubnet"
],
"type": "object",
"properties": {
"a_objSubnet": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subnet-ResponseCompound"
}
}
}
},
"apikey-regenerate-v1-Request": {
"description": "Request for POST /1/object/apikey/{pkiApikeyID}/regenerate",
"type": "object",
"properties": {
"bApikeyIssigned": {
"$ref": "#/components/schemas/Field-bApikeyIssigned"
}
}
},
"apikey-regenerate-v1-Response": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/regenerate",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/apikey-regenerate-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"apikey-regenerate-v1-Response-mPayload": {
"description": "Response for GET /1/object/apikey/{pkiApikeyID}/regenerate",
"required": [
"objApikey"
],
"type": "object",
"properties": {
"objApikey": {
"$ref": "#/components/schemas/apikey-ResponseCompound"
}
}
},
"attempt-Response": {
"description": "An Attempt object",
"required": [
"sAttemptResult",
"dtAttemptStart",
"iAttemptDuration"
],
"type": "object",
"properties": {
"dtAttemptStart": {
"$ref": "#/components/schemas/Common-Format-DateTime"
},
"sAttemptResult": {
"description": "The Success or Failure message of the attempt when we tried to call the URL to deliver the webhook event.",
"type": "string"
},
"iAttemptDuration": {
"description": "The number of second it took to process the webhook or get an error",
"type": "integer"
}
},
"example": {
"dtAttemptStart": "2020-12-31 23:59:59",
"sAttemptResult": "Success",
"iAttemptDuration": 1
}
},
"attempt-ResponseCompound": {
"description": "An Attempt object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/attempt-Response"
}
]
},
"billingentityexternal-AutocompleteElement-Response": {
"description": "A Billingentityexternal AutocompleteElement Response",
"required": [
"pkiBillingentityexternalID",
"sBillingentityexternalDescription",
"bBillingentityexternalIsactive"
],
"type": "object",
"properties": {
"pkiBillingentityexternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityexternalID"
},
"sBillingentityexternalDescription": {
"$ref": "#/components/schemas/Field-sBillingentityexternalDescription"
},
"bBillingentityexternalIsactive": {
"$ref": "#/components/schemas/Field-bBillingentityexternalIsactive"
}
}
},
"billingentityexternal-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/billingentityexternal/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/billingentityexternal-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"billingentityexternal-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/billingentityexternal/getAutocomplete",
"required": [
"a_objbillingentityexternal"
],
"type": "object",
"properties": {
"a_objBillingentityexternal": {
"description": "An array of Billingentityexternal autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/billingentityexternal-AutocompleteElement-Response"
}
}
}
},
"billingentityinternal-AutocompleteElement-Response": {
"description": "A Billingentityinternal AutocompleteElement Response",
"required": [
"pkiBillingentityinternalID",
"sBillingentityinternalDescriptionX",
"bBillingentityinternalIsactive"
],
"type": "object",
"properties": {
"pkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"bBillingentityinternalIsactive": {
"$ref": "#/components/schemas/Field-bBillingentityinternalIsactive"
}
}
},
"billingentityinternal-ListElement": {
"description": "A Billingentityinternal List Element",
"required": [
"pkiBillingentityinternalID",
"sBillingentityinternalDescriptionX"
],
"type": "object",
"properties": {
"pkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
}
}
},
"billingentityinternal-Request": {
"description": "A Billingentityinternal Object",
"required": [
"objBillingentityinternalDescription"
],
"type": "object",
"properties": {
"pkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"objBillingentityinternalDescription": {
"$ref": "#/components/schemas/Multilingual-BillingentityinternalDescription"
}
}
},
"billingentityinternal-RequestCompound": {
"description": "A Billingentityinternal Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/billingentityinternal-Request"
},
{
"required": [
"a_objBillingentityinternalproduct"
],
"type": "object",
"properties": {
"a_objBillingentityinternalproduct": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billingentityinternalproduct-RequestCompound"
}
}
}
}
]
},
"billingentityinternal-Response": {
"description": "A Billingentityinternal Object",
"required": [
"pkiBillingentityinternalID",
"objBillingentityinternalDescription"
],
"type": "object",
"properties": {
"pkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"objBillingentityinternalDescription": {
"$ref": "#/components/schemas/Multilingual-BillingentityinternalDescription"
}
}
},
"billingentityinternal-ResponseCompound": {
"description": "A Billingentityinternal Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/billingentityinternal-Response"
},
{
"required": [
"a_objBillingentityinternalproduct"
],
"type": "object",
"properties": {
"a_objBillingentityinternalproduct": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billingentityinternalproduct-ResponseCompound"
}
}
}
}
]
},
"billingentityinternal-createObject-v1-Request": {
"description": "Request for POST /1/object/billingentityinternal",
"required": [
"a_objBillingentityinternal"
],
"type": "object",
"properties": {
"a_objBillingentityinternal": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/billingentityinternal-RequestCompound"
}
}
}
},
"billingentityinternal-createObject-v1-Response": {
"description": "Response for POST /1/object/billingentityinternal",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/billingentityinternal-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"billingentityinternal-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/billingentityinternal",
"required": [
"a_pkiBillingentityinternalID"
],
"type": "object",
"properties": {
"a_pkiBillingentityinternalID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
}
}
}
},
"billingentityinternal-editObject-v1-Request": {
"description": "Request for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID}",
"required": [
"objBillingentityinternal"
],
"type": "object",
"properties": {
"objBillingentityinternal": {
"$ref": "#/components/schemas/billingentityinternal-RequestCompound"
}
}
},
"billingentityinternal-editObject-v1-Response": {
"description": "Response for PUT /1/object/billingentityinternal/{pkiBillingentityinternalID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"billingentityinternal-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/billingentityinternal/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/billingentityinternal-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"billingentityinternal-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/billingentityinternal/getAutocomplete",
"required": [
"a_objBillingentityinternal"
],
"type": "object",
"properties": {
"a_objBillingentityinternal": {
"description": "An array of Billingentityinternal object containing the description, ID and active status about the element.",
"type": "array",
"items": {
"$ref": "#/components/schemas/billingentityinternal-AutocompleteElement-Response"
}
}
}
},
"billingentityinternal-getList-v1-Response": {
"description": "Response for GET /1/object/billingentityinternal/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/billingentityinternal-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"billingentityinternal-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/billingentityinternal/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objBillingentityinternal"
],
"type": "object",
"properties": {
"a_objBillingentityinternal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billingentityinternal-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"billingentityinternal-getObject-v2-Response": {
"description": "Response for GET /2/object/billingentityinternal/{pkiBillingentityinternalID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/billingentityinternal-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"billingentityinternal-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/billingentityinternal/{pkiBillingentityinternalID}",
"required": [
"objBillingentityinternal"
],
"type": "object",
"properties": {
"objBillingentityinternal": {
"$ref": "#/components/schemas/billingentityinternal-ResponseCompound"
}
}
},
"billingentityinternalproduct-Request": {
"description": "A Billingentityinternalproduct Object",
"required": [
"fkiEzmaxproductID",
"fkiBillingentityexternalID"
],
"type": "object",
"properties": {
"pkiBillingentityinternalproductID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalproductID"
},
"fkiEzmaxproductID": {
"$ref": "#/components/schemas/Field-pkiEzmaxproductID"
},
"fkiBillingentityexternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityexternalID"
}
}
},
"billingentityinternalproduct-RequestCompound": {
"description": "A Billingentityinternalproduct Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/billingentityinternalproduct-Request"
},
{
"type": "object"
}
]
},
"billingentityinternalproduct-Response": {
"description": "A Billingentityinternalproduct Object",
"required": [
"pkiBillingentityinternalproductID",
"fkiBillingentityinternalID",
"sBillingentityinternalDescriptionX",
"fkiEzmaxproductID",
"sEzmaxproductDescriptionX",
"fkiBillingentityexternalID",
"sBillingentityexternalDescription"
],
"type": "object",
"properties": {
"pkiBillingentityinternalproductID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalproductID"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"fkiEzmaxproductID": {
"$ref": "#/components/schemas/Field-pkiEzmaxproductID"
},
"sEzmaxproductDescriptionX": {
"$ref": "#/components/schemas/Field-sEzmaxproductDescriptionX"
},
"fkiBillingentityexternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityexternalID"
},
"sBillingentityexternalDescription": {
"$ref": "#/components/schemas/Field-sBillingentityexternalDescription"
}
}
},
"billingentityinternalproduct-ResponseCompound": {
"description": "A Billingentityinternalproduct Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/billingentityinternalproduct-Response"
},
{
"type": "object"
}
]
},
"branding-AutocompleteElement-Response": {
"description": "Branding AutocompleteElement Response",
"required": [
"sBrandingDescriptionX",
"pkiBrandingID",
"bBrandingIsactive"
],
"type": "object",
"properties": {
"sBrandingDescriptionX": {
"$ref": "#/components/schemas/Field-sBrandingDescriptionX"
},
"pkiBrandingID": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"bBrandingIsactive": {
"$ref": "#/components/schemas/Field-bBrandingIsactive"
}
}
},
"branding-ListElement": {
"description": "A Branding List Element",
"required": [
"pkiBrandingID",
"sBrandingDescriptionX",
"iBrandingColortext",
"iBrandingColortextlinkbox",
"iBrandingColortextbutton",
"iBrandingColorbackground",
"iBrandingColorbackgroundbutton",
"iBrandingColorbackgroundsmallbox",
"bBrandingIsactive"
],
"type": "object",
"properties": {
"pkiBrandingID": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"sBrandingDescriptionX": {
"$ref": "#/components/schemas/Field-sBrandingDescriptionX"
},
"iBrandingColortext": {
"$ref": "#/components/schemas/Field-iBrandingColortext"
},
"iBrandingColortextlinkbox": {
"$ref": "#/components/schemas/Field-iBrandingColortextlinkbox"
},
"iBrandingColortextbutton": {
"$ref": "#/components/schemas/Field-iBrandingColortextbutton"
},
"iBrandingColorbackground": {
"$ref": "#/components/schemas/Field-iBrandingColorbackground"
},
"iBrandingColorbackgroundbutton": {
"$ref": "#/components/schemas/Field-iBrandingColorbackgroundbutton"
},
"iBrandingColorbackgroundsmallbox": {
"$ref": "#/components/schemas/Field-iBrandingColorbackgroundsmallbox"
},
"bBrandingIsactive": {
"$ref": "#/components/schemas/Field-bBrandingIsactive"
}
}
},
"branding-Request": {
"description": "A Branding Object",
"required": [
"objBrandingDescription",
"eBrandingLogo",
"iBrandingColortext",
"iBrandingColortextlinkbox",
"iBrandingColortextbutton",
"iBrandingColorbackground",
"iBrandingColorbackgroundbutton",
"iBrandingColorbackgroundsmallbox",
"bBrandingIsactive"
],
"type": "object",
"properties": {
"pkiBrandingID": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"objBrandingDescription": {
"$ref": "#/components/schemas/Multilingual-BrandingDescription"
},
"eBrandingLogo": {
"$ref": "#/components/schemas/Field-eBrandingLogo"
},
"sBrandingBase64": {
"format": "byte",
"description": "The Base64 encoded binary content of the branding logo. This need to match image type selected in eBrandingLogo if you supply an image. If you select 'Default', the logo will be deleted and the default one will be used.",
"type": "string",
"example": {
"$ref": "#/components/examples/PngAsBase64/value"
}
},
"iBrandingColortext": {
"$ref": "#/components/schemas/Field-iBrandingColortext"
},
"iBrandingColortextlinkbox": {
"$ref": "#/components/schemas/Field-iBrandingColortextlinkbox"
},
"iBrandingColortextbutton": {
"$ref": "#/components/schemas/Field-iBrandingColortextbutton"
},
"iBrandingColorbackground": {
"$ref": "#/components/schemas/Field-iBrandingColorbackground"
},
"iBrandingColorbackgroundbutton": {
"$ref": "#/components/schemas/Field-iBrandingColorbackgroundbutton"
},
"iBrandingColorbackgroundsmallbox": {
"$ref": "#/components/schemas/Field-iBrandingColorbackgroundsmallbox"
},
"sBrandingName": {
"$ref": "#/components/schemas/Field-sBrandingName"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"bBrandingIsactive": {
"$ref": "#/components/schemas/Field-bBrandingIsactive"
}
}
},
"branding-RequestCompound": {
"description": "A Branding Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/branding-Request"
},
{
"type": "object"
}
]
},
"branding-Response": {
"description": "A Branding Object",
"required": [
"pkiBrandingID",
"objBrandingDescription",
"sBrandingDescriptionX",
"eBrandingLogo",
"iBrandingColortext",
"iBrandingColortextlinkbox",
"iBrandingColortextbutton",
"iBrandingColorbackground",
"iBrandingColorbackgroundbutton",
"iBrandingColorbackgroundsmallbox",
"bBrandingIsactive"
],
"type": "object",
"properties": {
"pkiBrandingID": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"fkiEmailID": {
"$ref": "#/components/schemas/Field-pkiEmailID"
},
"objBrandingDescription": {
"$ref": "#/components/schemas/Multilingual-BrandingDescription"
},
"sBrandingDescriptionX": {
"$ref": "#/components/schemas/Field-sBrandingDescriptionX"
},
"sBrandingName": {
"$ref": "#/components/schemas/Field-sBrandingName"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"eBrandingLogo": {
"$ref": "#/components/schemas/Field-eBrandingLogo"
},
"iBrandingColortext": {
"$ref": "#/components/schemas/Field-iBrandingColortext"
},
"iBrandingColortextlinkbox": {
"$ref": "#/components/schemas/Field-iBrandingColortextlinkbox"
},
"iBrandingColortextbutton": {
"$ref": "#/components/schemas/Field-iBrandingColortextbutton"
},
"iBrandingColorbackground": {
"$ref": "#/components/schemas/Field-iBrandingColorbackground"
},
"iBrandingColorbackgroundbutton": {
"$ref": "#/components/schemas/Field-iBrandingColorbackgroundbutton"
},
"iBrandingColorbackgroundsmallbox": {
"$ref": "#/components/schemas/Field-iBrandingColorbackgroundsmallbox"
},
"bBrandingIsactive": {
"$ref": "#/components/schemas/Field-bBrandingIsactive"
}
}
},
"branding-ResponseCompound": {
"description": "A Branding Object",
"required": [
"sBrandingDescriptionX"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/branding-Response"
},
{
"type": "object",
"properties": {
"sBrandingLogourl": {
"$ref": "#/components/schemas/Computed-sBrandingLogourl"
}
}
}
]
},
"branding-createObject-v1-Request": {
"description": "Request for POST /1/object/branding",
"required": [
"a_objBranding"
],
"type": "object",
"properties": {
"a_objBranding": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/branding-RequestCompound"
}
}
}
},
"branding-createObject-v1-Response": {
"description": "Response for POST /1/object/branding",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/branding-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"branding-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/branding",
"required": [
"a_pkiBrandingID"
],
"type": "object",
"properties": {
"a_pkiBrandingID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
}
}
}
},
"branding-editObject-v1-Request": {
"description": "Request for PUT /1/object/branding/{pkiBrandingID}",
"required": [
"objBranding"
],
"type": "object",
"properties": {
"objBranding": {
"$ref": "#/components/schemas/branding-RequestCompound"
}
}
},
"branding-editObject-v1-Response": {
"description": "Response for PUT /1/object/branding/{pkiBrandingID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"branding-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/branding/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/branding-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"branding-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/branding/getAutocomplete",
"required": [
"a_objBranding"
],
"type": "object",
"properties": {
"a_objBranding": {
"description": "An array of Branding object containing the description, ID and active status about the element.",
"type": "array",
"items": {
"$ref": "#/components/schemas/branding-AutocompleteElement-Response"
}
}
}
},
"branding-getList-v1-Response": {
"description": "Response for GET /1/object/branding/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/branding-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"branding-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/branding/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objBranding"
],
"type": "object",
"properties": {
"a_objBranding": {
"type": "array",
"items": {
"$ref": "#/components/schemas/branding-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"branding-getObject-v2-Response": {
"description": "Response for GET /2/object/branding/{pkiBrandingID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/branding-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"branding-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/branding/{pkiBrandingID}",
"required": [
"objBranding"
],
"type": "object",
"properties": {
"objBranding": {
"$ref": "#/components/schemas/branding-ResponseCompound"
}
}
},
"clonehistory-ListElement": {
"description": "A Clonehistory List Element",
"required": [
"pkiClonehistoryID",
"fkiUserIDCloning",
"fkiUserIDCloned",
"dtClonehistoryFirsthit",
"sUserLoginnameCloning",
"sUserFirstnameCloning",
"sUserLastnameCloning",
"sUserLoginnameCloned",
"sUserFirstnameCloned",
"sUserLastnameCloned"
],
"type": "object",
"properties": {
"pkiClonehistoryID": {
"$ref": "#/components/schemas/Field-pkiClonehistoryID"
},
"fkiUserIDCloning": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiUserIDCloned": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"dtClonehistoryFirsthit": {
"$ref": "#/components/schemas/Field-dtClonehistoryFirsthit"
},
"dtClonehistoryLasthit": {
"$ref": "#/components/schemas/Field-dtClonehistoryLasthit"
},
"sUserLoginnameCloning": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"sUserFirstnameCloning": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastnameCloning": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserLoginnameCloned": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"sUserFirstnameCloned": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastnameCloned": {
"$ref": "#/components/schemas/Field-sUserLastname"
}
}
},
"clonehistory-getList-v1-Response": {
"description": "Response for GET /1/object/clonehistory/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/clonehistory-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"clonehistory-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/clonehistory/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objClonehistory"
],
"type": "object",
"properties": {
"a_objClonehistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/clonehistory-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"communication-Response": {
"description": "A Communication Object",
"required": [
"pkiCommunicationID",
"eCommunicationImportance",
"eCommunicationType",
"sCommunicationSubject",
"eCommunicationDirection",
"iCommunicationrecipientCount",
"bCommunicationPrivate",
"objAudit"
],
"type": "object",
"properties": {
"pkiCommunicationID": {
"$ref": "#/components/schemas/Field-pkiCommunicationID"
},
"eCommunicationImportance": {
"$ref": "#/components/schemas/Field-eCommunicationImportance"
},
"eCommunicationType": {
"$ref": "#/components/schemas/Field-eCommunicationType"
},
"sCommunicationSubject": {
"$ref": "#/components/schemas/Field-sCommunicationSubject"
},
"sCommunicationBodyurl": {
"$ref": "#/components/schemas/Computed-sCommunicationBodyurl"
},
"eCommunicationDirection": {
"$ref": "#/components/schemas/Computed-eCommunicationDirection"
},
"iCommunicationrecipientCount": {
"$ref": "#/components/schemas/Computed-iCommunicationrecipientCount"
},
"bCommunicationPrivate": {
"$ref": "#/components/schemas/Field-bCommunicationPrivate"
},
"objDescriptionstaticSender": {
"$ref": "#/components/schemas/descriptionstatic-Response"
},
"objEmailstaticSender": {
"$ref": "#/components/schemas/emailstatic-Response"
},
"objPhonestaticSender": {
"$ref": "#/components/schemas/phonestatic-Response"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"communication-ResponseCompound": {
"description": "A Communication Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communication-Response"
},
{
"required": [
"a_objCommunicationattachment",
"a_objCommunicationrecipient",
"a_objCommunicationexternalrecipient"
],
"type": "object",
"properties": {
"a_objCommunicationattachment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/communicationattachment-ResponseCompound"
}
},
"a_objCommunicationrecipient": {
"type": "array",
"items": {
"$ref": "#/components/schemas/communicationrecipient-ResponseCompound"
}
},
"a_objCommunicationexternalrecipient": {
"type": "array",
"items": {
"$ref": "#/components/schemas/communicationexternalrecipient-ResponseCompound"
}
}
}
}
]
},
"communication-getObject-v2-Response": {
"description": "Response for GET /2/object/communication/{pkiCommunicationID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/communication-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"communication-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/communication/{pkiCommunicationID}",
"required": [
"objCommunication"
],
"type": "object",
"properties": {
"objCommunication": {
"$ref": "#/components/schemas/communication-ResponseCompound"
}
}
},
"communicationattachment-Response": {
"description": "A Communicationattachment Object",
"required": [
"pkiCommunicationattachmentID",
"sCommunicationattachmentName"
],
"type": "object",
"properties": {
"pkiCommunicationattachmentID": {
"$ref": "#/components/schemas/Field-pkiCommunicationattachmentID"
},
"fkiAttachmentID": {
"$ref": "#/components/schemas/Field-pkiAttachmentID"
},
"fkiInvoiceID": {
"$ref": "#/components/schemas/Field-pkiInvoiceID"
},
"fkiSalarypreparationID": {
"$ref": "#/components/schemas/Field-pkiSalarypreparationID"
},
"sCommunicationattachmentName": {
"$ref": "#/components/schemas/Field-sCommunicationattachmentName"
},
"sDownloadUrl": {
"description": "The Url to the requested document.\n\nUrl will expire after 3 hours.",
"type": "string"
}
}
},
"communicationattachment-ResponseCompound": {
"description": "A Communicationattachment Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communicationattachment-Response"
},
{
"type": "object"
}
]
},
"communicationexternalrecipient-Response": {
"description": "A Communicationexternalrecipient Object",
"required": [
"pkiCommunicationexternalrecipientID",
"eCommunicationexternalrecipientType",
"objDescriptionstatic"
],
"type": "object",
"properties": {
"pkiCommunicationexternalrecipientID": {
"$ref": "#/components/schemas/Field-pkiCommunicationexternalrecipientID"
},
"eCommunicationexternalrecipientType": {
"$ref": "#/components/schemas/Field-eCommunicationexternalrecipientType"
},
"objDescriptionstatic": {
"$ref": "#/components/schemas/descriptionstatic-ResponseCompound"
},
"objEmailstatic": {
"$ref": "#/components/schemas/emailstatic-ResponseCompound"
},
"objPhonestatic": {
"$ref": "#/components/schemas/phonestatic-ResponseCompound"
}
}
},
"communicationexternalrecipient-ResponseCompound": {
"description": "A Communicationexternalrecipient Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communicationexternalrecipient-Response"
},
{
"type": "object"
}
]
},
"communicationrecipient-Response": {
"description": "A Communicationrecipient Object",
"required": [
"pkiCommunicationrecipientID",
"eCommunicationrecipientType",
"objDescriptionstatic"
],
"type": "object",
"properties": {
"pkiCommunicationrecipientID": {
"$ref": "#/components/schemas/Field-pkiCommunicationrecipientID"
},
"eCommunicationrecipientObjecttype": {
"$ref": "#/components/schemas/Field-eCommunicationrecipientObjecttype"
},
"fkiAgentID": {
"$ref": "#/components/schemas/Field-pkiAgentID"
},
"fkiBrokerID": {
"$ref": "#/components/schemas/Field-pkiBrokerID"
},
"fkiContactID": {
"$ref": "#/components/schemas/Field-pkiContactID"
},
"fkiCustomerID": {
"$ref": "#/components/schemas/Field-pkiCustomerID"
},
"fkiEmployeeID": {
"$ref": "#/components/schemas/Field-pkiEmployeeID"
},
"fkiEzsignsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignerID"
},
"fkiFranchiseofficeID": {
"$ref": "#/components/schemas/Field-pkiFranchiseofficeID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiAgentincorporationID": {
"$ref": "#/components/schemas/Field-pkiAgentincorporationID"
},
"fkiAssistantID": {
"$ref": "#/components/schemas/Field-pkiAssistantID"
},
"fkiExternalbrokerID": {
"$ref": "#/components/schemas/Field-pkiExternalbrokerID"
},
"fkiEzcomagentID": {
"$ref": "#/components/schemas/Field-pkiEzcomagentID"
},
"fkiNotaryID": {
"$ref": "#/components/schemas/Field-pkiNotaryID"
},
"fkiRewardmemberID": {
"$ref": "#/components/schemas/Field-pkiRewardmemberID"
},
"fkiSupplierID": {
"$ref": "#/components/schemas/Field-pkiSupplierID"
},
"eCommunicationrecipientType": {
"$ref": "#/components/schemas/Field-eCommunicationrecipientType"
},
"objDescriptionstatic": {
"$ref": "#/components/schemas/descriptionstatic-ResponseCompound"
},
"objEmailstatic": {
"$ref": "#/components/schemas/emailstatic-ResponseCompound"
},
"objPhonestatic": {
"$ref": "#/components/schemas/phonestatic-ResponseCompound"
}
}
},
"communicationrecipient-ResponseCompound": {
"description": "A Communicationreciient Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/communicationrecipient-Response"
},
{
"type": "object"
}
]
},
"company-AutocompleteElement-Response": {
"description": "A Company AutocompleteElement Response",
"required": [
"pkiCompanyID",
"sCompanyNameX",
"bCompanyIsactive"
],
"type": "object",
"properties": {
"pkiCompanyID": {
"$ref": "#/components/schemas/Field-pkiCompanyID"
},
"sCompanyNameX": {
"$ref": "#/components/schemas/Field-sCompanyNameX"
},
"bCompanyIsactive": {
"$ref": "#/components/schemas/Field-bCompanyIsactive"
}
}
},
"company-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/company/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/company-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"company-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/company/getAutocomplete",
"required": [
"a_objcompany"
],
"type": "object",
"properties": {
"a_objCompany": {
"description": "An array of Company autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/company-AutocompleteElement-Response"
}
}
}
},
"contact-Request": {
"description": "A Contact Object",
"required": [
"fkiContacttitleID",
"fkiLanguageID",
"sContactFirstname",
"sContactLastname",
"sContactCompany"
],
"type": "object",
"properties": {
"fkiContacttitleID": {
"$ref": "#/components/schemas/Field-pkiContacttitleID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sContactFirstname": {
"$ref": "#/components/schemas/Field-sContactFirstname"
},
"sContactLastname": {
"$ref": "#/components/schemas/Field-sContactLastname"
},
"sContactCompany": {
"$ref": "#/components/schemas/Field-sContactCompany"
},
"dtContactBirthdate": {
"$ref": "#/components/schemas/Field-dtContactBirthdate"
}
}
},
"contact-RequestCompound": {
"description": "A Contact Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/contact-Request"
},
{
"required": [
"objContactinformations"
],
"type": "object",
"properties": {
"objContactinformations": {
"$ref": "#/components/schemas/contactinformations-RequestCompound"
}
}
}
]
},
"contactinformations-Request": {
"description": "A Contactinformations Object",
"required": [
"iAddressDefault",
"iPhoneDefault",
"iEmailDefault",
"iWebsiteDefault"
],
"type": "object",
"properties": {
"iAddressDefault": {
"description": "The index in the a_objAddress array (zero based index) representing the Address object that should become the default one.\n\nYou can leave the value to 0 if the array is empty.",
"type": "integer"
},
"iPhoneDefault": {
"description": "The index in the a_objPhone array (zero based index) representing the Phone object that should become the default one.\n\nYou can leave the value to 0 if the array is empty.",
"type": "integer"
},
"iEmailDefault": {
"description": "The index in the a_objEmail array (zero based index) representing the Email object that should become the default one.\n\nYou can leave the value to 0 if the array is empty.",
"type": "integer"
},
"iWebsiteDefault": {
"description": "The index in the a_objWebsite array (zero based index) representing the Website object that should become the default one.\n\nYou can leave the value to 0 if the array is empty.",
"type": "integer"
}
}
},
"contactinformations-RequestCompound": {
"description": "A Contactinformations Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/contactinformations-Request"
},
{
"required": [
"a_objAddress",
"a_objPhone",
"a_objEmail",
"a_objWebsite"
],
"type": "object",
"properties": {
"a_objAddress": {
"type": "array",
"items": {
"$ref": "#/components/schemas/address-RequestCompound"
}
},
"a_objPhone": {
"type": "array",
"items": {
"$ref": "#/components/schemas/phone-RequestCompound"
}
},
"a_objEmail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/email-RequestCompound"
}
},
"a_objWebsite": {
"type": "array",
"items": {
"$ref": "#/components/schemas/website-RequestCompound"
}
}
}
}
]
},
"cors-Request": {
"description": "A Cors Object",
"required": [
"fkiApikeyID",
"sCorsEntryurl"
],
"type": "object",
"properties": {
"pkiCorsID": {
"$ref": "#/components/schemas/Field-pkiCorsID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"sCorsEntryurl": {
"$ref": "#/components/schemas/Field-sCorsEntryurl"
}
}
},
"cors-RequestCompound": {
"description": "A Cors Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cors-Request"
},
{
"type": "object"
}
]
},
"cors-Response": {
"description": "A Cors Object",
"required": [
"pkiCorsID",
"fkiApikeyID",
"sCorsEntryurl"
],
"type": "object",
"properties": {
"pkiCorsID": {
"$ref": "#/components/schemas/Field-pkiCorsID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"sCorsEntryurl": {
"$ref": "#/components/schemas/Field-sCorsEntryurl"
}
}
},
"cors-ResponseCompound": {
"description": "A Cors Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/cors-Response"
},
{
"type": "object"
}
]
},
"cors-createObject-v1-Request": {
"description": "Request for POST /1/object/cors",
"required": [
"a_objCors"
],
"type": "object",
"properties": {
"a_objCors": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/cors-RequestCompound"
}
}
}
},
"cors-createObject-v1-Response": {
"description": "Response for POST /1/object/cors",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/cors-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"cors-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/cors",
"required": [
"a_pkiCorsID"
],
"type": "object",
"properties": {
"a_pkiCorsID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiCorsID"
}
}
}
},
"cors-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/cors/{pkiCorsID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"cors-editObject-v1-Request": {
"description": "Request for PUT /1/object/cors/{pkiCorsID}",
"required": [
"objCors"
],
"type": "object",
"properties": {
"objCors": {
"$ref": "#/components/schemas/cors-RequestCompound"
}
}
},
"cors-editObject-v1-Response": {
"description": "Response for PUT /1/object/cors/{pkiCorsID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"cors-getObject-v2-Response": {
"description": "Response for GET /2/object/cors/{pkiCorsID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/cors-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"cors-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/cors/{pkiCorsID}",
"required": [
"objCors"
],
"type": "object",
"properties": {
"objCors": {
"$ref": "#/components/schemas/cors-ResponseCompound"
}
}
},
"department-AutocompleteElement-Response": {
"description": "A Department AutocompleteElement Response",
"required": [
"sCompanyNameX",
"sDepartmentNameX",
"pkiDepartmentID",
"bDepartmentIsactive"
],
"type": "object",
"properties": {
"sCompanyNameX": {
"$ref": "#/components/schemas/Field-sCompanyNameX"
},
"sDepartmentNameX": {
"$ref": "#/components/schemas/Field-sDepartmentNameX"
},
"pkiDepartmentID": {
"$ref": "#/components/schemas/Field-pkiDepartmentID"
},
"bDepartmentIsactive": {
"$ref": "#/components/schemas/Field-bDepartmentIsactive"
}
}
},
"department-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/department/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/department-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"department-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/department/getAutocomplete",
"required": [
"a_objDepartment"
],
"type": "object",
"properties": {
"a_objDepartment": {
"description": "An array of Department autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/department-AutocompleteElement-Response"
}
}
}
},
"descriptionstatic-Response": {
"description": "A Descriptionstatic Object",
"required": [
"pkiDescriptionstaticID",
"sDescriptionstaticDescription"
],
"type": "object",
"properties": {
"pkiDescriptionstaticID": {
"$ref": "#/components/schemas/Field-pkiDescriptionstaticID"
},
"sDescriptionstaticDescription": {
"$ref": "#/components/schemas/Field-sDescriptionstaticDescription"
}
}
},
"descriptionstatic-ResponseCompound": {
"description": "A Descriptionstatic Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/descriptionstatic-Response"
}
]
},
"email-Request": {
"description": "An Email Object",
"required": [
"fkiEmailtypeID",
"sEmailAddress"
],
"type": "object",
"properties": {
"pkiEmailID": {
"$ref": "#/components/schemas/Field-pkiEmailID"
},
"fkiEmailtypeID": {
"$ref": "#/components/schemas/Field-pkiEmailtypeID"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
}
}
},
"email-RequestCompound": {
"description": "An Email Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/email-Request"
}
]
},
"email-Response": {
"description": "An Email Object",
"required": [
"pkiEmailID",
"fkiEmailtypeID",
"sEmailAddress"
],
"type": "object",
"properties": {
"pkiEmailID": {
"$ref": "#/components/schemas/Field-pkiEmailID"
},
"fkiEmailtypeID": {
"$ref": "#/components/schemas/Field-pkiEmailtypeID"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
}
}
},
"email-ResponseCompound": {
"description": "An Email Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/email-Response"
}
]
},
"emailstatic-Response": {
"description": "An Emailstatic Object",
"required": [
"pkiEmailstaticID",
"sEmailstaticAddress"
],
"type": "object",
"properties": {
"pkiEmailstaticID": {
"$ref": "#/components/schemas/Field-pkiEmailstaticID"
},
"sEmailstaticAddress": {
"$ref": "#/components/schemas/Field-sEmailstaticAddress"
}
}
},
"emailstatic-ResponseCompound": {
"description": "An Emailstatic Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/emailstatic-Response"
}
]
},
"emailtype-AutocompleteElement-Response": {
"description": "A Emailtype AutocompleteElement Response",
"required": [
"pkiEmailtypeID",
"sEmailtypeNameX",
"bEmailtypeIsactive"
],
"type": "object",
"properties": {
"pkiEmailtypeID": {
"$ref": "#/components/schemas/Field-pkiEmailtypeID"
},
"sEmailtypeNameX": {
"$ref": "#/components/schemas/Field-sEmailtypeNameX"
},
"bEmailtypeIsactive": {
"$ref": "#/components/schemas/Field-bEmailtypeIsactive"
}
}
},
"emailtype-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/emailtype/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/emailtype-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"emailtype-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/emailtype/getAutocomplete",
"required": [
"a_objemailtype"
],
"type": "object",
"properties": {
"a_objEmailtype": {
"description": "An array of Emailtype autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/emailtype-AutocompleteElement-Response"
}
}
}
},
"ezmaxinvoicing-AutocompleteElement-Response": {
"description": "A Ezmaxinvoicing AutocompleteElement Response",
"required": [
"yyyymmEzmaxinvoicing",
"pkiEzmaxinvoicingID",
"bEzmaxinvoicingIsactive"
],
"type": "object",
"properties": {
"yyyymmEzmaxinvoicing": {
"$ref": "#/components/schemas/Field-yyyymmEzmaxinvoicing"
},
"pkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"bEzmaxinvoicingIsactive": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingIsactive"
}
}
},
"ezmaxinvoicing-Response": {
"description": "A Ezmaxinvoicing Object",
"required": [
"fkiEzmaxinvoicingcontractID",
"fkiEzmaxpricingID",
"fkiSystemconfigurationtypeID",
"sSystemconfigurationtypeDescriptionX",
"yyyymmEzmaxinvoicing",
"iEzmaxinvoicingDays",
"eEzmaxinvoicingPaymenttype",
"dEzmaxinvoicingRebatepaymenttype",
"iEzmaxinvoicingContractlength",
"dEzmaxinvoicingRebatecontractlength",
"bEzmaxinvoicingRebateEzsignallagents"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"fkiEzmaxinvoicingcontractID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingcontractID"
},
"fkiEzmaxpricingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxpricingID"
},
"fkiSystemconfigurationtypeID": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationtypeID"
},
"sSystemconfigurationtypeDescriptionX": {
"$ref": "#/components/schemas/Field-sSystemconfigurationtypeDescriptionX"
},
"yyyymmEzmaxinvoicing": {
"$ref": "#/components/schemas/Field-yyyymmEzmaxinvoicing"
},
"iEzmaxinvoicingDays": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingDays"
},
"eEzmaxinvoicingPaymenttype": {
"$ref": "#/components/schemas/Field-eEzmaxinvoicingPaymenttype"
},
"dEzmaxinvoicingRebatepaymenttype": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingRebatepaymenttype"
},
"iEzmaxinvoicingContractlength": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingContractlength"
},
"dEzmaxinvoicingRebatecontractlength": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingRebatecontractlength"
},
"bEzmaxinvoicingRebateEzsignallagents": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingRebateEzsignallagents"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"ezmaxinvoicing-ResponseCompound": {
"description": "A Ezmaxinvoicing Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicing-Response"
},
{
"required": [
"objEzmaxinvoicingcontract",
"objEzmaxpricing",
"a_objEzmaxinvoicingsummaryglobal",
"a_objEzmaxinvoicingsummaryexternal",
"a_objEzmaxinvoicingsummaryinternal",
"a_objEzmaxinvoicingagent",
"a_objEzmaxinvoicinguser",
"a_objEzmaxinvoicingezsignfolder",
"a_objEzmaxinvoicingezsigndocument"
],
"type": "object",
"properties": {
"objEzmaxinvoicingcontract": {
"$ref": "#/components/schemas/ezmaxinvoicingcontract-ResponseCompound"
},
"objEzmaxpricing": {
"$ref": "#/components/schemas/Custom-Ezmaxpricing-Response"
},
"a_objEzmaxinvoicingsummaryglobal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingsummaryglobal-ResponseCompound"
}
},
"a_objEzmaxinvoicingsummaryexternal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingsummaryexternal-ResponseCompound"
}
},
"a_objEzmaxinvoicingsummaryinternal": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingsummaryinternal-ResponseCompound"
}
},
"a_objEzmaxinvoicingagent": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingagent-ResponseCompound"
}
},
"a_objEzmaxinvoicinguser": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicinguser-ResponseCompound"
}
},
"a_objEzmaxinvoicingezsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzmaxinvoicingEzsignfolder-Response"
}
},
"a_objEzmaxinvoicingezsigndocument": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzmaxinvoicingEzsigndocument-Response"
}
}
}
}
]
},
"ezmaxinvoicing-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/ezmaxinvoicing/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezmaxinvoicing-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezmaxinvoicing-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezmaxinvoicing/getAutocomplete",
"required": [
"a_objEzmaxinvoicing"
],
"type": "object",
"properties": {
"a_objEzmaxinvoicing": {
"description": "An array of Ezmaxinvoicing autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicing-AutocompleteElement-Response"
}
}
}
},
"ezmaxinvoicing-getObject-v2-Response": {
"description": "Response for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezmaxinvoicing-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezmaxinvoicing-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}",
"required": [
"objEzmaxinvoicing"
],
"type": "object",
"properties": {
"objEzmaxinvoicing": {
"$ref": "#/components/schemas/ezmaxinvoicing-ResponseCompound"
}
}
},
"ezmaxinvoicing-getProvisional-v1-Response": {
"description": "Response for GET /1/object/ezmaxinvoicing/getProvisional",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezmaxinvoicing-getProvisional-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezmaxinvoicing-getProvisional-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezmaxinvoicing/getProvisional",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicing-ResponseCompound"
}
]
},
"ezmaxinvoicingagent-Response": {
"description": "A Ezmaxinvoicingagent Object",
"required": [
"fkiBillingentityinternalID",
"sBillingentityinternalDescriptionX",
"iEzmaxinvoicingagentSession",
"iEzmaxinvoicingagentCloned",
"iEzmaxinvoicingagentInvoice",
"iEzmaxinvoicingagentInscription",
"iEzmaxinvoicingagentInscriptionactive",
"iEzmaxinvoicingagentSale",
"iEzmaxinvoicingagentOtherincome",
"iEzmaxinvoicingagentCommissioncalculation",
"iEzmaxinvoicingagentEzsigndocument",
"bEzmaxinvoicingagentEzsignaccount",
"bEzmaxinvoicingagentBillableezmax",
"eEzmaxinvoicingagentVariationezmax",
"bEzmaxinvoicingagentBillableezsign",
"eEzmaxinvoicingagentVariationezsign"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingagentID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingagentID"
},
"fkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"fkiAgentID": {
"$ref": "#/components/schemas/Field-pkiAgentID"
},
"fkiBrokerID": {
"$ref": "#/components/schemas/Field-pkiBrokerID"
},
"iEzmaxinvoicingagentSession": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentSession"
},
"iEzmaxinvoicingagentCloned": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentCloned"
},
"iEzmaxinvoicingagentInvoice": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentInvoice"
},
"iEzmaxinvoicingagentInscription": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentInscription"
},
"iEzmaxinvoicingagentInscriptionactive": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentInscriptionactive"
},
"iEzmaxinvoicingagentSale": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentSale"
},
"iEzmaxinvoicingagentOtherincome": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentOtherincome"
},
"iEzmaxinvoicingagentCommissioncalculation": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentCommissioncalculation"
},
"iEzmaxinvoicingagentEzsigndocument": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingagentEzsigndocument"
},
"bEzmaxinvoicingagentEzsignaccount": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingagentEzsignaccount"
},
"bEzmaxinvoicingagentBillableezmax": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingagentBillableezmax"
},
"eEzmaxinvoicingagentVariationezmax": {
"$ref": "#/components/schemas/Field-eEzmaxinvoicingagentVariationezmax"
},
"bEzmaxinvoicingagentBillableezsign": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingagentBillableezsign"
},
"eEzmaxinvoicingagentVariationezsign": {
"$ref": "#/components/schemas/Field-eEzmaxinvoicingagentVariationezsign"
}
}
},
"ezmaxinvoicingagent-ResponseCompound": {
"description": "A Ezmaxinvoicingagent Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingagent-Response"
},
{
"required": [
"objContactName"
],
"type": "object",
"properties": {
"objContactName": {
"$ref": "#/components/schemas/Custom-ContactName-Response"
}
}
}
]
},
"ezmaxinvoicingcommission-Response": {
"description": "A Ezmaxinvoicingcommission Object",
"required": [
"dtEzmaxinvoicingcommissionStart",
"dtEzmaxinvoicingcommissionEnd",
"iEzmaxinvoicingcommissionDays",
"dEzmaxinvoicingcommissionAmount"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingcommissionID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingcommissionID"
},
"fkiEzmaxinvoicingsummaryglobalID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryglobalID"
},
"fkiEzmaxpartnerID": {
"$ref": "#/components/schemas/Field-pkiEzmaxpartnerID"
},
"fkiEzmaxrepresentativeID": {
"$ref": "#/components/schemas/Field-pkiEzmaxrepresentativeID"
},
"dtEzmaxinvoicingcommissionStart": {
"$ref": "#/components/schemas/Field-dtEzmaxinvoicingcommissionStart"
},
"dtEzmaxinvoicingcommissionEnd": {
"$ref": "#/components/schemas/Field-dtEzmaxinvoicingcommissionEnd"
},
"iEzmaxinvoicingcommissionDays": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingcommissionDays"
},
"dEzmaxinvoicingcommissionAmount": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingcommissionAmount"
}
}
},
"ezmaxinvoicingcommission-ResponseCompound": {
"description": "A Ezmaxinvoicingcommission Object",
"required": [
"objContactName"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingcommission-Response"
},
{
"type": "object",
"properties": {
"objContactName": {
"$ref": "#/components/schemas/Custom-ContactName-Response"
}
}
}
]
},
"ezmaxinvoicingcontract-Response": {
"description": "A Ezmaxinvoicingcontract Object",
"required": [
"pkiEzmaxinvoicingcontractID",
"eEzmaxinvoicingcontractPaymenttype",
"iEzmaxinvoicingcontractLength",
"dtEzmaxinvoicingcontractStart",
"dtEzmaxinvoicingcontractEnd",
"dEzmaxinvoicingcontractLicense",
"dEzmaxinvoicingcontract121qa",
"bEzmaxinvoicingcontractEzsignallagents",
"objAudit"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingcontractID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingcontractID"
},
"eEzmaxinvoicingcontractPaymenttype": {
"$ref": "#/components/schemas/Field-eEzmaxinvoicingcontractPaymenttype"
},
"iEzmaxinvoicingcontractLength": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingcontractLength"
},
"dtEzmaxinvoicingcontractStart": {
"$ref": "#/components/schemas/Field-dtEzmaxinvoicingcontractStart"
},
"dtEzmaxinvoicingcontractEnd": {
"$ref": "#/components/schemas/Field-dtEzmaxinvoicingcontractEnd"
},
"dEzmaxinvoicingcontractLicense": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingcontractLicense"
},
"dEzmaxinvoicingcontract121qa": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingcontract121qa"
},
"bEzmaxinvoicingcontractEzsignallagents": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingcontractEzsignallagents"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"ezmaxinvoicingcontract-ResponseCompound": {
"description": "A Ezmaxinvoicingcontract Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingcontract-Response"
},
{
"type": "object"
}
]
},
"ezmaxinvoicingsummaryexternal-Response": {
"description": "A Ezmaxinvoicingsummaryexternal Object",
"required": [
"fkiBillingentityexternalID",
"sBillingentityexternalDescription",
"sEzmaxinvoicingsummaryexternalDescription"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingsummaryexternalID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryexternalID"
},
"fkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"fkiBillingentityexternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityexternalID"
},
"sBillingentityexternalDescription": {
"$ref": "#/components/schemas/Field-sBillingentityexternalDescription"
},
"sEzmaxinvoicingsummaryexternalDescription": {
"$ref": "#/components/schemas/Field-sEzmaxinvoicingsummaryexternalDescription"
}
}
},
"ezmaxinvoicingsummaryexternal-ResponseCompound": {
"description": "A Ezmaxinvoicingsummaryexternal Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingsummaryexternal-Response"
},
{
"required": [
"a_objEzmaxinvoicingsummaryexternaldetail"
],
"type": "object",
"properties": {
"a_objEzmaxinvoicingsummaryexternaldetail": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingsummaryexternaldetail-ResponseCompound"
}
}
}
}
]
},
"ezmaxinvoicingsummaryexternaldetail-Response": {
"description": "A Ezmaxinvoicingsummaryexternaldetail Object",
"required": [
"fkiEzmaxproductID",
"sEzmaxproductDescriptionX",
"dEzmaxinvoicingsummaryexternaldetailCountreal",
"dEzmaxinvoicingsummaryexternaldetailSubtotal",
"dEzmaxinvoicingsummaryexternaldetailRebate",
"dEzmaxinvoicingsummaryexternaldetailTotal",
"bEzmaxinvoicingsummaryexternaldetailAdjustment",
"tEzmaxproductHelpX"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingsummaryexternaldetailID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryexternaldetailID"
},
"fkiEzmaxinvoicingsummaryexternalID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryexternalID"
},
"fkiEzmaxproductID": {
"$ref": "#/components/schemas/Field-pkiEzmaxproductID"
},
"sEzmaxproductDescriptionX": {
"$ref": "#/components/schemas/Field-sEzmaxproductDescriptionX"
},
"dEzmaxinvoicingsummaryexternaldetailCountreal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryexternaldetailCountreal"
},
"dEzmaxinvoicingsummaryexternaldetailSubtotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryexternaldetailSubtotal"
},
"dEzmaxinvoicingsummaryexternaldetailRebate": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryexternaldetailRebate"
},
"dEzmaxinvoicingsummaryexternaldetailTotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryexternaldetailTotal"
},
"bEzmaxinvoicingsummaryexternaldetailAdjustment": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingsummaryexternaldetailAdjustment"
},
"tEzmaxproductHelpX": {
"$ref": "#/components/schemas/Field-tEzmaxproductHelpX"
}
}
},
"ezmaxinvoicingsummaryexternaldetail-ResponseCompound": {
"description": "A Ezmaxinvoicingsummaryexternaldetail Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingsummaryexternaldetail-Response"
},
{
"type": "object"
}
]
},
"ezmaxinvoicingsummaryglobal-Response": {
"description": "A Ezmaxinvoicingsummaryglobal Object",
"required": [
"fkiEzmaxproductID",
"sEzmaxproductDescriptionX",
"dtEzmaxinvoicingsummaryglobalStart",
"dtEzmaxinvoicingsummaryglobalEnd",
"iEzmaxinvoicingsummaryglobalDays",
"dEzmaxinvoicingsummaryglobalCountreal",
"dEzmaxinvoicingsummaryglobalCountbilled",
"dEzmaxinvoicingsummaryglobalSubtotal",
"dEzmaxinvoicingsummaryglobalRebateamount",
"dEzmaxinvoicingsummaryglobalRebatepercent",
"dEzmaxinvoicingsummaryglobalRebatetotal",
"dEzmaxinvoicingsummaryglobalTotal",
"bEzmaxinvoicingsummaryglobalAdjustment",
"tEzmaxproductHelpX"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingsummaryglobalID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryglobalID"
},
"fkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"fkiEzmaxproductID": {
"$ref": "#/components/schemas/Field-pkiEzmaxproductID"
},
"sEzmaxproductDescriptionX": {
"$ref": "#/components/schemas/Field-sEzmaxproductDescriptionX"
},
"dtEzmaxinvoicingsummaryglobalStart": {
"$ref": "#/components/schemas/Field-dtEzmaxinvoicingsummaryglobalStart"
},
"dtEzmaxinvoicingsummaryglobalEnd": {
"$ref": "#/components/schemas/Field-dtEzmaxinvoicingsummaryglobalEnd"
},
"iEzmaxinvoicingsummaryglobalDays": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicingsummaryglobalDays"
},
"dEzmaxinvoicingsummaryglobalCountreal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalCountreal"
},
"dEzmaxinvoicingsummaryglobalCountbilled": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalCountbilled"
},
"dEzmaxinvoicingsummaryglobalSubtotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalSubtotal"
},
"dEzmaxinvoicingsummaryglobalRebateamount": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalRebateamount"
},
"dEzmaxinvoicingsummaryglobalRebatepercent": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalRebatepercent"
},
"dEzmaxinvoicingsummaryglobalRebatetotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalRebatetotal"
},
"dEzmaxinvoicingsummaryglobalTotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalTotal"
},
"dEzmaxinvoicingsummaryglobalRepresentative": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalRepresentative"
},
"dEzmaxinvoicingsummaryglobalPartner": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalPartner"
},
"dEzmaxinvoicingsummaryglobalNet": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryglobalNet"
},
"bEzmaxinvoicingsummaryglobalAdjustment": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingsummaryglobalAdjustment"
},
"tEzmaxproductHelpX": {
"$ref": "#/components/schemas/Field-tEzmaxproductHelpX"
}
}
},
"ezmaxinvoicingsummaryglobal-ResponseCompound": {
"description": "A Ezmaxinvoicingsummaryglobal Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingsummaryglobal-Response"
},
{
"type": "object",
"properties": {
"a_objEzmaxinvoicingcommission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingcommission-ResponseCompound"
}
}
}
}
]
},
"ezmaxinvoicingsummaryinternal-Response": {
"description": "A Ezmaxinvoicingsummaryinternal Object",
"required": [
"objEzmaxinvoicingsummaryinternalDescription",
"sEzmaxinvoicingsummaryinternalDescriptionX",
"fkiBillingentityinternalID",
"sBillingentityinternalDescriptionX"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingsummaryinternalID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryinternalID"
},
"objEzmaxinvoicingsummaryinternalDescription": {
"$ref": "#/components/schemas/Multilingual-EzmaxinvoicingsummaryinternalDescription"
},
"sEzmaxinvoicingsummaryinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sEzmaxinvoicingsummaryinternalDescriptionX"
},
"fkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
}
}
},
"ezmaxinvoicingsummaryinternal-ResponseCompound": {
"description": "A Ezmaxinvoicingsummaryinternal Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingsummaryinternal-Response"
},
{
"required": [
"a_objEzmaxinvoicingsummaryinternaldetail"
],
"type": "object",
"properties": {
"a_objEzmaxinvoicingsummaryinternaldetail": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxinvoicingsummaryinternaldetail-ResponseCompound"
}
}
}
}
]
},
"ezmaxinvoicingsummaryinternaldetail-Response": {
"description": "A Ezmaxinvoicingsummaryinternaldetail Object",
"required": [
"fkiEzmaxproductID",
"sEzmaxproductDescriptionX",
"fkiBillingentityexternalID",
"sBillingentityexternalDescription",
"dEzmaxinvoicingsummaryinternaldetailCountreal",
"dEzmaxinvoicingsummaryinternaldetailSubtotal",
"dEzmaxinvoicingsummaryinternaldetailRebate",
"dEzmaxinvoicingsummaryinternaldetailTotal",
"bEzmaxinvoicingsummaryinternaldetailAdjustment",
"tEzmaxproductHelpX"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicingsummaryinternaldetailID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryinternaldetailID"
},
"fkiEzmaxinvoicingsummaryinternalID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingsummaryinternalID"
},
"fkiEzmaxproductID": {
"$ref": "#/components/schemas/Field-pkiEzmaxproductID"
},
"sEzmaxproductDescriptionX": {
"$ref": "#/components/schemas/Field-sEzmaxproductDescriptionX"
},
"fkiBillingentityexternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityexternalID"
},
"sBillingentityexternalDescription": {
"$ref": "#/components/schemas/Field-sBillingentityexternalDescription"
},
"dEzmaxinvoicingsummaryinternaldetailCountreal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryinternaldetailCountreal"
},
"dEzmaxinvoicingsummaryinternaldetailSubtotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryinternaldetailSubtotal"
},
"dEzmaxinvoicingsummaryinternaldetailRebate": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryinternaldetailRebate"
},
"dEzmaxinvoicingsummaryinternaldetailTotal": {
"$ref": "#/components/schemas/Field-dEzmaxinvoicingsummaryinternaldetailTotal"
},
"bEzmaxinvoicingsummaryinternaldetailAdjustment": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicingsummaryinternaldetailAdjustment"
},
"tEzmaxproductHelpX": {
"$ref": "#/components/schemas/Field-tEzmaxproductHelpX"
}
}
},
"ezmaxinvoicingsummaryinternaldetail-ResponseCompound": {
"description": "A Ezmaxinvoicingsummaryinternaldetail Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicingsummaryinternaldetail-Response"
},
{
"type": "object"
}
]
},
"ezmaxinvoicinguser-Response": {
"description": "A Ezmaxinvoicinguser Object",
"required": [
"fkiBillingentityinternalID",
"sBillingentityinternalDescriptionX",
"fkiUserID",
"iEzmaxinvoicinguserEzsigndocument",
"bEzmaxinvoicinguserEzsignaccount",
"bEzmaxinvoicinguserBillableezsign",
"eEzmaxinvoicinguserVariationezsign"
],
"type": "object",
"properties": {
"pkiEzmaxinvoicinguserID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicinguserID"
},
"fkiEzmaxinvoicingID": {
"$ref": "#/components/schemas/Field-pkiEzmaxinvoicingID"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"iEzmaxinvoicinguserEzsigndocument": {
"$ref": "#/components/schemas/Field-iEzmaxinvoicinguserEzsigndocument"
},
"bEzmaxinvoicinguserEzsignaccount": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicinguserEzsignaccount"
},
"bEzmaxinvoicinguserBillableezsign": {
"$ref": "#/components/schemas/Field-bEzmaxinvoicinguserBillableezsign"
},
"eEzmaxinvoicinguserVariationezsign": {
"$ref": "#/components/schemas/Field-eEzmaxinvoicinguserVariationezsign"
}
}
},
"ezmaxinvoicinguser-ResponseCompound": {
"description": "A Ezmaxinvoicinguser Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezmaxinvoicinguser-Response"
},
{
"required": [
"objContactName"
],
"type": "object",
"properties": {
"objContactName": {
"$ref": "#/components/schemas/Custom-ContactName-Response"
}
}
}
]
},
"ezmaxproduct-AutocompleteElement-Response": {
"description": "A Ezmaxproduct AutocompleteElement Response",
"required": [
"pkiEzmaxproductID",
"sEzmaxproductDescriptionX",
"bEzmaxproductIsactive"
],
"type": "object",
"properties": {
"pkiEzmaxproductID": {
"$ref": "#/components/schemas/Field-pkiEzmaxproductID"
},
"sEzmaxproductDescriptionX": {
"$ref": "#/components/schemas/Field-sEzmaxproductDescriptionX"
},
"bEzmaxproductIsactive": {
"$ref": "#/components/schemas/Field-bEzmaxproductIsactive"
}
}
},
"ezmaxproduct-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/ezmaxproduct/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezmaxproduct-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezmaxproduct-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezmaxproduct/getAutocomplete",
"required": [
"a_objezmaxproduct"
],
"type": "object",
"properties": {
"a_objEzmaxproduct": {
"description": "An array of Ezmaxproduct autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezmaxproduct-AutocompleteElement-Response"
}
}
}
},
"ezsign-suggestSigners-v1-Response": {
"description": "Response for GET /1/module/ezsign/suggestSigners",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsign-suggestSigners-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsign-suggestSigners-v1-Response-mPayload": {
"description": "Payload for GET /1/module/ezsign/suggestSigners",
"required": [
"a_objEzsignfoldersignerassociation",
"a_objUserTeam",
"a_objUser"
],
"type": "object",
"properties": {
"a_objEzsignfoldersignerassociation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound"
}
},
"a_objUserTeam": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-User-Response"
}
},
"a_objUser": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-User-Response"
}
}
}
},
"ezsign-suggestTemplates-v1-Response": {
"description": "Response for GET /1/module/ezsign/suggestTemplates",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsign-suggestTemplates-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsign-suggestTemplates-v1-Response-mPayload": {
"description": "Payload for GET /1/module/ezsign/suggestTemplates",
"required": [
"a_objEzsigntemplate",
"a_objEzsigntemplatepackage"
],
"type": "object",
"properties": {
"a_objEzsigntemplate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplate-ResponseCompound"
}
},
"a_objEzsigntemplatepackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackage-ResponseCompound"
}
}
}
},
"ezsignannotation-Response": {
"description": "A Ezsignannotation Object",
"required": [
"pkiEzsignannotationID",
"fkiEzsigndocumentID",
"eEzsignannotationType",
"iEzsignannotationX",
"iEzsignannotationY",
"iEzsignpagePagenumber"
],
"type": "object",
"properties": {
"pkiEzsignannotationID": {
"$ref": "#/components/schemas/Field-pkiEzsignannotationID"
},
"fkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"eEzsignannotationHorizontalalignment": {
"$ref": "#/components/schemas/Enum-Horizontalalignment"
},
"eEzsignannotationVerticalalignment": {
"$ref": "#/components/schemas/Enum-Verticalalignment"
},
"eEzsignannotationType": {
"$ref": "#/components/schemas/Field-eEzsignannotationType"
},
"iEzsignannotationX": {
"$ref": "#/components/schemas/Field-iEzsignannotationX"
},
"iEzsignannotationY": {
"$ref": "#/components/schemas/Field-iEzsignannotationY"
},
"iEzsignannotationWidth": {
"$ref": "#/components/schemas/Field-iEzsignannotationWidth"
},
"iEzsignannotationHeight": {
"$ref": "#/components/schemas/Field-iEzsignannotationHeight"
},
"sEzsignannotationText": {
"$ref": "#/components/schemas/Field-sEzsignannotationText"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
}
}
},
"ezsignannotation-ResponseCompound": {
"description": "A Ezsignannotation Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignannotation-Response"
},
{
"type": "object",
"properties": {
"objTextstylestatic": {
"$ref": "#/components/schemas/textstylestatic-ResponseCompound"
}
}
}
]
},
"ezsignbulksend-ListElement": {
"description": "An Ezsignbulksend List Element",
"required": [
"pkiEzsignbulksendID",
"fkiEzsignfoldertypeID",
"sEzsignbulksendDescription",
"sEzsignfoldertypeNameX",
"bEzsignbulksendNeedvalidation",
"iEzsignbulksendtransmission",
"iEzsignfolder",
"iEzsigndocument",
"iEzsignsignature",
"iEzsignsignatureSigned",
"bEzsignbulksendIsactive"
],
"type": "object",
"properties": {
"pkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"sEzsignbulksendDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendDescription"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
},
"iEzsignbulksendtransmission": {
"description": "The total number of Ezsignbulksendtransmissions in the Ezsignbulksend",
"type": "integer"
},
"iEzsignfolder": {
"description": "The total number of Ezsignfolders in the Ezsignbulksend",
"type": "integer"
},
"iEzsigndocument": {
"description": "The total number of Ezsigndocuments in the Ezsignbulksend",
"type": "integer"
},
"iEzsignsignature": {
"description": "The total number of Ezsignsignature in the Ezsignbulksend",
"type": "integer"
},
"iEzsignsignatureSigned": {
"description": "The total number of already signed Ezsignsignature blocks in the Ezsignbulksend",
"type": "integer"
},
"bEzsignbulksendIsactive": {
"$ref": "#/components/schemas/Field-bEzsignbulksendIsactive"
}
}
},
"ezsignbulksend-Request": {
"description": "A Ezsignbulksend Object",
"required": [
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sEzsignbulksendDescription",
"tEzsignbulksendNote",
"bEzsignbulksendNeedvalidation",
"bEzsignbulksendIsactive"
],
"type": "object",
"properties": {
"pkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEzsignbulksendDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendDescription"
},
"tEzsignbulksendNote": {
"$ref": "#/components/schemas/Field-tEzsignbulksendNote"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
},
"bEzsignbulksendIsactive": {
"$ref": "#/components/schemas/Field-bEzsignbulksendIsactive"
}
}
},
"ezsignbulksend-RequestCompound": {
"description": "A Ezsignbulksend Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksend-Request"
},
{
"type": "object"
}
]
},
"ezsignbulksend-Response": {
"description": "An Ezsignbulksend Object",
"required": [
"pkiEzsignbulksendID",
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sEzsignfoldertypeNameX",
"sLanguageNameX",
"eEzsignfoldertypePrivacylevel",
"sEzsignbulksendDescription",
"tEzsignbulksendNote",
"bEzsignbulksendNeedvalidation",
"bEzsignbulksendIsactive",
"objAudit"
],
"type": "object",
"properties": {
"pkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sLanguageNameX": {
"$ref": "#/components/schemas/Field-sLanguageNameX"
},
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"sEzsignbulksendDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendDescription"
},
"tEzsignbulksendNote": {
"$ref": "#/components/schemas/Field-tEzsignbulksendNote"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
},
"bEzsignbulksendIsactive": {
"$ref": "#/components/schemas/Field-bEzsignbulksendIsactive"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"ezsignbulksend-ResponseCompound": {
"description": "An Ezsignbulksend Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksend-Response"
},
{
"required": [
"a_objEzsignbulksenddocumentmapping",
"a_objEzsignbulksendsignermapping"
],
"type": "object",
"properties": {
"a_objEzsignbulksenddocumentmapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-ResponseCompound"
}
},
"a_objEzsignbulksendsignermapping": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-Response"
}
}
}
}
]
},
"ezsignbulksend-createEzsignbulksendtransmission-v1-Request": {
"description": "Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission",
"required": [
"fkiUserlogintypeID",
"sEzsignbulksendtransmissionDescription",
"dtEzsigndocumentDuedate",
"eEzsignfolderSendreminderfrequency",
"tExtraMessage",
"sCsvBase64"
],
"type": "object",
"properties": {
"fkiUserlogintypeID": {
"$ref": "#/components/schemas/Field-pkiUserlogintypeID"
},
"fkiEzsigntsarequirementID": {
"$ref": "#/components/schemas/Field-pkiEzsigntsarequirementID"
},
"sEzsignbulksendtransmissionDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendtransmissionDescription"
},
"dtEzsigndocumentDuedate": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentDuedate"
},
"eEzsignfolderSendreminderfrequency": {
"$ref": "#/components/schemas/Field-eEzsignfolderSendreminderfrequency"
},
"tExtraMessage": {
"$ref": "#/components/schemas/Field-tExtraMessage"
},
"sCsvBase64": {
"format": "byte",
"description": "The Base64 encoded binary content of the CSV file.",
"type": "string"
}
}
},
"ezsignbulksend-createEzsignbulksendtransmission-v1-Response": {
"description": "Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-createEzsignbulksendtransmission-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-createEzsignbulksendtransmission-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission",
"required": [
"objEzsignbulksendtransmission"
],
"type": "object",
"properties": {
"objEzsignbulksendtransmission": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-Response"
}
}
},
"ezsignbulksend-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignbulksend",
"required": [
"a_objEzsignbulksend"
],
"type": "object",
"properties": {
"a_objEzsignbulksend": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksend-RequestCompound"
}
}
}
},
"ezsignbulksend-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignbulksend",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignbulksend",
"required": [
"a_pkiEzsignbulksendID"
],
"type": "object",
"properties": {
"a_pkiEzsignbulksendID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
}
}
}
},
"ezsignbulksend-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID}",
"required": [
"objEzsignbulksend"
],
"type": "object",
"properties": {
"objEzsignbulksend": {
"$ref": "#/components/schemas/ezsignbulksend-RequestCompound"
}
}
},
"ezsignbulksend-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-getEzsignbulksendtransmissions-v1-Response": {
"description": "Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-getEzsignbulksendtransmissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-getEzsignbulksendtransmissions-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksend}/getEzsignbulksendtransmissions",
"required": [
"a_objEzsignbulksendtransmission"
],
"type": "object",
"properties": {
"a_objEzsignbulksendtransmission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-ResponseCompound"
}
}
}
},
"ezsignbulksend-getEzsignsignaturesAutomatic-v1-Response": {
"description": "Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-getEzsignsignaturesAutomatic-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-getEzsignsignaturesAutomatic-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic",
"required": [
"a_eEzsignsignatureType",
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_eEzsignsignatureType": {
"description": "All eEzsignsignatureType contained in the response",
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
}
},
"a_objEzsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfolderEzsignsignaturesAutomatic-Response"
}
}
}
},
"ezsignbulksend-getFormsData-v1-Response": {
"description": "Response for GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-getFormsData-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-getFormsData-v1-Response-mPayload": {
"description": "Payload for GET/1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData",
"required": [
"a_objFormsDataFolder"
],
"type": "object",
"properties": {
"a_objFormsDataFolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-FormsDataFolder-Response"
}
}
}
},
"ezsignbulksend-getList-v1-Response": {
"description": "Response for GET /1/object/ezsignbulksend/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"ezsignbulksend-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignbulksend/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objEzsignbulksend"
],
"type": "object",
"properties": {
"a_objEzsignbulksend": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksend-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"ezsignbulksend-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksend-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksend-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignbulksend/{pkiEzsignbulksendID}",
"required": [
"objEzsignbulksend"
],
"type": "object",
"properties": {
"objEzsignbulksend": {
"$ref": "#/components/schemas/ezsignbulksend-ResponseCompound"
}
}
},
"ezsignbulksend-reorder-v1-Request": {
"description": "Request for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder",
"required": [
"a_pkiEzsignbulksenddocumentmappingID"
],
"type": "object",
"properties": {
"a_pkiEzsignbulksenddocumentmappingID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksenddocumentmappingID"
}
}
}
},
"ezsignbulksend-reorder-v1-Response": {
"description": "Response for POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksenddocumentmapping-Request": {
"description": "A Ezsignbulksenddocumentmapping Object",
"required": [
"fkiEzsignbulksendID"
],
"type": "object",
"properties": {
"pkiEzsignbulksenddocumentmappingID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksenddocumentmappingID"
},
"fkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
}
}
},
"ezsignbulksenddocumentmapping-RequestCompound": {
"description": "A Ezsignbulksenddocumentmapping Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-Request"
},
{
"type": "object"
}
]
},
"ezsignbulksenddocumentmapping-Response": {
"description": "A Ezsignbulksenddocumentmapping Object",
"required": [
"pkiEzsignbulksenddocumentmappingID",
"fkiEzsignbulksendID",
"iEzsignbulksenddocumentmappingOrder"
],
"type": "object",
"properties": {
"pkiEzsignbulksenddocumentmappingID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksenddocumentmappingID"
},
"fkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"iEzsignbulksenddocumentmappingOrder": {
"$ref": "#/components/schemas/Field-iEzsignbulksenddocumentmappingOrder"
}
}
},
"ezsignbulksenddocumentmapping-ResponseCompound": {
"description": "A Ezsignbulksenddocumentmapping Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-Response"
},
{
"type": "object",
"properties": {
"objEzsigntemplate": {
"$ref": "#/components/schemas/ezsigntemplate-ResponseCompound"
},
"objEzsigntemplatepackage": {
"$ref": "#/components/schemas/ezsigntemplatepackage-ResponseCompound"
}
}
}
]
},
"ezsignbulksenddocumentmapping-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignbulksenddocumentmapping",
"required": [
"a_objEzsignbulksenddocumentmapping"
],
"type": "object",
"properties": {
"a_objEzsignbulksenddocumentmapping": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-RequestCompound"
}
}
}
},
"ezsignbulksenddocumentmapping-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignbulksenddocumentmapping",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksenddocumentmapping-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignbulksenddocumentmapping",
"required": [
"a_pkiEzsignbulksenddocumentmappingID"
],
"type": "object",
"properties": {
"a_pkiEzsignbulksenddocumentmappingID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksenddocumentmappingID"
}
}
}
},
"ezsignbulksenddocumentmapping-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksenddocumentmapping-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksenddocumentmapping-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}",
"required": [
"objEzsignbulksenddocumentmapping"
],
"type": "object",
"properties": {
"objEzsignbulksenddocumentmapping": {
"$ref": "#/components/schemas/ezsignbulksenddocumentmapping-ResponseCompound"
}
}
},
"ezsignbulksendsignermapping-Request": {
"description": "A Ezsignbulksendsignermapping Object",
"required": [
"fkiEzsignbulksendID",
"sEzsignbulksendsignermappingDescription"
],
"type": "object",
"properties": {
"pkiEzsignbulksendsignermappingID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendsignermappingID"
},
"fkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sEzsignbulksendsignermappingDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendsignermappingDescription"
}
}
},
"ezsignbulksendsignermapping-RequestCompound": {
"description": "A Ezsignbulksendsignermapping Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksendsignermapping-Request"
},
{
"type": "object"
}
]
},
"ezsignbulksendsignermapping-Response": {
"description": "A Ezsignbulksendsignermapping Object",
"required": [
"pkiEzsignbulksendsignermappingID",
"fkiEzsignbulksendID",
"sEzsignbulksendsignermappingDescription"
],
"type": "object",
"properties": {
"pkiEzsignbulksendsignermappingID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendsignermappingID"
},
"fkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sEzsignbulksendsignermappingDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendsignermappingDescription"
}
}
},
"ezsignbulksendsignermapping-ResponseCompound": {
"description": "A Ezsignbulksendsignermapping Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksendsignermapping-Response"
},
{
"type": "object"
}
]
},
"ezsignbulksendsignermapping-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignbulksendsignermapping",
"required": [
"a_objEzsignbulksendsignermapping"
],
"type": "object",
"properties": {
"a_objEzsignbulksendsignermapping": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-RequestCompound"
}
}
}
},
"ezsignbulksendsignermapping-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignbulksendsignermapping",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksendsignermapping-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignbulksendsignermapping",
"required": [
"a_pkiEzsignbulksendsignermappingID"
],
"type": "object",
"properties": {
"a_pkiEzsignbulksendsignermappingID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendsignermappingID"
}
}
}
},
"ezsignbulksendsignermapping-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksendsignermapping-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksendsignermapping-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}",
"required": [
"objEzsignbulksendsignermapping"
],
"type": "object",
"properties": {
"objEzsignbulksendsignermapping": {
"$ref": "#/components/schemas/ezsignbulksendsignermapping-ResponseCompound"
}
}
},
"ezsignbulksendtransmission-Response": {
"description": "An Ezsignbulksendtransmission Object",
"required": [
"pkiEzsignbulksendtransmissionID",
"fkiEzsignbulksendID",
"sEzsignbulksendtransmissionDescription",
"iEzsignbulksendtransmissionErrors",
"objAudit"
],
"type": "object",
"properties": {
"pkiEzsignbulksendtransmissionID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendtransmissionID"
},
"fkiEzsignbulksendID": {
"$ref": "#/components/schemas/Field-pkiEzsignbulksendID"
},
"sEzsignbulksendtransmissionDescription": {
"$ref": "#/components/schemas/Field-sEzsignbulksendtransmissionDescription"
},
"iEzsignbulksendtransmissionErrors": {
"$ref": "#/components/schemas/Field-iEzsignbulksendtransmissionErrors"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"ezsignbulksendtransmission-ResponseCompound": {
"description": "An Ezsignbulksendtransmission Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignbulksendtransmission-Response"
},
{
"required": [
"a_objEzsignfoldertransmission"
],
"type": "object",
"properties": {
"a_objEzsignfoldertransmission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignfoldertransmission-Response"
}
}
}
}
]
},
"ezsignbulksendtransmission-getEzsignsignaturesAutomatic-v1-Response": {
"description": "Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-getEzsignsignaturesAutomatic-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksendtransmission-getEzsignsignaturesAutomatic-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic",
"required": [
"a_eEzsignsignatureType",
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_eEzsignsignatureType": {
"description": "All eEzsignsignatureType contained in the response",
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
}
},
"a_objEzsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfolderEzsignsignaturesAutomatic-Response"
}
}
}
},
"ezsignbulksendtransmission-getFormsData-v1-Response": {
"description": "Response for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-getFormsData-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksendtransmission-getFormsData-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData",
"required": [
"a_objFormsDataFolder"
],
"type": "object",
"properties": {
"a_objFormsDataFolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-FormsDataFolder-Response"
}
}
}
},
"ezsignbulksendtransmission-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignbulksendtransmission-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}",
"required": [
"objEzsignbulksendtransmission"
],
"type": "object",
"properties": {
"objEzsignbulksendtransmission": {
"$ref": "#/components/schemas/ezsignbulksendtransmission-ResponseCompound"
}
}
},
"ezsigndocument-Request": {
"description": "An Ezsigndocument Object",
"required": [
"fkiEzsignfolderID",
"fkiLanguageID",
"sEzsigndocumentName",
"eEzsigndocumentSource",
"dtEzsigndocumentDuedate"
],
"type": "object",
"properties": {
"pkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"eEzsigndocumentSource": {
"description": "Indicates where to look for the document binary content.",
"enum": [
"Base64",
"Ezsigntemplate",
"Url"
],
"type": "string"
},
"eEzsigndocumentFormat": {
"description": "Indicates the format of the document.",
"enum": [
"Pdf",
"Doc",
"Docx",
"Xls",
"Xlsx",
"Ppt",
"Pptx"
],
"type": "string"
},
"sEzsigndocumentBase64": {
"format": "byte",
"description": "The Base64 encoded binary content of the document.\n\nThis field is Required when eEzsigndocumentSource = Base64.",
"type": "string",
"example": {
"$ref": "#/components/examples/PdfAsBase64/value"
}
},
"sEzsigndocumentUrl": {
"description": "The url where the document content resides.\n\nThis field is Required when eEzsigndocumentSource = Url.",
"type": "string",
"example": "http://www.example.com/document.pdf"
},
"bEzsigndocumentForcerepair": {
"description": "Try to repair the document or flatten it if it cannot be used for electronic signature. ",
"default": true,
"type": "boolean"
},
"sEzsigndocumentPassword": {
"description": "If the source document is password protected, the password to open/modify it.",
"type": "string",
"example": "SecretPassword123"
},
"eEzsigndocumentForm": {
"description": "If the document contains an existing PDF form this property must be set.\r\n**Keep** leaves the form as-is in the document.\r\n**Convert** removes the form and convert all the existing fields to Ezsignformfieldgroups and assign them to the specified **fkiEzsignfoldersignerassociationID**",
"enum": [
"Keep",
"Convert"
],
"type": "string"
},
"dtEzsigndocumentDuedate": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentDuedate"
},
"sEzsigndocumentName": {
"$ref": "#/components/schemas/Field-sEzsigndocumentName"
},
"sEzsigndocumentExternalid": {
"$ref": "#/components/schemas/Common-Format-ExternalID"
}
}
},
"ezsigndocument-RequestCompound": {
"description": "An Ezsigndocument Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigndocument-Request"
}
]
},
"ezsigndocument-RequestPatch": {
"description": "An Ezsigndocument Object",
"type": "object",
"properties": {
"dtEzsigndocumentDuedate": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentDuedate"
},
"sEzsigndocumentName": {
"$ref": "#/components/schemas/Field-sEzsigndocumentName"
}
}
},
"ezsigndocument-Response": {
"description": "An Ezsigndocument Object",
"required": [
"pkiEzsigndocumentID",
"fkiEzsignfolderID",
"dtEzsigndocumentDuedate",
"sEzsigndocumentName",
"eEzsigndocumentStep",
"iEzsigndocumentOrder",
"iEzsigndocumentPagetotal",
"iEzsigndocumentSignaturesigned",
"iEzsigndocumentSignaturetotal"
],
"type": "object",
"properties": {
"pkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"fkiEzsignfoldersignerassociationIDDeclinedtosign": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"dtEzsigndocumentDuedate": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentDuedate"
},
"dtEzsignformCompleted": {
"$ref": "#/components/schemas/Field-dtEzsignformCompleted"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEzsigndocumentName": {
"$ref": "#/components/schemas/Field-sEzsigndocumentName"
},
"eEzsigndocumentStep": {
"$ref": "#/components/schemas/Field-eEzsigndocumentStep"
},
"dtEzsigndocumentFirstsend": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentFirstsend"
},
"dtEzsigndocumentLastsend": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentLastsend"
},
"iEzsigndocumentOrder": {
"$ref": "#/components/schemas/Field-iEzsigndocumentOrder"
},
"iEzsigndocumentPagetotal": {
"$ref": "#/components/schemas/Field-iEzsigndocumentPagetotal"
},
"iEzsigndocumentSignaturesigned": {
"$ref": "#/components/schemas/Field-iEzsigndocumentSignaturesigned"
},
"iEzsigndocumentSignaturetotal": {
"$ref": "#/components/schemas/Field-iEzsigndocumentSignaturetotal"
},
"sEzsigndocumentMD5initial": {
"$ref": "#/components/schemas/Field-sEzsigndocumentMD5initial"
},
"tEzsigndocumentDeclinedtosignreason": {
"$ref": "#/components/schemas/Field-tEzsigndocumentDeclinedtosignreason"
},
"sEzsigndocumentMD5signed": {
"$ref": "#/components/schemas/Field-sEzsigndocumentMD5signed"
},
"bEzsigndocumentEzsignform": {
"$ref": "#/components/schemas/Computed-bEzsigndocumentEzsignform"
},
"bEzsigndocumentHassignedsignatures": {
"$ref": "#/components/schemas/Field-bEzsigndocumentHassignedsignatures"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
},
"sEzsigndocumentExternalid": {
"$ref": "#/components/schemas/Common-Format-ExternalID"
}
}
},
"ezsigndocument-ResponseCompound": {
"description": "An Ezsigndocument Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigndocument-Response"
},
{
"required": [
"eEzsigndocumentSteptype",
"iEzsigndocumentStepformtotal",
"iEzsigndocumentStepformcurrent",
"iEzsigndocumentStepsignaturetotal",
"iEzsigndocumentStepsignatureCurrent",
"a_objEzsignfoldersignerassociationstatus"
],
"type": "object",
"properties": {
"eEzsigndocumentSteptype": {
"$ref": "#/components/schemas/Computed-eEzsigndocumentSteptype"
},
"iEzsigndocumentStepformtotal": {
"$ref": "#/components/schemas/Computed-iEzsigndocumentStepformtotal"
},
"iEzsigndocumentStepformcurrent": {
"$ref": "#/components/schemas/Computed-iEzsigndocumentStepformcurrent"
},
"iEzsigndocumentStepsignaturetotal": {
"$ref": "#/components/schemas/Computed-iEzsigndocumentStepsignaturetotal"
},
"iEzsigndocumentStepsignatureCurrent": {
"$ref": "#/components/schemas/Computed-iEzsigndocumentStepsignatureCurrent"
},
"a_objEzsignfoldersignerassociationstatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignfoldersignerassociationstatus-Response"
}
}
}
}
]
},
"ezsigndocument-applyEzsigntemplate-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate",
"required": [
"a_sEzsigntemplatesigner",
"a_pkiEzsignfoldersignerassociationID",
"fkiEzsigntemplateID"
],
"type": "object",
"properties": {
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"a_sEzsigntemplatesigner": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesigner"
}
},
"a_pkiEzsignfoldersignerassociationID": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsigndocument-applyEzsigntemplate-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-applyEzsigntemplate-v2-Request": {
"description": "Request for POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate",
"required": [
"a_sEzsigntemplatesigner",
"a_pkiEzsignfoldersignerassociationID",
"fkiEzsigntemplateID"
],
"type": "object",
"properties": {
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"a_sEzsigntemplatesigner": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesigner"
}
},
"a_pkiEzsignfoldersignerassociationID": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsigndocument-applyEzsigntemplate-v2-Response": {
"description": "Response for POST /2/object/ezsigndocument/{pkiEzsigndocument}/applyEzsigntemplate",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument",
"type": "object",
"properties": {
"objEzsigndocument": {
"$ref": "#/components/schemas/ezsigndocument-Request"
},
"objEzsigndocumentCompound": {
"$ref": "#/components/schemas/ezsigndocument-RequestCompound"
}
}
},
"ezsigndocument-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigndocument",
"required": [
"a_pkiEzsigndocumentID"
],
"type": "object",
"properties": {
"a_pkiEzsigndocumentID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
}
}
}
},
"ezsigndocument-createObject-v2-Request": {
"description": "Request for POST /2/object/ezsigndocument",
"required": [
"a_objEzsigndocument"
],
"type": "object",
"properties": {
"a_objEzsigndocument": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigndocument-RequestCompound"
}
}
}
},
"ezsigndocument-createObject-v2-Response": {
"description": "Response for POST /2/object/ezsigndocument",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-createObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-createObject-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsigndocument",
"required": [
"a_pkiEzsigndocumentID"
],
"type": "object",
"properties": {
"a_pkiEzsigndocumentID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
}
}
}
},
"ezsigndocument-declineToSign-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign",
"required": [
"sReason"
],
"type": "object",
"properties": {
"sReason": {
"description": "Reason for refusal",
"pattern": "^.{0,65535}$",
"type": "string",
"example": "Wrong document"
}
}
},
"ezsigndocument-declineToSign-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigndocument/{pkiEzsigndocumentID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-editEzsignformfieldgroups-v1-Request": {
"description": "Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups",
"required": [
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsignformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroup-RequestCompound"
}
}
}
},
"ezsigndocument-editEzsignformfieldgroups-v1-Response": {
"description": "Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-editEzsignformfieldgroups-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-editEzsignformfieldgroups-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups",
"required": [
"a_pkiEzsignformfieldgroupID"
],
"type": "object",
"properties": {
"a_pkiEzsignformfieldgroupID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
}
}
}
},
"ezsigndocument-editEzsignsignatures-v1-Request": {
"description": "Request for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures",
"required": [
"a_objEzsignsignature"
],
"type": "object",
"properties": {
"a_objEzsignsignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-RequestCompound"
}
}
}
},
"ezsigndocument-editEzsignsignatures-v1-Response": {
"description": "Response for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-editEzsignsignatures-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-editEzsignsignatures-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures",
"required": [
"a_pkiEzsignsignatureID"
],
"type": "object",
"properties": {
"a_pkiEzsignsignatureID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
}
}
}
},
"ezsigndocument-endPrematurely-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsigndocument-endPrematurely-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/endPrematurely",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-flatten-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsigndocument-flatten-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocument}/flatten",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getActionableElements-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getActionableElements-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getActionableElements-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements",
"required": [
"a_objEzsignsignature",
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsignsignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-ResponseCompound"
}
},
"a_objEzsignformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroup-ResponseCompound"
}
}
}
},
"ezsigndocument-getCompletedElements-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getCompletedElements-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getCompletedElements-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements",
"required": [
"a_objEzsignsignature",
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsignsignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-ResponseCompound"
}
},
"a_objEzsignformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroup-ResponseCompound"
}
}
}
},
"ezsigndocument-getDownloadUrl-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getDownloadUrl-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getDownloadUrl-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getDownloadUrl",
"required": [
"sDownloadUrl"
],
"type": "object",
"properties": {
"sDownloadUrl": {
"description": "The Url to the requested document.\n\nUrl will expire after 5 minutes.",
"type": "string",
"example": "http://www.example.com/document.pdf"
}
},
"example": {
"sDownloadUrl": "http://www.example.com/document.pdf"
}
},
"ezsigndocument-getEzsignannotations-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignannotations-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getEzsignannotations-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignannotations",
"required": [
"a_objEzsignannotation"
],
"type": "object",
"properties": {
"a_objEzsignannotation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignannotation-ResponseCompound"
}
}
}
},
"ezsigndocument-getEzsignformfieldgroups-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignformfieldgroups-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getEzsignformfieldgroups-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignformfieldgroups",
"required": [
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsignformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroup-ResponseCompound"
}
}
}
},
"ezsigndocument-getEzsignpages-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignpages-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getEzsignpages-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignpages",
"required": [
"a_objEzsignpage"
],
"type": "object",
"properties": {
"a_objEzsignpage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignpage-ResponseCompound"
}
}
}
},
"ezsigndocument-getEzsignsignatures-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignsignatures-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getEzsignsignatures-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsignsignatures",
"required": [
"a_objEzsignsignature"
],
"type": "object",
"properties": {
"a_objEzsignsignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-ResponseCompound"
}
}
}
},
"ezsigndocument-getEzsignsignaturesAutomatic-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getEzsignsignaturesAutomatic-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getEzsignsignaturesAutomatic-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic",
"required": [
"a_eEzsignsignatureType",
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_eEzsignsignatureType": {
"description": "All eEzsignsignatureType contained in the response",
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
}
},
"a_objEzsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfolderEzsignsignaturesAutomatic-Response"
}
}
}
},
"ezsigndocument-getFormData-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getFormData-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getFormData-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getFormData",
"required": [
"objFormDataDocument"
],
"type": "object",
"properties": {
"objFormDataDocument": {
"$ref": "#/components/schemas/Custom-FormDataDocument-Response"
}
}
},
"ezsigndocument-getObject-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getObject-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigndocument-ResponseCompound"
}
]
},
"ezsigndocument-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigndocument/{pkiEzsigndocumentID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigndocument/{pkiEzsigndocumentID}",
"required": [
"objEzsigndocument"
],
"type": "object",
"properties": {
"objEzsigndocument": {
"$ref": "#/components/schemas/ezsigndocument-ResponseCompound"
}
}
},
"ezsigndocument-getTemporaryProof-v1-Response": {
"description": "Response for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getTemporaryProof-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getTemporaryProof-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof",
"required": [
"a_objEzsigndocumentlog"
],
"type": "object",
"properties": {
"a_objEzsigndocumentlog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigndocumentlog-ResponseCompound"
}
}
}
},
"ezsigndocument-getWordsPositions-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions",
"required": [
"eSearchFor",
"eGet",
"bWordCaseSensitive"
],
"type": "object",
"properties": {
"eGet": {
"description": "Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*.",
"enum": [
"All",
"Words"
],
"type": "string"
},
"bWordCaseSensitive": {
"description": "IF *true*, words will be searched case-sensitive and results will be returned case-sensitive.\nIF *false*, words will be searched case-insensitive and results will be returned case-insensitive.",
"type": "boolean"
},
"a_sWord": {
"description": "Array of words to find in the document",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ezsigndocument-getWordsPositions-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigndocument-getWordsPositions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-getWordsPositions-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions",
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-WordPositionWord-Response"
}
},
"ezsigndocument-patchObject-v1-Request": {
"description": "Request for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID}",
"required": [
"objEzsigndocument"
],
"type": "object",
"properties": {
"objEzsigndocument": {
"$ref": "#/components/schemas/ezsigndocument-RequestPatch"
}
}
},
"ezsigndocument-patchObject-v1-Response": {
"description": "Response for PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-submitEzsignform-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform",
"required": [
"bEzsignformIsdraft",
"iEzsignformStep",
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"bEzsignformIsdraft": {
"description": "Whether the Ezsignform submitted is a draft or not.",
"type": "boolean"
},
"a_objEzsignformfieldgroup": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignformfieldgroup-Request"
}
}
}
},
"ezsigndocument-submitEzsignform-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocument-unsend-v1-Request": {
"description": "Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsigndocument-unsend-v1-Response": {
"description": "Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigndocumentlog-Response": {
"description": "An Ezsigndocumentlog Object",
"required": [
"dtEzsigndocumentlogDatetime",
"eEzsigndocumentlogType",
"sEzsigndocumentlogDetail",
"sEzsigndocumentlogLastname",
"sEzsigndocumentlogFirstname",
"sEzsigndocumentlogIP"
],
"type": "object",
"properties": {
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiEzsignsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignerID"
},
"dtEzsigndocumentlogDatetime": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentlogDatetime"
},
"eEzsigndocumentlogType": {
"$ref": "#/components/schemas/Field-eEzsigndocumentlogType"
},
"sEzsigndocumentlogDetail": {
"$ref": "#/components/schemas/Field-sEzsigndocumentlogDetail"
},
"sEzsigndocumentlogLastname": {
"description": "The last name of the User or Ezsignsigner",
"type": "string",
"example": "Doe"
},
"sEzsigndocumentlogFirstname": {
"description": "The first name of the User or Ezsignsigner",
"type": "string",
"example": "John"
},
"sEzsigndocumentlogIP": {
"$ref": "#/components/schemas/Common-Format-IP"
}
}
},
"ezsigndocumentlog-ResponseCompound": {
"description": "An Ezsigndocumentlog Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigndocumentlog-Response"
}
]
},
"ezsignfolder-ListElement": {
"description": "An Ezsignfolder List Element",
"required": [
"pkiEzsignfolderID",
"fkiEzsignfoldertypeID",
"sEzsignfoldertypeNameX",
"sEzsignfolderDescription",
"eEzsignfolderStep",
"dtCreatedDate",
"iEzsigndocument",
"iEzsigndocumentEdm",
"iEzsignsignature",
"iEzsignsignatureSigned",
"eEzsignfoldertypePrivacylevel"
],
"type": "object",
"properties": {
"pkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"eEzsignfolderStep": {
"$ref": "#/components/schemas/Field-eEzsignfolderStep"
},
"dtCreatedDate": {
"$ref": "#/components/schemas/Field-dtCreatedDate"
},
"dtEzsignfolderSentdate": {
"$ref": "#/components/schemas/Field-dtEzsignfolderSentdate"
},
"dtEzsignfolderDuedate": {
"$ref": "#/components/schemas/Computed-dtEzsignfolderDuedate"
},
"iEzsigndocument": {
"description": "The total number of Ezsigndocument in the folder",
"type": "integer"
},
"iEzsigndocumentEdm": {
"description": "The total number of Ezsigndocument in the folder that were saved in the edm system",
"type": "integer"
},
"iEzsignsignature": {
"description": "The total number of signature blocks in all Ezsigndocuments in the folder",
"type": "integer"
},
"iEzsignsignatureSigned": {
"description": "The total number of already signed signature blocks in all Ezsigndocuments in the folder",
"type": "integer"
}
}
},
"ezsignfolder-Request": {
"description": "An Ezsignfolder Object",
"required": [
"fkiEzsignfoldertypeID",
"sEzsignfolderDescription",
"tEzsignfolderNote",
"eEzsignfolderSendreminderfrequency"
],
"type": "object",
"properties": {
"pkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiEzsigntsarequirementID": {
"$ref": "#/components/schemas/Field-pkiEzsigntsarequirementID"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"tEzsignfolderNote": {
"$ref": "#/components/schemas/Field-tEzsignfolderNote"
},
"eEzsignfolderSendreminderfrequency": {
"$ref": "#/components/schemas/Field-eEzsignfolderSendreminderfrequency"
},
"sEzsignfolderExternalid": {
"$ref": "#/components/schemas/Common-Format-ExternalID"
}
}
},
"ezsignfolder-RequestCompound": {
"description": "An Ezsignfolder Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfolder-Request"
}
]
},
"ezsignfolder-Response": {
"description": "An Ezsignfolder Object",
"required": [
"pkiEzsignfolderID",
"sEzsignfolderDescription"
],
"type": "object",
"properties": {
"pkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"fkiEzsigntsarequirementID": {
"$ref": "#/components/schemas/Field-pkiEzsigntsarequirementID"
},
"sEzsigntsarequirementDescriptionX": {
"$ref": "#/components/schemas/Field-sEzsigntsarequirementDescriptionX"
},
"sEzsignfolderDescription": {
"$ref": "#/components/schemas/Field-sEzsignfolderDescription"
},
"tEzsignfolderNote": {
"$ref": "#/components/schemas/Field-tEzsignfolderNote"
},
"bEzsignfolderIsdisposable": {
"$ref": "#/components/schemas/Computed-bEzsignfolderIsdisposable"
},
"eEzsignfolderSendreminderfrequency": {
"$ref": "#/components/schemas/Field-eEzsignfolderSendreminderfrequency"
},
"dtEzsignfolderDelayedsenddate": {
"$ref": "#/components/schemas/Field-dtEzsignfolderDelayedsenddate"
},
"dtEzsignfolderDuedate": {
"$ref": "#/components/schemas/Computed-dtEzsignfolderDuedate"
},
"dtEzsignfolderSentdate": {
"$ref": "#/components/schemas/Field-dtEzsignfolderSentdate"
},
"dtEzsignfolderScheduledarchive": {
"$ref": "#/components/schemas/Computed-dtEzsignfolderScheduledarchive"
},
"dtEzsignfolderScheduleddispose": {
"$ref": "#/components/schemas/Computed-dtEzsignfolderScheduleddispose"
},
"eEzsignfolderStep": {
"$ref": "#/components/schemas/Field-eEzsignfolderStep"
},
"dtEzsignfolderClose": {
"$ref": "#/components/schemas/Field-dtEzsignfolderClose"
},
"tEzsignfolderMessage": {
"$ref": "#/components/schemas/Field-tEzsignfolderMessage"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
},
"sEzsignfolderExternalid": {
"$ref": "#/components/schemas/Common-Format-ExternalID"
}
}
},
"ezsignfolder-ResponseCompound": {
"description": "An Ezsignfolder Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfolder-Response"
}
]
},
"ezsignfolder-archive-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsignfolder-archive-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-batchDownload-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload",
"required": [
"a_pkiEzsigndocumentID",
"a_eDocumentType"
],
"type": "object",
"properties": {
"a_pkiEzsigndocumentID": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
}
},
"a_eDocumentType": {
"description": "The type of document to retrieve.\n\n1. **Signed** Is the final document once all signatures were applied.\n2. **Proofdocument** Is the evidence report.\n3. **Proof** Is the complete evidence archive including all of the above and more.",
"type": "array",
"items": {
"enum": [
"Signed",
"Proof",
"Proofdocument"
],
"type": "string"
}
}
}
},
"ezsignfolder-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder",
"type": "object",
"properties": {
"objEzsignfolder": {
"$ref": "#/components/schemas/ezsignfolder-Request"
},
"objEzsignfolderCompound": {
"$ref": "#/components/schemas/ezsignfolder-RequestCompound"
}
}
},
"ezsignfolder-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignfolder",
"required": [
"a_pkiEzsignfolderID"
],
"type": "object",
"properties": {
"a_pkiEzsignfolderID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
}
}
}
},
"ezsignfolder-createObject-v2-Request": {
"description": "Request for POST /2/object/ezsignfolder",
"required": [
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_objEzsignfolder": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfolder-RequestCompound"
}
}
}
},
"ezsignfolder-createObject-v2-Response": {
"description": "Response for POST /2/object/ezsignfolder",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-createObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-createObject-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsignfolder",
"required": [
"a_pkiEzsignfolderID"
],
"type": "object",
"properties": {
"a_pkiEzsignfolderID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
}
}
}
},
"ezsignfolder-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignfolder/{pkiEzsignfolderID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-dispose-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsignfolder-dispose-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/dispose",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-disposeEzsignfolders-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/disposeEzsignfolders",
"required": [
"a_pkiEzsignfolderID"
],
"type": "object",
"properties": {
"a_pkiEzsignfolderID": {
"maxItems": 500,
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
}
}
}
},
"ezsignfolder-disposeEzsignfolders-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/disposeEzsignfolders",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignfolder/{pkiEzsignfolderID}",
"required": [
"objEzsignfolder"
],
"type": "object",
"properties": {
"objEzsignfolder": {
"$ref": "#/components/schemas/ezsignfolder-RequestCompound"
}
}
},
"ezsignfolder-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignfolder/{pkiEzsignfolderID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getActionableElements-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getActionableElements-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getActionableElements-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements",
"required": [
"a_objEzsignsignature",
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsignsignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-ResponseCompound"
}
},
"a_objEzsignformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroup-ResponseCompound"
}
}
}
},
"ezsignfolder-getCommunicationCount-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getCommunicationCount-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getCommunicationCount-v1-Response-mPayload": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount",
"required": [
"iCommunicationCount"
],
"type": "object",
"properties": {
"iCommunicationCount": {
"$ref": "#/components/schemas/Computed-iCommunicationCount"
}
}
},
"ezsignfolder-getCommunicationList-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getCommunicationList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"ezsignfolder-getCommunicationList-v1-Response-mPayload": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList",
"type": "object",
"allOf": [
{
"required": [
"a_objCommunication"
],
"type": "object",
"properties": {
"a_objCommunication": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-CommunicationListElement-Response"
}
}
}
}
]
},
"ezsignfolder-getEzsigndocuments-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getEzsigndocuments-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getEzsigndocuments-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsigndocuments",
"required": [
"a_objEzsigndocument"
],
"type": "object",
"properties": {
"a_objEzsigndocument": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigndocument-ResponseCompound"
}
}
}
},
"ezsignfolder-getEzsignfoldersignerassociations-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getEzsignfoldersignerassociations-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getEzsignfoldersignerassociations-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociations",
"required": [
"a_objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"a_objEzsignfoldersignerassociation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfoldersignerassociationActionableElement-Response"
}
}
}
},
"ezsignfolder-getEzsignfoldersignerassociationsmine-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociationsmine",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getEzsignfoldersignerassociationsmine-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getEzsignfoldersignerassociationsmine-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getEzsignfoldersignerassociationsmine",
"required": [
"a_objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"a_objEzsignfoldersignerassociation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignfoldersignerassociationmine-Response"
}
}
}
},
"ezsignfolder-getEzsignsignaturesAutomatic-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getEzsignsignaturesAutomatic-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getEzsignsignaturesAutomatic-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic",
"required": [
"a_eEzsignsignatureType",
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_eEzsignsignatureType": {
"description": "All eEzsignsignatureType contained in the response",
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
}
},
"a_objEzsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfolderEzsignsignaturesAutomatic-Response"
}
}
}
},
"ezsignfolder-getFormsData-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolder}/getFormsData",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getFormsData-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getFormsData-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsigndocument}/getFormsData",
"required": [
"objFormsDataFolder"
],
"type": "object",
"properties": {
"objFormsDataFolder": {
"$ref": "#/components/schemas/Custom-FormsDataFolder-Response"
}
}
},
"ezsignfolder-getList-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"ezsignfolder-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_objEzsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfolder-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"ezsignfolder-getObject-v1-Response": {
"description": "Response for GET /1/object/ezsignfolder/{pkiEzsignfolderID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getObject-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfolder/{pkiEzsignfolderID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfolder-ResponseCompound"
}
]
},
"ezsignfolder-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignfolder/{pkiEzsignfolderID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignfolder/{pkiEzsignfolderID}",
"required": [
"objEzsignfolder"
],
"type": "object",
"properties": {
"objEzsignfolder": {
"$ref": "#/components/schemas/ezsignfolder-ResponseCompound"
}
}
},
"ezsignfolder-importEzsignfoldersignerassociations-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations",
"required": [
"a_fkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"a_fkiEzsignfoldersignerassociationID": {
"minItems": 1,
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsignfolder-importEzsignfoldersignerassociations-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-importEzsignfoldersignerassociations-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-importEzsignfoldersignerassociations-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignfolder/{pkiEzsignfolder}/importEzsignfoldersignerassociations",
"required": [
"a_pkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"a_pkiEzsignfoldersignerassociationID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsignfolder-importEzsigntemplatepackage-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage",
"required": [
"fkiEzsigntemplatepackageID",
"dtEzsigndocumentDuedate",
"a_objImportEzsigntemplatepackageRelation"
],
"type": "object",
"properties": {
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"dtEzsigndocumentDuedate": {
"$ref": "#/components/schemas/Field-dtEzsigndocumentDuedate"
},
"a_objImportEzsigntemplatepackageRelation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-ImportEzsigntemplatepackageRelation-Request"
}
}
}
},
"ezsignfolder-importEzsigntemplatepackage-v1-Response": {
"description": "Response for POST/1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfolder-importEzsigntemplatepackage-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-importEzsigntemplatepackage-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage",
"required": [
"a_objEzsigndocument"
],
"type": "object",
"properties": {
"a_objEzsigndocument": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigndocument-ResponseCompound"
}
}
}
},
"ezsignfolder-reorder-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder",
"required": [
"a_pkiEzsigndocumentID"
],
"type": "object",
"properties": {
"a_pkiEzsigndocumentID": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
}
}
}
},
"ezsignfolder-reorder-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-send-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send",
"required": [
"tExtraMessage"
],
"type": "object",
"properties": {
"tExtraMessage": {
"$ref": "#/components/schemas/Field-tExtraMessage"
}
}
},
"ezsignfolder-send-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-send-v2-Request": {
"description": "Request for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send",
"required": [
"tEzsignfolderMessage",
"a_fkiEzsignfoldersignerassociationID",
"a_objEzsignfoldersignerassociationmessage"
],
"type": "object",
"properties": {
"tEzsignfolderMessage": {
"$ref": "#/components/schemas/Field-tEzsignfolderMessage"
},
"a_fkiEzsignfoldersignerassociationID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
},
"a_objEzsignfoldersignerassociationmessage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Ezsignfoldersignerassociationmessage-Request"
}
}
}
},
"ezsignfolder-send-v2-Response": {
"description": "Response for POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-send-v3-Request": {
"description": "Request for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send",
"required": [
"tEzsignfolderMessage",
"a_fkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"tEzsignfolderMessage": {
"$ref": "#/components/schemas/Field-tEzsignfolderMessage"
},
"dtEzsignfolderDelayedsenddate": {
"$ref": "#/components/schemas/Field-dtEzsignfolderDelayedsenddate"
},
"a_fkiEzsignfoldersignerassociationID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsignfolder-send-v3-Response": {
"description": "Response for POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfolder-unsend-v1-Request": {
"description": "Request for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsignfolder-unsend-v1-Response": {
"description": "Response for POST /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-Request": {
"description": "An Ezsignfoldersignerassociation Object",
"required": [
"fkiEzsignfolderID"
],
"type": "object",
"properties": {
"pkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiEzsignsignergroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"bEzsignfoldersignerassociationReceivecopy": {
"$ref": "#/components/schemas/Field-bEzsignfoldersignerassociationReceivecopy"
},
"tEzsignfoldersignerassociationMessage": {
"$ref": "#/components/schemas/Field-tEzsignfoldersignerassociationMessage"
}
}
},
"ezsignfoldersignerassociation-RequestCompound": {
"description": "An Ezsignfoldersignerassociation Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfoldersignerassociation-Request"
},
{
"type": "object",
"properties": {
"objEzsignsigner": {
"$ref": "#/components/schemas/ezsignsigner-RequestCompound"
}
}
}
]
},
"ezsignfoldersignerassociation-RequestPatch": {
"description": "An Ezsignfoldersignerassociation Object",
"type": "object",
"properties": {
"tEzsignfoldersignerassociationMessage": {
"$ref": "#/components/schemas/Field-tEzsignfoldersignerassociationMessage"
}
}
},
"ezsignfoldersignerassociation-Response": {
"description": "An Ezsignfoldersignerassociation Object",
"required": [
"pkiEzsignfoldersignerassociationID",
"fkiEzsignfolderID",
"bEzsignfoldersignerassociationDelayedsend",
"bEzsignfoldersignerassociationReceivecopy",
"tEzsignfoldersignerassociationMessage"
],
"type": "object",
"properties": {
"pkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"bEzsignfoldersignerassociationDelayedsend": {
"$ref": "#/components/schemas/Field-bEzsignfoldersignerassociationDelayedsend"
},
"bEzsignfoldersignerassociationReceivecopy": {
"$ref": "#/components/schemas/Field-bEzsignfoldersignerassociationReceivecopy"
},
"tEzsignfoldersignerassociationMessage": {
"$ref": "#/components/schemas/Field-tEzsignfoldersignerassociationMessage"
}
}
},
"ezsignfoldersignerassociation-ResponseCompound": {
"description": "An Ezsignfoldersignerassociation Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfoldersignerassociation-Response"
},
{
"type": "object",
"properties": {
"objEzsignsignergroup": {
"$ref": "#/components/schemas/ezsignsignergroup-ResponseCompound"
},
"objUser": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound-User"
},
"objEzsignsigner": {
"$ref": "#/components/schemas/ezsignsigner-ResponseCompound"
}
}
}
]
},
"ezsignfoldersignerassociation-ResponseCompound-User": {
"description": "A Ezsignfoldersignerassociation->User Object and children to create a complete structure",
"required": [
"pkiUserID",
"fkiLanguageID",
"sUserFirstname",
"sUserLastname",
"sEmailAddress"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
}
}
},
"ezsignfoldersignerassociation-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignfoldersignerassociation",
"type": "object",
"properties": {
"objEzsignfoldersignerassociation": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-Request"
},
"objEzsignfoldersignerassociationCompound": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-RequestCompound"
}
}
},
"ezsignfoldersignerassociation-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignfoldersignerassociation",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignfoldersignerassociation",
"required": [
"a_pkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"a_pkiEzsignfoldersignerassociationID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsignfoldersignerassociation-createObject-v2-Request": {
"description": "Request for POST /2/object/ezsignfoldersignerassociation",
"required": [
"a_objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"a_objEzsignfoldersignerassociation": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-RequestCompound"
}
}
}
},
"ezsignfoldersignerassociation-createObject-v2-Response": {
"description": "Response for POST /2/object/ezsignfoldersignerassociation",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-createObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-createObject-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsignfoldersignerassociation",
"required": [
"a_pkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"a_pkiEzsignfoldersignerassociationID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
}
},
"ezsignfoldersignerassociation-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"required": [
"objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"objEzsignfoldersignerassociation": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-RequestCompound"
}
}
},
"ezsignfoldersignerassociation-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-forceDisconnect-v1-Request": {
"description": "Request for POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociation}/forceDisconnect\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsignfoldersignerassociation-forceDisconnect-v1-Response": {
"description": "Response for POST /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociation}/forceDisconnect",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-getInPersonLoginUrl-v1-Response": {
"description": "Response for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-getInPersonLoginUrl-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-getInPersonLoginUrl-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfoldersignerassociation/getInPersonLoginUrl",
"required": [
"sLoginUrl"
],
"type": "object",
"properties": {
"sLoginUrl": {
"description": "The Url to login to the signing application.\r\n\r\nUrl will expire after 30 minutes.\r\n",
"type": "string"
}
}
},
"ezsignfoldersignerassociation-getObject-v1-Response": {
"description": "Response for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-getObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-getObject-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound"
}
]
},
"ezsignfoldersignerassociation-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldersignerassociation-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"required": [
"objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"objEzsignfoldersignerassociation": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-ResponseCompound"
}
}
},
"ezsignfoldersignerassociation-patchObject-v1-Request": {
"description": "Request for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"required": [
"objEzsignfoldersignerassociation"
],
"type": "object",
"properties": {
"objEzsignfoldersignerassociation": {
"$ref": "#/components/schemas/ezsignfoldersignerassociation-RequestPatch"
}
}
},
"ezsignfoldersignerassociation-patchObject-v1-Response": {
"description": "Response for PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldertype-AutocompleteElement-Response": {
"description": "A Ezsignfoldertype AutocompleteElement Response",
"required": [
"eEzsignfoldertypePrivacylevel",
"sEzsignfoldertypeNameX",
"pkiEzsignfoldertypeID",
"bEzsignfoldertypeIsactive"
],
"type": "object",
"properties": {
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"pkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"bEzsignfoldertypeIsactive": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIsactive"
}
}
},
"ezsignfoldertype-ListElement": {
"description": "An Ezsignfoldertype List Element",
"required": [
"pkiEzsignfoldertypeID",
"eEzsignfoldertypePrivacylevel",
"sEzsignfoldertypeNameX",
"bEzsignfoldertypeIsactive"
],
"type": "object",
"properties": {
"pkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"bEzsignfoldertypeIsactive": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIsactive"
}
}
},
"ezsignfoldertype-Request": {
"description": "A Ezsignfoldertype Object",
"required": [
"fkiBrandingID",
"objEzsignfoldertypeName",
"bEzsignfoldertypeSendattatchmentsigner",
"bEzsignfoldertypeSendsignedtodocumentowner",
"bEzsignfoldertypeSendsignedtofolderowner",
"bEzsignfoldertypeSendsignedtocolleague",
"bEzsignfoldertypeSendsummarytodocumentowner",
"bEzsignfoldertypeSendsummarytofolderowner",
"bEzsignfoldertypeSendsummarytocolleague",
"bEzsignfoldertypeIncludeproofsigner",
"bEzsignfoldertypeIncludeproofuser",
"bEzsignfoldertypeIsactive",
"eEzsignfoldertypeDisposal",
"eEzsignfoldertypePrivacylevel",
"iEzsignfoldertypeArchivaldays",
"iEzsignfoldertypeDeadlinedays"
],
"type": "object",
"properties": {
"pkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"objEzsignfoldertypeName": {
"$ref": "#/components/schemas/Multilingual-EzsignfoldertypeName"
},
"fkiBrandingID": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiUsergroupIDRestricted": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiEzsigntsarequirementID": {
"$ref": "#/components/schemas/Field-pkiEzsigntsarequirementID"
},
"sEmailAddressSigned": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sEmailAddressSummary": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"eEzsignfoldertypeSendreminderfrequency": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypeSendreminderfrequency"
},
"iEzsignfoldertypeArchivaldays": {
"$ref": "#/components/schemas/Field-iEzsignfoldertypeArchivaldays"
},
"eEzsignfoldertypeDisposal": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypeDisposal"
},
"iEzsignfoldertypeDisposaldays": {
"$ref": "#/components/schemas/Field-iEzsignfoldertypeDisposaldays"
},
"iEzsignfoldertypeDeadlinedays": {
"$ref": "#/components/schemas/Field-iEzsignfoldertypeDeadlinedays"
},
"bEzsignfoldertypeSendattatchmentsigner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendattatchmentsigner"
},
"bEzsignfoldertypeSendsignedtodocumentowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtodocumentowner"
},
"bEzsignfoldertypeSendsignedtofolderowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtofolderowner"
},
"bEzsignfoldertypeSendsignedtofullgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtofullgroup"
},
"bEzsignfoldertypeSendsignedtolimitedgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtolimitedgroup"
},
"bEzsignfoldertypeSendsignedtocolleague": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtocolleague"
},
"bEzsignfoldertypeSendsummarytodocumentowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytodocumentowner"
},
"bEzsignfoldertypeSendsummarytofolderowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytofolderowner"
},
"bEzsignfoldertypeSendsummarytofullgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytofullgroup"
},
"bEzsignfoldertypeSendsummarytolimitedgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytolimitedgroup"
},
"bEzsignfoldertypeSendsummarytocolleague": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytocolleague"
},
"bEzsignfoldertypeIncludeproofsigner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIncludeproofsigner"
},
"bEzsignfoldertypeIncludeproofuser": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIncludeproofuser"
},
"bEzsignfoldertypeIsactive": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIsactive"
}
}
},
"ezsignfoldertype-RequestCompound": {
"description": "A Ezsignfoldertype Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfoldertype-Request"
},
{
"type": "object",
"properties": {
"a_fkiUserIDSigned": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
},
"a_fkiUserIDSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
}
}
]
},
"ezsignfoldertype-Response": {
"description": "A Ezsignfoldertype Object",
"required": [
"pkiEzsignfoldertypeID",
"fkiBrandingID",
"objEzsignfoldertypeName",
"sBrandingDescriptionX",
"bEzsignfoldertypeSendattatchmentsigner",
"bEzsignfoldertypeSendsignedtodocumentowner",
"bEzsignfoldertypeSendsignedtofolderowner",
"bEzsignfoldertypeSendsignedtocolleague",
"bEzsignfoldertypeSendsummarytodocumentowner",
"bEzsignfoldertypeSendsummarytofolderowner",
"bEzsignfoldertypeSendsummarytocolleague",
"bEzsignfoldertypeIncludeproofsigner",
"bEzsignfoldertypeIncludeproofuser",
"bEzsignfoldertypeIsactive",
"eEzsignfoldertypeDisposal",
"eEzsignfoldertypePrivacylevel",
"iEzsignfoldertypeArchivaldays",
"iEzsignfoldertypeDeadlinedays"
],
"type": "object",
"properties": {
"pkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"objEzsignfoldertypeName": {
"$ref": "#/components/schemas/Multilingual-EzsignfoldertypeName"
},
"fkiBrandingID": {
"$ref": "#/components/schemas/Field-pkiBrandingID"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiUsergroupIDRestricted": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiEzsigntsarequirementID": {
"$ref": "#/components/schemas/Field-pkiEzsigntsarequirementID"
},
"sBrandingDescriptionX": {
"$ref": "#/components/schemas/Field-sBrandingDescriptionX"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"sEzsigntsarequirementDescriptionX": {
"$ref": "#/components/schemas/Field-sEzsigntsarequirementDescriptionX"
},
"sEmailAddressSigned": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sEmailAddressSummary": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sUsergroupNameX": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
},
"sUsergroupNameXRestricted": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
},
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"eEzsignfoldertypeSendreminderfrequency": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypeSendreminderfrequency"
},
"iEzsignfoldertypeArchivaldays": {
"$ref": "#/components/schemas/Field-iEzsignfoldertypeArchivaldays"
},
"eEzsignfoldertypeDisposal": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypeDisposal"
},
"iEzsignfoldertypeDisposaldays": {
"$ref": "#/components/schemas/Field-iEzsignfoldertypeDisposaldays"
},
"iEzsignfoldertypeDeadlinedays": {
"$ref": "#/components/schemas/Field-iEzsignfoldertypeDeadlinedays"
},
"bEzsignfoldertypeSendattatchmentsigner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendattatchmentsigner"
},
"bEzsignfoldertypeSendsignedtodocumentowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtodocumentowner"
},
"bEzsignfoldertypeSendsignedtofolderowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtofolderowner"
},
"bEzsignfoldertypeSendsignedtofullgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtofullgroup"
},
"bEzsignfoldertypeSendsignedtolimitedgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtolimitedgroup"
},
"bEzsignfoldertypeSendsignedtocolleague": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsignedtocolleague"
},
"bEzsignfoldertypeSendsummarytodocumentowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytodocumentowner"
},
"bEzsignfoldertypeSendsummarytofolderowner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytofolderowner"
},
"bEzsignfoldertypeSendsummarytofullgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytofullgroup"
},
"bEzsignfoldertypeSendsummarytolimitedgroup": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytolimitedgroup"
},
"bEzsignfoldertypeSendsummarytocolleague": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeSendsummarytocolleague"
},
"bEzsignfoldertypeIncludeproofsigner": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIncludeproofsigner"
},
"bEzsignfoldertypeIncludeproofuser": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIncludeproofuser"
},
"bEzsignfoldertypeIsactive": {
"$ref": "#/components/schemas/Field-bEzsignfoldertypeIsactive"
}
}
},
"ezsignfoldertype-ResponseCompound": {
"description": "A Ezsignfoldertype Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignfoldertype-Response"
},
{
"type": "object",
"properties": {
"a_fkiUserIDSigned": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
},
"a_fkiUserIDSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
}
}
]
},
"ezsignfoldertype-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignfoldertype",
"required": [
"a_objEzsignfoldertype"
],
"type": "object",
"properties": {
"a_objEzsignfoldertype": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfoldertype-RequestCompound"
}
}
}
},
"ezsignfoldertype-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignfoldertype",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldertype-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldertype-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignfoldertype",
"required": [
"a_pkiEzsignfoldertypeID"
],
"type": "object",
"properties": {
"a_pkiEzsignfoldertypeID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
}
}
}
},
"ezsignfoldertype-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}",
"required": [
"objEzsignfoldertype"
],
"type": "object",
"properties": {
"objEzsignfoldertype": {
"$ref": "#/components/schemas/ezsignfoldertype-RequestCompound"
}
}
},
"ezsignfoldertype-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldertype-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/ezsignfoldertype/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldertype-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldertype-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsignfoldertype/getAutocomplete",
"required": [
"a_objEzsignfoldertype"
],
"type": "object",
"properties": {
"a_objEzsignfoldertype": {
"description": "An array of Ezsignfoldertype autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfoldertype-AutocompleteElement-Response"
}
}
}
},
"ezsignfoldertype-getList-v1-Response": {
"description": "Response for GET /1/object/ezsignfoldertype/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldertype-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"ezsignfoldertype-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsignfoldertype/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objEzsignfoldertype"
],
"type": "object",
"properties": {
"a_objEzsignfoldertype": {
"description": "",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignfoldertype-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"ezsignfoldertype-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignfoldertype-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignfoldertype-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID}",
"required": [
"objEzsignfoldertype"
],
"type": "object",
"properties": {
"objEzsignfoldertype": {
"$ref": "#/components/schemas/ezsignfoldertype-ResponseCompound"
}
}
},
"ezsignformfield-Request": {
"description": "A Ezsignformfield Object",
"required": [
"iEzsignpagePagenumber",
"sEzsignformfieldLabel",
"iEzsignformfieldX",
"iEzsignformfieldY",
"iEzsignformfieldWidth",
"iEzsignformfieldHeight"
],
"type": "object",
"properties": {
"pkiEzsignformfieldID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldID"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
},
"sEzsignformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldLabel"
},
"sEzsignformfieldValue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldValue"
},
"iEzsignformfieldX": {
"$ref": "#/components/schemas/Field-iEzsignformfieldX"
},
"iEzsignformfieldY": {
"$ref": "#/components/schemas/Field-iEzsignformfieldY"
},
"iEzsignformfieldWidth": {
"$ref": "#/components/schemas/Field-iEzsignformfieldWidth"
},
"iEzsignformfieldHeight": {
"$ref": "#/components/schemas/Field-iEzsignformfieldHeight"
},
"bEzsignformfieldSelected": {
"$ref": "#/components/schemas/Field-bEzsignformfieldSelected"
},
"sEzsignformfieldEnteredvalue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldEnteredvalue"
}
}
},
"ezsignformfield-RequestCompound": {
"description": "An Ezsignformfield Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignformfield-Request"
}
]
},
"ezsignformfield-Response": {
"description": "An Ezsignformfield Object",
"required": [
"pkiEzsignformfieldID",
"iEzsignpagePagenumber",
"sEzsignformfieldLabel",
"iEzsignformfieldX",
"iEzsignformfieldY",
"iEzsignformfieldWidth",
"iEzsignformfieldHeight"
],
"type": "object",
"properties": {
"pkiEzsignformfieldID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldID"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
},
"sEzsignformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldLabel"
},
"sEzsignformfieldValue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldValue"
},
"iEzsignformfieldX": {
"$ref": "#/components/schemas/Field-iEzsignformfieldX"
},
"iEzsignformfieldY": {
"$ref": "#/components/schemas/Field-iEzsignformfieldY"
},
"iEzsignformfieldWidth": {
"$ref": "#/components/schemas/Field-iEzsignformfieldWidth"
},
"iEzsignformfieldHeight": {
"$ref": "#/components/schemas/Field-iEzsignformfieldHeight"
},
"bEzsignformfieldSelected": {
"$ref": "#/components/schemas/Field-bEzsignformfieldSelected"
},
"sEzsignformfieldEnteredvalue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldEnteredvalue"
}
}
},
"ezsignformfield-ResponseCompound": {
"description": "An Ezsignformfield Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignformfield-Response"
}
]
},
"ezsignformfieldgroup-Request": {
"description": "An Ezsignformfieldgroup Object",
"required": [
"fkiEzsigndocumentID",
"eEzsignformfieldgroupType",
"eEzsignformfieldgroupSignerrequirement",
"sEzsignformfieldgroupLabel",
"iEzsignformfieldgroupStep",
"sEzsignformfieldgroupDefaultvalue",
"iEzsignformfieldgroupFilledmin",
"iEzsignformfieldgroupFilledmax",
"bEzsignformfieldgroupReadonly"
],
"type": "object",
"properties": {
"pkiEzsignformfieldgroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
},
"fkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"eEzsignformfieldgroupType": {
"$ref": "#/components/schemas/Field-eEzsignformfieldgroupType"
},
"eEzsignformfieldgroupSignerrequirement": {
"$ref": "#/components/schemas/Field-eEzsignformfieldgroupSignerrequirement"
},
"sEzsignformfieldgroupLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupLabel"
},
"iEzsignformfieldgroupStep": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupStep"
},
"sEzsignformfieldgroupDefaultvalue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupDefaultvalue"
},
"iEzsignformfieldgroupFilledmin": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupFilledmin"
},
"iEzsignformfieldgroupFilledmax": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupFilledmax"
},
"bEzsignformfieldgroupReadonly": {
"$ref": "#/components/schemas/Field-bEzsignformfieldgroupReadonly"
},
"iEzsignformfieldgroupMaxlength": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupMaxlength"
},
"bEzsignformfieldgroupEncrypted": {
"$ref": "#/components/schemas/Field-bEzsignformfieldgroupEncrypted"
},
"sEzsignformfieldgroupRegexp": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupRegexp"
},
"tEzsignformfieldgroupTooltip": {
"$ref": "#/components/schemas/Field-tEzsignformfieldgroupTooltip"
},
"eEzsignformfieldgroupTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsignformfieldgroupTooltipposition"
},
"eEzsignformfieldgroupTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
}
}
},
"ezsignformfieldgroup-RequestCompound": {
"description": "An Ezsignformfieldgroup Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignformfieldgroup-Request"
},
{
"required": [
"a_objEzsignformfieldgroupsigner",
"a_objEzsignformfield"
],
"type": "object",
"properties": {
"a_objEzsignformfieldgroupsigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroupsigner-RequestCompound"
}
},
"a_objDropdownElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-DropdownElement-RequestCompound"
}
},
"a_objEzsignformfield": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfield-RequestCompound"
}
}
}
}
]
},
"ezsignformfieldgroup-Response": {
"description": "An Ezsignformfieldgroup Object",
"required": [
"pkiEzsignformfieldgroupID",
"fkiEzsigndocumentID",
"eEzsignformfieldgroupType",
"eEzsignformfieldgroupSignerrequirement",
"sEzsignformfieldgroupLabel",
"iEzsignformfieldgroupStep",
"iEzsignformfieldgroupFilledmin",
"iEzsignformfieldgroupFilledmax",
"bEzsignformfieldgroupReadonly"
],
"type": "object",
"properties": {
"pkiEzsignformfieldgroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
},
"fkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"eEzsignformfieldgroupType": {
"$ref": "#/components/schemas/Field-eEzsignformfieldgroupType"
},
"eEzsignformfieldgroupSignerrequirement": {
"$ref": "#/components/schemas/Field-eEzsignformfieldgroupSignerrequirement"
},
"sEzsignformfieldgroupLabel": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupLabel"
},
"iEzsignformfieldgroupStep": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupStep"
},
"sEzsignformfieldgroupDefaultvalue": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupDefaultvalue"
},
"iEzsignformfieldgroupFilledmin": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupFilledmin"
},
"iEzsignformfieldgroupFilledmax": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupFilledmax"
},
"bEzsignformfieldgroupReadonly": {
"$ref": "#/components/schemas/Field-bEzsignformfieldgroupReadonly"
},
"iEzsignformfieldgroupMaxlength": {
"$ref": "#/components/schemas/Field-iEzsignformfieldgroupMaxlength"
},
"bEzsignformfieldgroupEncrypted": {
"$ref": "#/components/schemas/Field-bEzsignformfieldgroupEncrypted"
},
"eEzsignformfieldgroupTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
},
"sEzsignformfieldgroupRegexp": {
"$ref": "#/components/schemas/Field-sEzsignformfieldgroupRegexp"
},
"tEzsignformfieldgroupTooltip": {
"$ref": "#/components/schemas/Field-tEzsignformfieldgroupTooltip"
},
"eEzsignformfieldgroupTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsignformfieldgroupTooltipposition"
}
}
},
"ezsignformfieldgroup-ResponseCompound": {
"description": "An Ezsignformfieldgroup Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignformfieldgroup-Response"
},
{
"required": [
"a_objEzsignformfield",
"a_objEzsignformfieldgroupsigner"
],
"type": "object",
"properties": {
"a_objEzsignformfield": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfield-ResponseCompound"
}
},
"a_objDropdownElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-DropdownElement-ResponseCompound"
}
},
"a_objEzsignformfieldgroupsigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroupsigner-ResponseCompound"
}
}
}
}
]
},
"ezsignformfieldgroup-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignformfieldgroup",
"required": [
"a_objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsignformfieldgroup": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignformfieldgroup-RequestCompound"
}
}
}
},
"ezsignformfieldgroup-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignformfieldgroup",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignformfieldgroup-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignformfieldgroup-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignformfieldgroup",
"required": [
"a_pkiEzsignformfieldgroupID"
],
"type": "object",
"properties": {
"a_pkiEzsignformfieldgroupID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupID"
}
}
}
},
"ezsignformfieldgroup-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignformfieldgroup-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID}",
"required": [
"objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"objEzsignformfieldgroup": {
"$ref": "#/components/schemas/ezsignformfieldgroup-RequestCompound"
}
}
},
"ezsignformfieldgroup-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignformfieldgroup/{pkiEzsignfoldersignerassociationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignformfieldgroup-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignformfieldgroup-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignformfieldgroup-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}",
"required": [
"objEzsignformfieldgroup"
],
"type": "object",
"properties": {
"objEzsignformfieldgroup": {
"$ref": "#/components/schemas/ezsignformfieldgroup-ResponseCompound"
}
}
},
"ezsignformfieldgroupsigner-Request": {
"description": "A Ezsignformfieldgroupsigner Object",
"required": [
"fkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"pkiEzsignformfieldgroupsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupsignerID"
},
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
},
"ezsignformfieldgroupsigner-RequestCompound": {
"description": "An Ezsignformfieldgroupsigner Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignformfieldgroupsigner-Request"
}
]
},
"ezsignformfieldgroupsigner-Response": {
"description": "A Ezsignformfieldgroupsigner Object",
"required": [
"pkiEzsignformfieldgroupsignerID",
"fkiEzsignfoldersignerassociationID"
],
"type": "object",
"properties": {
"pkiEzsignformfieldgroupsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignformfieldgroupsignerID"
},
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
}
}
},
"ezsignformfieldgroupsigner-ResponseCompound": {
"description": "An Ezsignformfieldgroupsigner Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignformfieldgroupsigner-Response"
}
]
},
"ezsignpage-Response": {
"description": "An Ezsignpage Object",
"required": [
"pkiEzsignpageID",
"iEzsignpageWidthimage",
"iEzsignpageHeightimage",
"iEzsignpageWidthpdf",
"iEzsignpageHeightpdf",
"iEzsignpagePagenumber",
"sComputedImageurl"
],
"type": "object",
"properties": {
"pkiEzsignpageID": {
"$ref": "#/components/schemas/Field-pkiEzsignpageID"
},
"iEzsignpageWidthimage": {
"$ref": "#/components/schemas/Field-iEzsignpageWidthimage"
},
"iEzsignpageHeightimage": {
"$ref": "#/components/schemas/Field-iEzsignpageHeightimage"
},
"iEzsignpageWidthpdf": {
"$ref": "#/components/schemas/Field-iEzsignpageWidthpdf"
},
"iEzsignpageHeightpdf": {
"$ref": "#/components/schemas/Field-iEzsignpageHeightpdf"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
},
"sComputedImageurl": {
"description": "The Url to the Ezsignpage's rasterized image.\n\nUrl will expire after 5 minutes.",
"type": "string"
}
}
},
"ezsignpage-ResponseCompound": {
"description": "An Ezsignpage Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignpage-Response"
}
]
},
"ezsignpage-consult-v1-Request": {
"description": "Request for POST /1/object/ezsignpage/{pkiEzsignpageID}/consult\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsignpage-consult-v1-Response": {
"description": "Response for POST /1/object/ezsignpage/{pkiEzsignpageID}/consult",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-Request": {
"description": "An Ezsignsignature Object",
"required": [
"fkiEzsignfoldersignerassociationID",
"iEzsignpagePagenumber",
"iEzsignsignatureX",
"iEzsignsignatureY",
"iEzsignsignatureStep",
"eEzsignsignatureType",
"fkiEzsigndocumentID"
],
"type": "object",
"properties": {
"pkiEzsignsignatureID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
},
"iEzsignsignatureX": {
"$ref": "#/components/schemas/Field-iEzsignsignatureX"
},
"iEzsignsignatureY": {
"$ref": "#/components/schemas/Field-iEzsignsignatureY"
},
"iEzsignsignatureWidth": {
"$ref": "#/components/schemas/Field-iEzsignsignatureWidth"
},
"iEzsignsignatureHeight": {
"$ref": "#/components/schemas/Field-iEzsignsignatureHeight"
},
"iEzsignsignatureStep": {
"$ref": "#/components/schemas/Field-iEzsignsignatureStep"
},
"eEzsignsignatureType": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
},
"fkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"tEzsignsignatureTooltip": {
"$ref": "#/components/schemas/Field-tEzsignsignatureTooltip"
},
"eEzsignsignatureTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsignsignatureTooltipposition"
},
"eEzsignsignatureFont": {
"$ref": "#/components/schemas/Field-eEzsignsignatureFont"
},
"fkiEzsignfoldersignerassociationIDValidation": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"bEzsignsignatureRequired": {
"$ref": "#/components/schemas/Field-bEzsignsignatureRequired"
},
"eEzsignsignatureAttachmentnamesource": {
"$ref": "#/components/schemas/Field-eEzsignsignatureAttachmentnamesource"
},
"sEzsignsignatureAttachmentdescription": {
"$ref": "#/components/schemas/Field-sEzsignsignatureAttachmentdescription"
},
"iEzsignsignatureValidationstep": {
"$ref": "#/components/schemas/Field-iEzsignsignatureValidationstep"
},
"iEzsignsignatureMaxlength": {
"$ref": "#/components/schemas/Field-iEzsignsignatureMaxlength"
},
"eEzsignsignatureTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
},
"sEzsignsignatureRegexp": {
"$ref": "#/components/schemas/Field-sEzsignsignatureRegexp"
}
}
},
"ezsignsignature-RequestCompound": {
"description": "An Ezsignsignature Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignature-Request"
},
{
"type": "object",
"properties": {
"bEzsignsignatureCustomdate": {
"$ref": "#/components/schemas/Field-bEzsignsignatureCustomdate"
},
"a_objEzsignsignaturecustomdate": {
"description": "An array of custom date blocks that will be filled at the time of signature.\n\nCan only be used if bEzsignsignatureCustomdate is true.\n\nUse an empty array if you don't want to have a date at all.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignaturecustomdate-RequestCompound"
}
}
}
}
]
},
"ezsignsignature-Response": {
"description": "An Ezsignsignature Object",
"required": [
"pkiEzsignsignatureID",
"fkiEzsigndocumentID",
"fkiEzsignfoldersignerassociationID",
"iEzsignpagePagenumber",
"iEzsignsignatureX",
"iEzsignsignatureY",
"iEzsignsignatureStep",
"eEzsignsignatureType",
"objContactName"
],
"type": "object",
"properties": {
"pkiEzsignsignatureID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"fkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"fkiEzsignfoldersignerassociationID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"iEzsignpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsignpagePagenumber"
},
"iEzsignsignatureX": {
"$ref": "#/components/schemas/Field-iEzsignsignatureX"
},
"iEzsignsignatureY": {
"$ref": "#/components/schemas/Field-iEzsignsignatureY"
},
"iEzsignsignatureHeight": {
"$ref": "#/components/schemas/Field-iEzsignsignatureHeight"
},
"iEzsignsignatureWidth": {
"$ref": "#/components/schemas/Field-iEzsignsignatureWidth"
},
"iEzsignsignatureStep": {
"$ref": "#/components/schemas/Field-iEzsignsignatureStep"
},
"eEzsignsignatureType": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
},
"tEzsignsignatureTooltip": {
"$ref": "#/components/schemas/Field-tEzsignsignatureTooltip"
},
"eEzsignsignatureTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsignsignatureTooltipposition"
},
"eEzsignsignatureFont": {
"$ref": "#/components/schemas/Field-eEzsignsignatureFont"
},
"iEzsignsignatureValidationstep": {
"$ref": "#/components/schemas/Field-iEzsignsignatureValidationstep"
},
"sEzsignsignatureAttachmentdescription": {
"$ref": "#/components/schemas/Field-sEzsignsignatureAttachmentdescription"
},
"eEzsignsignatureAttachmentnamesource": {
"$ref": "#/components/schemas/Field-eEzsignsignatureAttachmentnamesource"
},
"bEzsignsignatureRequired": {
"$ref": "#/components/schemas/Field-bEzsignsignatureRequired"
},
"fkiEzsignfoldersignerassociationIDValidation": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldersignerassociationID"
},
"dtEzsignsignatureDate": {
"$ref": "#/components/schemas/Field-dtEzsignsignatureDate"
},
"iEzsignsignatureattachmentCount": {
"$ref": "#/components/schemas/Computed-iEzsignsignatureattachmentCount"
},
"sEzsignsignatureDescription": {
"$ref": "#/components/schemas/Field-sEzsignsignatureDescription"
},
"iEzsignsignatureMaxlength": {
"$ref": "#/components/schemas/Field-iEzsignsignatureMaxlength"
},
"eEzsignsignatureTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
},
"sEzsignsignatureRegexp": {
"$ref": "#/components/schemas/Field-sEzsignsignatureRegexp"
},
"objContactName": {
"$ref": "#/components/schemas/Custom-ContactName-Response"
},
"objSignature": {
"$ref": "#/components/schemas/signature-ResponseCompound"
}
}
},
"ezsignsignature-ResponseCompound": {
"description": "An Ezsignsignature Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignature-Response"
},
{
"type": "object",
"properties": {
"bEzsignsignatureCustomdate": {
"$ref": "#/components/schemas/Field-bEzsignsignatureCustomdate"
},
"a_objEzsignsignaturecustomdate": {
"description": "An array of custom date blocks that will be filled at the time of signature.\n\nCan only be used if bEzsignsignatureCustomdate is true.\n\nUse an empty array if you don't want to have a date at all.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignaturecustomdate-ResponseCompound"
}
},
"objCreditcardtransaction": {
"$ref": "#/components/schemas/Custom-Creditcardtransaction-Response"
}
}
}
]
},
"ezsignsignature-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignsignature",
"type": "object",
"properties": {
"objEzsignsignature": {
"$ref": "#/components/schemas/ezsignsignature-Request"
},
"objEzsignsignatureCompound": {
"$ref": "#/components/schemas/ezsignsignature-RequestCompound"
}
}
},
"ezsignsignature-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignsignature",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignature-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignsignature",
"required": [
"a_pkiEzsignsignatureID"
],
"type": "object",
"properties": {
"a_pkiEzsignsignatureID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
}
}
}
},
"ezsignsignature-createObject-v2-Request": {
"description": "Request for POST /2/object/ezsignsignature",
"required": [
"a_objEzsignsignature"
],
"type": "object",
"properties": {
"a_objEzsignsignature": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignature-RequestCompound"
}
}
}
},
"ezsignsignature-createObject-v2-Response": {
"description": "Response for POST /2/object/ezsignsignature",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignature-createObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-createObject-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsignsignature",
"required": [
"a_pkiEzsignsignatureID"
],
"type": "object",
"properties": {
"a_pkiEzsignsignatureID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
}
}
}
},
"ezsignsignature-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignsignature/{pkiEzsignsignatureID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID}",
"required": [
"objEzsignsignature"
],
"type": "object",
"properties": {
"objEzsignsignature": {
"$ref": "#/components/schemas/ezsignsignature-RequestCompound"
}
}
},
"ezsignsignature-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignsignature/{pkiEzsignsignatureID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-getEzsignsignatureattachment-v1-Response": {
"description": "Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignature-getEzsignsignatureattachment-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-getEzsignsignatureattachment-v1-Response-mPayload": {
"description": "Response for GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment",
"required": [
"a_objEzsignsignatureattachment"
],
"type": "object",
"properties": {
"a_objEzsignsignatureattachment": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignatureattachment-Response"
}
}
}
},
"ezsignsignature-getEzsignsignaturesAutomatic-v1-Response": {
"description": "Response for GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignature-getEzsignsignaturesAutomatic-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-getEzsignsignaturesAutomatic-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigsignature/getEzsignsignaturesAutomatic",
"required": [
"a_eEzsignsignatureType",
"a_objEzsignfolder"
],
"type": "object",
"properties": {
"a_eEzsignsignatureType": {
"description": "All eEzsignsignatureType contained in the response",
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-eEzsignsignatureType"
}
},
"a_objEzsignfolder": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-EzsignfolderEzsignsignaturesAutomatic-Response"
}
}
}
},
"ezsignsignature-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignsignature/{pkiEzsignsignatureID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignature-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignature-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignsignature/{pkiEzsignsignatureID}",
"required": [
"objEzsignsignature"
],
"type": "object",
"properties": {
"objEzsignsignature": {
"$ref": "#/components/schemas/ezsignsignature-ResponseCompound"
}
}
},
"ezsignsignature-sign-v1-Request": {
"description": "Request for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign",
"required": [
"bIsAutomatic"
],
"type": "object",
"properties": {
"sValue": {
"description": "The value required for the Ezsignsignature.\n\nThis can only be set if eEzsignsignatureType is **City**, **FieldText** or **FieldTextarea**",
"type": "string"
},
"eAttachmentsConfirmationDecision": {
"description": "Whether the attachment are accepted or refused.\n\nThis can only be set if eEzsignsignatureType is **AttachmentsConfirmation**",
"enum": [
"Accepted",
"Refused"
],
"type": "string"
},
"sAttachmentsRefusalReason": {
"description": "The reason of refused.\n\nThis can only be set if eEzsignsignatureType is **AttachmentsConfirmation**",
"type": "string"
},
"sSvg": {
"description": "The SVG of the handwritten signature.\n\nThis can only be set if eEzsignsignatureType is **Handwritten** and **bIsAutomatic** is false",
"pattern": "^.{0,32767}$",
"type": "string",
"example": {
"$ref": "#/components/examples/Svg/value"
}
},
"a_objFile": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-File"
}
},
"bIsAutomatic": {
"description": "Indicates if the Ezsignsignature was part of an automatic process or not.\n\nThis can only be true if eEzsignsignatureType is **Acknowledgement**, **City**, **Handwritten**, **Initials**, **Name** or **Stamp**. ",
"type": "boolean"
}
}
},
"ezsignsignature-sign-v1-Response": {
"description": "Response for POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignatureattachment-Response": {
"description": "An Ezsignsignatureattachment Object",
"required": [
"pkiEzsignsignatureattachmentID",
"fkiEzsignsignatureID",
"binEzsignsignatureattachmentMD5",
"sEzsignsignatureattachmentName",
"sDownloadUrl"
],
"type": "object",
"properties": {
"pkiEzsignsignatureattachmentID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureattachmentID"
},
"fkiEzsignsignatureID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignatureID"
},
"binEzsignsignatureattachmentMD5": {
"$ref": "#/components/schemas/Field-binEzsignsignatureattachmentMD5"
},
"sEzsignsignatureattachmentName": {
"$ref": "#/components/schemas/Field-sEzsignsignatureattachmentName"
},
"sDownloadUrl": {
"description": "The Url to the requested document.\n\nUrl will expire after 3 hours.",
"type": "string",
"example": "http://www.example.com/document.pdf"
}
}
},
"ezsignsignaturecustomdate-Request": {
"description": "An Ezsignsignaturecustomdate Object",
"required": [
"iEzsignsignaturecustomdateX",
"iEzsignsignaturecustomdateY",
"sEzsignsignaturecustomdateFormat"
],
"type": "object",
"properties": {
"pkiEzsignsignaturecustomdateID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignaturecustomdateID"
},
"iEzsignsignaturecustomdateX": {
"$ref": "#/components/schemas/Field-iEzsignsignaturecustomdateX"
},
"iEzsignsignaturecustomdateY": {
"$ref": "#/components/schemas/Field-iEzsignsignaturecustomdateY"
},
"sEzsignsignaturecustomdateFormat": {
"$ref": "#/components/schemas/Common-Format-CustomDateFormat"
}
}
},
"ezsignsignaturecustomdate-RequestCompound": {
"description": "An Ezsignsignaturecustomdate Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignaturecustomdate-Request"
}
]
},
"ezsignsignaturecustomdate-Response": {
"description": "An Ezsignsignaturecustomdate Object",
"required": [
"pkiEzsignsignaturecustomdateID",
"iEzsignsignaturecustomdateX",
"iEzsignsignaturecustomdateY",
"sEzsignsignaturecustomdateFormat"
],
"type": "object",
"properties": {
"pkiEzsignsignaturecustomdateID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignaturecustomdateID"
},
"iEzsignsignaturecustomdateX": {
"$ref": "#/components/schemas/Field-iEzsignsignaturecustomdateX"
},
"iEzsignsignaturecustomdateY": {
"$ref": "#/components/schemas/Field-iEzsignsignaturecustomdateY"
},
"sEzsignsignaturecustomdateFormat": {
"$ref": "#/components/schemas/Common-Format-CustomDateFormat"
}
}
},
"ezsignsignaturecustomdate-ResponseCompound": {
"description": "An Ezsignsignaturecustomdate Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignaturecustomdate-Response"
}
]
},
"ezsignsigner-Request": {
"description": "An Ezsignsigner Object",
"required": [
"fkiTaxassignmentID"
],
"type": "object",
"properties": {
"fkiUserlogintypeID": {
"$ref": "#/components/schemas/Field-pkiUserlogintypeID"
},
"fkiTaxassignmentID": {
"$ref": "#/components/schemas/Field-pkiTaxassignmentID"
},
"fkiSecretquestionID": {
"$ref": "#/components/schemas/Field-pkiSecretquestionID"
},
"eEzsignsignerLogintype": {
"deprecated": true,
"description": "The method the Ezsignsigner will authenticate to the signing platform.\n\n1. **Password** means the Ezsignsigner will receive a secure link by email.\n2. **PasswordPhone** means the Ezsignsigner will receive a secure link by email and will need to authenticate using SMS or Phone call. **Additional fee applies**.\n3. **PasswordQuestion** means the Ezsignsigner will receive a secure link by email and will need to authenticate using a predefined question and answer.\n4. **InPersonPhone** means the Ezsignsigner will only be able to sign \"In-Person\" and will need to authenticate using SMS or Phone call. No email will be sent for invitation to sign. **Additional fee applies**.\n5. **InPerson** means the Ezsignsigner will only be able to sign \"In-Person\" and there won't be any authentication. No email will be sent for invitation to sign. Make sure you evaluate the risk of signature denial and at minimum, we recommend you use a handwritten signature type.",
"enum": [
"Password",
"PasswordPhone",
"PasswordQuestion",
"InPersonPhone",
"InPerson"
],
"type": "string"
},
"sEzsignsignerSecretanswer": {
"description": "The predefined answer to the secret question the Ezsignsigner will need to provide to successfully authenticate.",
"type": "string"
}
},
"example": {
"fkiTaxassignmentID": 1,
"fkiSecretquestionID": 5,
"eEzsignsignerLogintype": "PasswordQuestion",
"sEzsignsignerSecretanswer": "This Is My Secret Answer"
}
},
"ezsignsigner-RequestCompound": {
"description": "An Ezsignsigner Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsigner-Request"
},
{
"required": [
"objContact"
],
"type": "object",
"properties": {
"objContact": {
"$ref": "#/components/schemas/ezsignsigner-RequestCompound-Contact"
}
}
}
]
},
"ezsignsigner-RequestCompound-Contact": {
"description": "A Ezsignsigner->Contact Object and children to create a complete structure",
"required": [
"sContactFirstname",
"sContactLastname",
"fkiLanguageID"
],
"type": "object",
"properties": {
"sContactFirstname": {
"$ref": "#/components/schemas/Field-sContactFirstname"
},
"sContactLastname": {
"$ref": "#/components/schemas/Field-sContactLastname"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sPhoneE164": {
"$ref": "#/components/schemas/Field-sPhoneE164"
},
"sPhoneExtension": {
"$ref": "#/components/schemas/Field-sPhoneExtension"
},
"sPhoneE164Cell": {
"$ref": "#/components/schemas/Field-sPhoneE164"
},
"sPhoneNumber": {
"deprecated": true,
"type": "string"
},
"sPhoneNumberCell": {
"deprecated": true,
"type": "string"
}
}
},
"ezsignsigner-Response": {
"description": "An Ezsignsigner Object",
"required": [
"pkiEzsignsignerID",
"fkiTaxassignmentID",
"fkiUserlogintypeID",
"sUserlogintypeDescriptionX"
],
"type": "object",
"properties": {
"pkiEzsignsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignerID"
},
"fkiTaxassignmentID": {
"$ref": "#/components/schemas/Field-pkiTaxassignmentID"
},
"fkiSecretquestionID": {
"$ref": "#/components/schemas/Field-pkiSecretquestionID"
},
"fkiUserlogintypeID": {
"$ref": "#/components/schemas/Field-pkiUserlogintypeID"
},
"sUserlogintypeDescriptionX": {
"$ref": "#/components/schemas/Field-sUserlogintypeDescriptionX"
}
}
},
"ezsignsigner-ResponseCompound": {
"description": "An Ezsignsigner Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsigner-Response"
},
{
"required": [
"objContact"
],
"type": "object",
"properties": {
"objContact": {
"$ref": "#/components/schemas/ezsignsigner-ResponseCompound-Contact"
}
}
}
]
},
"ezsignsigner-ResponseCompound-Contact": {
"description": "A Ezsignsigner->Contact Object and children to create a complete structure",
"required": [
"pkiContactID",
"sContactFirstname",
"sContactLastname",
"fkiLanguageID"
],
"type": "object",
"properties": {
"pkiContactID": {
"$ref": "#/components/schemas/Field-pkiContactID"
},
"sContactFirstname": {
"$ref": "#/components/schemas/Field-sContactFirstname"
},
"sContactLastname": {
"$ref": "#/components/schemas/Field-sContactLastname"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sPhoneE164": {
"$ref": "#/components/schemas/Field-sPhoneE164"
},
"sPhoneExtension": {
"$ref": "#/components/schemas/Field-sPhoneExtension"
},
"sPhoneE164Cell": {
"$ref": "#/components/schemas/Field-sPhoneE164"
}
}
},
"ezsignsignergroup-Request": {
"description": "A Ezsignsignergroup Object",
"required": [
"fkiEzsignfolderID",
"objEzsignsignergroupDescription"
],
"type": "object",
"properties": {
"pkiEzsignsignergroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"fkiEzsignfolderID": {
"$ref": "#/components/schemas/Field-pkiEzsignfolderID"
},
"objEzsignsignergroupDescription": {
"$ref": "#/components/schemas/Multilingual-EzsignsignergroupDescription"
}
}
},
"ezsignsignergroup-RequestCompound": {
"description": "A Ezsignsignergroup Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignergroup-Request"
},
{
"type": "object"
}
]
},
"ezsignsignergroup-Response": {
"description": "An Ezsignsignergroup Object",
"required": [
"pkiEzsignsignergroupID",
"objEzsignsignergroupDescription"
],
"type": "object",
"properties": {
"pkiEzsignsignergroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"objEzsignsignergroupDescription": {
"$ref": "#/components/schemas/Multilingual-EzsignsignergroupDescription"
},
"sEzsignsignergroupDescriptionX": {
"$ref": "#/components/schemas/Field-sEzsignsignergroupDescriptionX"
}
}
},
"ezsignsignergroup-ResponseCompound": {
"description": "An Ezsignsignergroup Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignergroup-Response"
},
{
"type": "object"
}
]
},
"ezsignsignergroup-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignsignergroup",
"required": [
"a_objEzsignsignergroup"
],
"type": "object",
"properties": {
"a_objEzsignsignergroup": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignergroup-RequestCompound"
}
}
}
},
"ezsignsignergroup-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignsignergroup",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignergroup-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroup-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignsignergroup",
"required": [
"a_pkiEzsignsignergroupID"
],
"type": "object",
"properties": {
"a_pkiEzsignsignergroupID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
}
}
}
},
"ezsignsignergroup-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroup-editEzsignsignergroupmemberships-v1-Request": {
"description": "Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships",
"required": [
"a_objEzsignsignergroupmembership"
],
"type": "object",
"properties": {
"a_objEzsignsignergroupmembership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-RequestCompound"
}
}
}
},
"ezsignsignergroup-editEzsignsignergroupmemberships-v1-Response": {
"description": "Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignergroup-editEzsignsignergroupmemberships-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroup-editEzsignsignergroupmemberships-v1-Response-mPayload": {
"description": "Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/editEzsignsignergroupmemberships",
"required": [
"a_pkiEzsignsignergroupmembershipID"
],
"type": "object",
"properties": {
"a_pkiEzsignsignergroupmembershipID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupmembershipID"
}
}
}
},
"ezsignsignergroup-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}",
"required": [
"objEzsignsignergroup"
],
"type": "object",
"properties": {
"objEzsignsignergroup": {
"$ref": "#/components/schemas/ezsignsignergroup-RequestCompound"
}
}
},
"ezsignsignergroup-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroup-getEzsignsignergroupmemberships-v1-Response": {
"description": "Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignergroup-getEzsignsignergroupmemberships-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroup-getEzsignsignergroupmemberships-v1-Response-mPayload": {
"description": "Response for GET /1/object/ezsignsignergroup/{pkiEzsignsignergroupID}/getEzsignsignergroupmemberships",
"required": [
"a_objEzsignsignergroupmembership"
],
"type": "object",
"properties": {
"a_objEzsignsignergroupmembership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-ResponseCompound"
}
}
}
},
"ezsignsignergroup-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignergroup-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroup-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignsignergroup/{pkiEzsignsignergroupID}",
"required": [
"objEzsignsignergroup"
],
"type": "object",
"properties": {
"objEzsignsignergroup": {
"$ref": "#/components/schemas/ezsignsignergroup-ResponseCompound"
}
}
},
"ezsignsignergroupmembership-Request": {
"description": "A Ezsignsignergroupmembership Object",
"required": [
"fkiEzsignsignergroupID"
],
"type": "object",
"properties": {
"pkiEzsignsignergroupmembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupmembershipID"
},
"fkiEzsignsignergroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"fkiEzsignsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignerID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
}
}
},
"ezsignsignergroupmembership-RequestCompound": {
"description": "A Ezsignsignergroupmembership Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignergroupmembership-Request"
},
{
"type": "object"
}
]
},
"ezsignsignergroupmembership-Response": {
"description": "A Ezsignsignergroupmembership Object",
"required": [
"pkiEzsignsignergroupmembershipID",
"fkiEzsignsignergroupID"
],
"type": "object",
"properties": {
"pkiEzsignsignergroupmembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupmembershipID"
},
"fkiEzsignsignergroupID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupID"
},
"fkiEzsignsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsignsignerID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
}
}
},
"ezsignsignergroupmembership-ResponseCompound": {
"description": "A Ezsignsignergroupmembership Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsignsignergroupmembership-Response"
},
{
"type": "object"
}
]
},
"ezsignsignergroupmembership-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsignsignergroupmembership",
"required": [
"a_objEzsignsignergroupmembership"
],
"type": "object",
"properties": {
"a_objEzsignsignergroupmembership": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-RequestCompound"
}
}
}
},
"ezsignsignergroupmembership-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsignsignergroupmembership",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroupmembership-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsignsignergroupmembership",
"required": [
"a_pkiEzsignsignergroupmembershipID"
],
"type": "object",
"properties": {
"a_pkiEzsignsignergroupmembershipID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignsignergroupmembershipID"
}
}
}
},
"ezsignsignergroupmembership-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroupmembership-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsignsignergroupmembership-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}",
"required": [
"objEzsignsignergroupmembership"
],
"type": "object",
"properties": {
"objEzsignsignergroupmembership": {
"$ref": "#/components/schemas/ezsignsignergroupmembership-ResponseCompound"
}
}
},
"ezsigntemplate-AutocompleteElement-Response": {
"description": "A Ezsigntemplate AutocompleteElement Response",
"required": [
"eEzsignfoldertypePrivacylevel",
"sEzsigntemplateDescription",
"pkiEzsigntemplateID",
"bEzsigntemplateIsactive"
],
"type": "object",
"properties": {
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"sEzsigntemplateDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplateDescription"
},
"pkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"bEzsigntemplateIsactive": {
"$ref": "#/components/schemas/Field-bEzsigntemplateIsactive"
}
}
},
"ezsigntemplate-ListElement": {
"description": "A Ezsigntemplate List Element",
"required": [
"pkiEzsigntemplateID",
"fkiLanguageID",
"sEzsigntemplatepackageTypedescriptionX",
"sEzsigntemplateDescription",
"bEzsigntemplateIncomplete",
"sEzsignfoldertypeNameX",
"fkiEzsignfoldertypeID"
],
"type": "object",
"properties": {
"pkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEzsigntemplateDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplateDescription"
},
"iEzsigntemplatedocumentPagetotal": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentPagetotal"
},
"iEzsigntemplateSignaturetotal": {
"$ref": "#/components/schemas/Computed-iEzsigntemplateSignaturetotal"
},
"iEzsigntemplateFormfieldtotal": {
"$ref": "#/components/schemas/Computed-iEzsigntemplateFormfieldtotal"
},
"bEzsigntemplateIncomplete": {
"$ref": "#/components/schemas/Computed-bEzsigntemplateIncomplete"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
}
}
},
"ezsigntemplate-Request": {
"description": "A Ezsigntemplate Object",
"required": [
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sEzsigntemplateDescription",
"bEzsigntemplateAdminonly"
],
"type": "object",
"properties": {
"pkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEzsigntemplateDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplateDescription"
},
"bEzsigntemplateAdminonly": {
"$ref": "#/components/schemas/Field-bEzsigntemplateAdminonly"
}
}
},
"ezsigntemplate-RequestCompound": {
"description": "A Ezsigntemplate Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplate-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplate-Response": {
"description": "A Ezsigntemplate Object",
"required": [
"pkiEzsigntemplateID",
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sLanguageNameX",
"sEzsigntemplateDescription",
"bEzsigntemplateAdminonly",
"sEzsignfoldertypeNameX",
"objAudit"
],
"type": "object",
"properties": {
"pkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"fkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sLanguageNameX": {
"$ref": "#/components/schemas/Field-sLanguageNameX"
},
"sEzsigntemplateDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplateDescription"
},
"bEzsigntemplateAdminonly": {
"$ref": "#/components/schemas/Field-bEzsigntemplateAdminonly"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit",
"description": ""
}
}
},
"ezsigntemplate-ResponseCompound": {
"description": "A Ezsigntemplate Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplate-Response"
},
{
"required": [
"a_objEzsigntemplatesigner"
],
"type": "object",
"properties": {
"objEzsigntemplatedocument": {
"$ref": "#/components/schemas/ezsigntemplatedocument-Response"
},
"a_objEzsigntemplatesigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesigner-ResponseCompound"
}
}
}
}
]
},
"ezsigntemplate-copy-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy",
"required": [
"a_fkiEzsignfoldertypeID"
],
"type": "object",
"properties": {
"a_fkiEzsignfoldertypeID": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
}
}
}
},
"ezsigntemplate-copy-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplate-copy-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-copy-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy",
"required": [
"a_pkiEzsigntemplateID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplateID": {
"description": "An array of unique IDs representing the object that were requested to be copied.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
}
}
}
},
"ezsigntemplate-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplate",
"required": [
"a_objEzsigntemplate"
],
"type": "object",
"properties": {
"a_objEzsigntemplate": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplate-RequestCompound"
}
}
}
},
"ezsigntemplate-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplate",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplate-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplate",
"required": [
"a_pkiEzsigntemplateID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplateID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
}
}
}
},
"ezsigntemplate-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID}",
"required": [
"objEzsigntemplate"
],
"type": "object",
"properties": {
"objEzsigntemplate": {
"$ref": "#/components/schemas/ezsigntemplate-RequestCompound"
}
}
},
"ezsigntemplate-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplate/{pkiEzsigntemplateID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplate/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplate-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsigntemplate/getAutocomplete",
"required": [
"a_objEzsigntemplate"
],
"type": "object",
"properties": {
"a_objEzsigntemplate": {
"description": "An array of Ezsigntemplate autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplate-AutocompleteElement-Response"
}
}
}
},
"ezsigntemplate-getList-v1-Response": {
"description": "Response for GET /1/object/ezsigntemplate/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplate-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"ezsigntemplate-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigntemplate/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objEzsigntemplate"
],
"type": "object",
"properties": {
"a_objEzsigntemplate": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplate-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"ezsigntemplate-getObject-v1-Response": {
"description": "Response for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplate-getObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-getObject-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigntemplate/{pkiEzsigntemplateID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplate-ResponseCompound"
}
]
},
"ezsigntemplate-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplate-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplate-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplate/{pkiEzsigntemplateID}",
"required": [
"objEzsigntemplate"
],
"type": "object",
"properties": {
"objEzsigntemplate": {
"$ref": "#/components/schemas/ezsigntemplate-ResponseCompound"
}
}
},
"ezsigntemplatedocument-Request": {
"description": "A Ezsigntemplatedocument Object",
"required": [
"fkiEzsigntemplateID",
"sEzsigntemplatedocumentName",
"eEzsigntemplatedocumentSource"
],
"type": "object",
"properties": {
"pkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"fkiEzsigndocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigndocumentID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"sEzsigntemplatedocumentName": {
"$ref": "#/components/schemas/Field-sEzsigntemplatedocumentName"
},
"eEzsigntemplatedocumentSource": {
"description": "Indicates where to look for the document binary content.",
"enum": [
"Base64",
"Url",
"Ezsigndocument"
],
"type": "string"
},
"eEzsigntemplatedocumentFormat": {
"description": "Indicates the format of the template.",
"enum": [
"Pdf",
"Doc",
"Docx",
"Xls",
"Xlsx",
"Ppt",
"Pptx"
],
"type": "string"
},
"sEzsigntemplatedocumentBase64": {
"format": "byte",
"description": "The Base64 encoded binary content of the document.\n\nThis field is Required when eEzsigntemplatedocumentSource = Base64.",
"type": "string",
"example": {
"$ref": "#/components/examples/PdfAsBase64/value"
}
},
"sEzsigntemplatedocumentUrl": {
"description": "The url where the document content resides.\n\nThis field is Required when eEzsigntemplatedocumentSource = Url.",
"type": "string",
"example": "http://www.example.com/template.pdf"
},
"bEzsigntemplatedocumentForcerepair": {
"description": "Try to repair the document or flatten it if it cannot be used for electronic signature.",
"type": "boolean"
},
"eEzsigntemplatedocumentForm": {
"description": "If the document contains an existing PDF form this property must be set.\r\n**Keep** leaves the form as-is in the document.\r\n**Convert** removes the form and convert all the existing fields to Ezsigntemplateformfieldgroups and assign them to the specified **fkiEzsigntemplatesignerID**",
"enum": [
"Keep",
"Convert"
],
"type": "string"
},
"sEzsigntemplatedocumentPassword": {
"description": "If the source template is password protected, the password to open/modify it.",
"default": "",
"type": "string",
"example": "SecretPassword123"
}
}
},
"ezsigntemplatedocument-RequestCompound": {
"description": "A Ezsigntemplatedocument Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatedocument-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplatedocument-RequestPatch": {
"description": "An Ezsigntemplatedocument Object",
"type": "object",
"properties": {
"sEzsigntemplatedocumentName": {
"$ref": "#/components/schemas/Field-sEzsigntemplatedocumentName"
}
}
},
"ezsigntemplatedocument-Response": {
"description": "A Ezsigntemplatedocument Object",
"required": [
"pkiEzsigntemplatedocumentID",
"fkiEzsigntemplateID",
"sEzsigntemplatedocumentName",
"iEzsigntemplatedocumentPagetotal",
"iEzsigntemplatedocumentSignaturetotal",
"bEzsigntemplatedocumentHassignedsignatures"
],
"type": "object",
"properties": {
"pkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"sEzsigntemplatedocumentName": {
"$ref": "#/components/schemas/Field-sEzsigntemplatedocumentName"
},
"iEzsigntemplatedocumentPagetotal": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentPagetotal"
},
"iEzsigntemplatedocumentSignaturetotal": {
"$ref": "#/components/schemas/Computed-iEzsigntemplateSignaturetotal"
},
"bEzsigntemplatedocumentHassignedsignatures": {
"$ref": "#/components/schemas/Field-bEzsigntemplatedocumentHassignedsignatures"
}
}
},
"ezsigntemplatedocument-ResponseCompound": {
"description": "A Ezsigntemplatedocument Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatedocument-Response"
},
{
"type": "object"
}
]
},
"ezsigntemplatedocument-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatedocument",
"required": [
"a_objEzsigntemplatedocument"
],
"type": "object",
"properties": {
"a_objEzsigntemplatedocument": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatedocument-RequestCompound"
}
}
}
},
"ezsigntemplatedocument-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatedocument",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatedocument",
"required": [
"a_pkiEzsigntemplatedocumentID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatedocumentID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
}
}
}
},
"ezsigntemplatedocument-editEzsigntemplateformfieldgroups-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups",
"required": [
"a_objEzsigntemplateformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsigntemplateformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-RequestCompound"
}
}
}
},
"ezsigntemplatedocument-editEzsigntemplateformfieldgroups-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editEzsigntemplateformfieldgroups-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-editEzsigntemplateformfieldgroups-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups",
"required": [
"a_pkiEzsigntemplateformfieldgroupID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplateformfieldgroupID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupID"
}
}
}
},
"ezsigntemplatedocument-editEzsigntemplatesignatures-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures",
"required": [
"a_objEzsigntemplatesignature"
],
"type": "object",
"properties": {
"a_objEzsigntemplatesignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesignature-RequestCompound"
}
}
}
},
"ezsigntemplatedocument-editEzsigntemplatesignatures-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-editEzsigntemplatesignatures-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-editEzsigntemplatesignatures-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures",
"required": [
"a_pkiEzsigntemplatesignatureID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatesignatureID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignatureID"
}
}
}
},
"ezsigntemplatedocument-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}",
"required": [
"objEzsigntemplatedocument"
],
"type": "object",
"properties": {
"objEzsigntemplatedocument": {
"$ref": "#/components/schemas/ezsigntemplatedocument-RequestCompound"
}
}
},
"ezsigntemplatedocument-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
},
{
"type": "object",
"properties": {
"a_objWarning": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Common-Response-Warning"
}
}
}
}
]
},
"ezsigntemplatedocument-flatten-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten\n\nIntentionally empty for future-proofing",
"type": "object"
},
"ezsigntemplatedocument-flatten-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/flatten",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-getEzsigntemplatedocumentpages-v1-Response": {
"description": "Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getEzsigntemplatedocumentpages-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-getEzsigntemplatedocumentpages-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages",
"required": [
"a_objEzsigntemplatedocumentpage"
],
"type": "object",
"properties": {
"a_objEzsigntemplatedocumentpage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatedocumentpage-ResponseCompound"
}
}
}
},
"ezsigntemplatedocument-getEzsigntemplateformfieldgroups-v1-Response": {
"description": "Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getEzsigntemplateformfieldgroups-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-getEzsigntemplateformfieldgroups-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplateformfieldgroups",
"required": [
"a_objEzsigntemplateformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsigntemplateformfieldgroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-ResponseCompound"
}
}
}
},
"ezsigntemplatedocument-getEzsigntemplatesignatures-v1-Response": {
"description": "Response for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getEzsigntemplatesignatures-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-getEzsigntemplatesignatures-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocument}/getEzsigntemplatesignatures",
"required": [
"a_objEzsigntemplatesignature"
],
"type": "object",
"properties": {
"a_objEzsigntemplatesignature": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesignature-ResponseCompound"
}
}
}
},
"ezsigntemplatedocument-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}",
"required": [
"objEzsigntemplatedocument"
],
"type": "object",
"properties": {
"objEzsigntemplatedocument": {
"$ref": "#/components/schemas/ezsigntemplatedocument-ResponseCompound"
}
}
},
"ezsigntemplatedocument-getWordsPositions-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions",
"required": [
"eSearchFor",
"eGet",
"bWordCaseSensitive"
],
"type": "object",
"properties": {
"eGet": {
"description": "Specify if you want to retrieve *All* words or specific *Words* from the document. If you specify *Words*, you must send the list of words to search for in *a_sWord*.",
"enum": [
"All",
"Words"
],
"type": "string"
},
"bWordCaseSensitive": {
"description": "IF *true*, words will be searched case-sensitive and results will be returned case-sensitive.\nIF *false*, words will be searched case-insensitive and results will be returned case-insensitive.",
"type": "boolean"
},
"a_sWord": {
"description": "Array of words to find in the document",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ezsigntemplatedocument-getWordsPositions-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatedocument-getWordsPositions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocument-getWordsPositions-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions",
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-WordPositionWord-Response"
}
},
"ezsigntemplatedocument-patchObject-v1-Request": {
"description": "Request for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}",
"required": [
"objEzsigntemplatedocument"
],
"type": "object",
"properties": {
"objEzsigntemplatedocument": {
"$ref": "#/components/schemas/ezsigntemplatedocument-RequestPatch"
}
}
},
"ezsigntemplatedocument-patchObject-v1-Response": {
"description": "Response for PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatedocumentpage-Response": {
"description": "An Ezsigntemplatedocumentpage Object",
"required": [
"pkiEzsigntemplatedocumentpageID",
"iEzsigntemplatedocumentpageWidthimage",
"iEzsigntemplatedocumentpageHeightimage",
"iEzsigntemplatedocumentpageWidthpdf",
"iEzsigntemplatedocumentpageHeightpdf",
"iEzsigntemplatedocumentpagePagenumber",
"sComputedImageurl"
],
"type": "object",
"properties": {
"pkiEzsigntemplatedocumentpageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentpageID"
},
"iEzsigntemplatedocumentpageWidthimage": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpageWidthimage"
},
"iEzsigntemplatedocumentpageHeightimage": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpageHeightimage"
},
"iEzsigntemplatedocumentpageWidthpdf": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpageWidthpdf"
},
"iEzsigntemplatedocumentpageHeightpdf": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpageHeightpdf"
},
"iEzsigntemplatedocumentpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpagePagenumber"
},
"sComputedImageurl": {
"description": "The Url to the Ezsigntemplatedocumentpage's rasterized image.\n\nUrl will expire after 5 minutes.",
"type": "string"
}
}
},
"ezsigntemplatedocumentpage-ResponseCompound": {
"description": "An Ezsigntemplatedocumentpage Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatedocumentpage-Response"
}
]
},
"ezsigntemplateformfield-Request": {
"description": "A Ezsigntemplateformfield Object",
"required": [
"iEzsigntemplatedocumentpagePagenumber",
"sEzsigntemplateformfieldLabel",
"iEzsigntemplateformfieldX",
"iEzsigntemplateformfieldY",
"iEzsigntemplateformfieldWidth",
"iEzsigntemplateformfieldHeight"
],
"type": "object",
"properties": {
"pkiEzsigntemplateformfieldID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldID"
},
"iEzsigntemplatedocumentpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpagePagenumber"
},
"sEzsigntemplateformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldLabel"
},
"sEzsigntemplateformfieldValue": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldValue"
},
"iEzsigntemplateformfieldX": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldX"
},
"iEzsigntemplateformfieldY": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldY"
},
"iEzsigntemplateformfieldWidth": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldWidth"
},
"iEzsigntemplateformfieldHeight": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldHeight"
},
"bEzsigntemplateformfieldSelected": {
"$ref": "#/components/schemas/Field-bEzsigntemplateformfieldSelected"
}
}
},
"ezsigntemplateformfield-RequestCompound": {
"description": "An Ezsigntemplateformfield Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplateformfield-Request"
}
]
},
"ezsigntemplateformfield-Response": {
"description": "An Ezsigntemplateformfield Object",
"required": [
"pkiEzsigntemplateformfieldID",
"iEzsigntemplatedocumentpagePagenumber",
"sEzsigntemplateformfieldLabel",
"iEzsigntemplateformfieldX",
"iEzsigntemplateformfieldY",
"iEzsigntemplateformfieldWidth",
"iEzsigntemplateformfieldHeight"
],
"type": "object",
"properties": {
"pkiEzsigntemplateformfieldID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldID"
},
"iEzsigntemplatedocumentpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpagePagenumber"
},
"sEzsigntemplateformfieldLabel": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldLabel"
},
"sEzsigntemplateformfieldValue": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldValue"
},
"iEzsigntemplateformfieldX": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldX"
},
"iEzsigntemplateformfieldY": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldY"
},
"iEzsigntemplateformfieldWidth": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldWidth"
},
"iEzsigntemplateformfieldHeight": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldHeight"
},
"bEzsigntemplateformfieldSelected": {
"$ref": "#/components/schemas/Field-bEzsigntemplateformfieldSelected"
}
}
},
"ezsigntemplateformfield-ResponseCompound": {
"description": "An Ezsigntemplateformfield Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplateformfield-Response"
}
]
},
"ezsigntemplateformfieldgroup-Request": {
"description": "A Ezsigntemplateformfieldgroup Object",
"required": [
"fkiEzsigntemplatedocumentID",
"eEzsigntemplateformfieldgroupType",
"eEzsigntemplateformfieldgroupSignerrequirement",
"sEzsigntemplateformfieldgroupLabel",
"iEzsigntemplateformfieldgroupStep",
"sEzsigntemplateformfieldgroupDefaultvalue",
"iEzsigntemplateformfieldgroupFilledmin",
"iEzsigntemplateformfieldgroupFilledmax",
"bEzsigntemplateformfieldgroupReadonly"
],
"type": "object",
"properties": {
"pkiEzsigntemplateformfieldgroupID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupID"
},
"fkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"eEzsigntemplateformfieldgroupType": {
"$ref": "#/components/schemas/Field-eEzsigntemplateformfieldgroupType"
},
"eEzsigntemplateformfieldgroupSignerrequirement": {
"$ref": "#/components/schemas/Field-eEzsigntemplateformfieldgroupSignerrequirement"
},
"sEzsigntemplateformfieldgroupLabel": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldgroupLabel"
},
"iEzsigntemplateformfieldgroupStep": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupStep"
},
"sEzsigntemplateformfieldgroupDefaultvalue": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldgroupDefaultvalue"
},
"iEzsigntemplateformfieldgroupFilledmin": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupFilledmin"
},
"iEzsigntemplateformfieldgroupFilledmax": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupFilledmax"
},
"bEzsigntemplateformfieldgroupReadonly": {
"$ref": "#/components/schemas/Field-bEzsigntemplateformfieldgroupReadonly"
},
"iEzsigntemplateformfieldgroupMaxlength": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupMaxlength"
},
"bEzsigntemplateformfieldgroupEncrypted": {
"$ref": "#/components/schemas/Field-bEzsigntemplateformfieldgroupEncrypted"
},
"sEzsigntemplateformfieldgroupRegexp": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldgroupRegexp"
},
"eEzsigntemplateformfieldgroupTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
},
"tEzsigntemplateformfieldgroupTooltip": {
"$ref": "#/components/schemas/Field-tEzsigntemplateformfieldgroupTooltip"
},
"eEzsigntemplateformfieldgroupTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsigntemplateformfieldgroupTooltipposition"
}
}
},
"ezsigntemplateformfieldgroup-RequestCompound": {
"description": "A Ezsigntemplateformfieldgroup Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-Request"
},
{
"required": [
"a_objEzsigntemplateformfieldgroupsigner",
"a_objEzsigntemplateformfield"
],
"type": "object",
"properties": {
"a_objEzsigntemplateformfieldgroupsigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroupsigner-RequestCompound"
}
},
"a_objDropdownElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-DropdownElement-RequestCompound"
}
},
"a_objEzsigntemplateformfield": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfield-RequestCompound"
}
}
}
}
]
},
"ezsigntemplateformfieldgroup-Response": {
"description": "A Ezsigntemplateformfieldgroup Object",
"required": [
"pkiEzsigntemplateformfieldgroupID",
"fkiEzsigntemplatedocumentID",
"eEzsigntemplateformfieldgroupType",
"eEzsigntemplateformfieldgroupSignerrequirement",
"sEzsigntemplateformfieldgroupLabel",
"iEzsigntemplateformfieldgroupStep",
"iEzsigntemplateformfieldgroupFilledmin",
"iEzsigntemplateformfieldgroupFilledmax",
"bEzsigntemplateformfieldgroupReadonly"
],
"type": "object",
"properties": {
"pkiEzsigntemplateformfieldgroupID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupID"
},
"fkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"eEzsigntemplateformfieldgroupType": {
"$ref": "#/components/schemas/Field-eEzsigntemplateformfieldgroupType"
},
"eEzsigntemplateformfieldgroupSignerrequirement": {
"$ref": "#/components/schemas/Field-eEzsigntemplateformfieldgroupSignerrequirement"
},
"sEzsigntemplateformfieldgroupLabel": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldgroupLabel"
},
"iEzsigntemplateformfieldgroupStep": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupStep"
},
"sEzsigntemplateformfieldgroupDefaultvalue": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldgroupDefaultvalue"
},
"iEzsigntemplateformfieldgroupFilledmin": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupFilledmin"
},
"iEzsigntemplateformfieldgroupFilledmax": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupFilledmax"
},
"bEzsigntemplateformfieldgroupReadonly": {
"$ref": "#/components/schemas/Field-bEzsigntemplateformfieldgroupReadonly"
},
"iEzsigntemplateformfieldgroupMaxlength": {
"$ref": "#/components/schemas/Field-iEzsigntemplateformfieldgroupMaxlength"
},
"bEzsigntemplateformfieldgroupEncrypted": {
"$ref": "#/components/schemas/Field-bEzsigntemplateformfieldgroupEncrypted"
},
"sEzsigntemplateformfieldgroupRegexp": {
"$ref": "#/components/schemas/Field-sEzsigntemplateformfieldgroupRegexp"
},
"eEzsigntemplateformfieldgroupTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
},
"tEzsigntemplateformfieldgroupTooltip": {
"$ref": "#/components/schemas/Field-tEzsigntemplateformfieldgroupTooltip"
},
"eEzsigntemplateformfieldgroupTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsigntemplateformfieldgroupTooltipposition"
}
}
},
"ezsigntemplateformfieldgroup-ResponseCompound": {
"description": "A Ezsigntemplateformfieldgroup Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-Response"
},
{
"required": [
"a_objEzsigntemplateformfieldgroupsigner",
"a_objEzsigntemplateformfield"
],
"type": "object",
"properties": {
"a_objEzsigntemplateformfieldgroupsigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroupsigner-ResponseCompound"
}
},
"a_objDropdownElement": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-DropdownElement-ResponseCompound"
}
},
"a_objEzsigntemplateformfield": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfield-ResponseCompound"
}
}
}
}
]
},
"ezsigntemplateformfieldgroup-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplateformfieldgroup",
"required": [
"a_objEzsigntemplateformfieldgroup"
],
"type": "object",
"properties": {
"a_objEzsigntemplateformfieldgroup": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-RequestCompound"
}
}
}
},
"ezsigntemplateformfieldgroup-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplateformfieldgroup",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplateformfieldgroup-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplateformfieldgroup",
"required": [
"a_pkiEzsigntemplateformfieldgroupID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplateformfieldgroupID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupID"
}
}
}
},
"ezsigntemplateformfieldgroup-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplateformfieldgroup-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}",
"required": [
"objEzsigntemplateformfieldgroup"
],
"type": "object",
"properties": {
"objEzsigntemplateformfieldgroup": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-RequestCompound"
}
}
},
"ezsigntemplateformfieldgroup-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplateformfieldgroup-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplateformfieldgroup-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}",
"required": [
"objEzsigntemplateformfieldgroup"
],
"type": "object",
"properties": {
"objEzsigntemplateformfieldgroup": {
"$ref": "#/components/schemas/ezsigntemplateformfieldgroup-ResponseCompound"
}
}
},
"ezsigntemplateformfieldgroupsigner-Request": {
"description": "A Ezsigntemplateformfieldgroupsigner Object",
"required": [
"fkiEzsigntemplatesignerID"
],
"type": "object",
"properties": {
"pkiEzsigntemplateformfieldgroupsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupsignerID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
}
}
},
"ezsigntemplateformfieldgroupsigner-RequestCompound": {
"description": "An Ezsigntemplateformfieldgroupsigner Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplateformfieldgroupsigner-Request"
}
]
},
"ezsigntemplateformfieldgroupsigner-Response": {
"description": "A Ezsigntemplateformfieldgroupsigner Object",
"required": [
"pkiEzsigntemplateformfieldgroupsignerID",
"fkiEzsigntemplatesignerID"
],
"type": "object",
"properties": {
"pkiEzsigntemplateformfieldgroupsignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateformfieldgroupsignerID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
}
}
},
"ezsigntemplateformfieldgroupsigner-ResponseCompound": {
"description": "An Ezsigntemplateformfieldgroupsigner Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplateformfieldgroupsigner-Response"
}
]
},
"ezsigntemplatepackage-AutocompleteElement-Response": {
"description": "A Ezsigntemplatepackage AutocompleteElement Response",
"required": [
"eEzsignfoldertypePrivacylevel",
"sEzsigntemplatepackageDescription",
"pkiEzsigntemplatepackageID",
"bEzsigntemplatepackageIsactive",
"bDisabled"
],
"type": "object",
"properties": {
"eEzsignfoldertypePrivacylevel": {
"$ref": "#/components/schemas/Field-eEzsignfoldertypePrivacylevel"
},
"sEzsigntemplatepackageDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackageDescription"
},
"pkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"bEzsigntemplatepackageIsactive": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageIsactive"
},
"bDisabled": {
"description": "Indicates if the element is disabled in the context",
"type": "boolean"
}
}
},
"ezsigntemplatepackage-ListElement": {
"description": "An Ezsigntemplatepackage List Element",
"required": [
"pkiEzsigntemplatepackageID",
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sEzsigntemplatepackageDescription",
"bEzsigntemplatepackageNeedvalidation",
"iEzsigntemplatepackagemembership",
"sEzsignfoldertypeNameX",
"bEzsigntemplatepackageIsactive"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEzsigntemplatepackageDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackageDescription"
},
"bEzsigntemplatepackageNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageNeedvalidation"
},
"iEzsigntemplatepackagemembership": {
"description": "The total number of Ezsigntemplatepackagemembership in the Ezsigntemplatepackage",
"type": "integer"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"bEzsigntemplatepackageIsactive": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageIsactive"
}
}
},
"ezsigntemplatepackage-Request": {
"description": "A Ezsigntemplatepackage Object",
"required": [
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sEzsigntemplatepackageDescription",
"bEzsigntemplatepackageAdminonly",
"bEzsigntemplatepackageIsactive"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sEzsigntemplatepackageDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackageDescription"
},
"bEzsigntemplatepackageAdminonly": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageAdminonly"
},
"bEzsigntemplatepackageIsactive": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageIsactive"
}
}
},
"ezsigntemplatepackage-RequestCompound": {
"description": "A Ezsigntemplatepackage Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackage-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplatepackage-Response": {
"description": "A Ezsigntemplatepackage Object",
"required": [
"pkiEzsigntemplatepackageID",
"fkiEzsignfoldertypeID",
"fkiLanguageID",
"sLanguageNameX",
"sEzsigntemplatepackageDescription",
"bEzsigntemplatepackageAdminonly",
"bEzsigntemplatepackageNeedvalidation",
"bEzsigntemplatepackageIsactive",
"sEzsignfoldertypeNameX"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sLanguageNameX": {
"$ref": "#/components/schemas/Field-sLanguageNameX"
},
"sEzsigntemplatepackageDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackageDescription"
},
"bEzsigntemplatepackageAdminonly": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageAdminonly"
},
"bEzsigntemplatepackageNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageNeedvalidation"
},
"bEzsigntemplatepackageIsactive": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageIsactive"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
}
}
},
"ezsigntemplatepackage-ResponseCompound": {
"description": "A Ezsigntemplatepackage Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackage-Response"
},
{
"required": [
"a_objEzsigntemplatepackagesigner",
"a_objEzsigntemplatepackagemembership"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackagesigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-ResponseCompound"
}
},
"a_objEzsigntemplatepackagemembership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-ResponseCompound"
}
}
}
}
]
},
"ezsigntemplatepackage-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatepackage",
"required": [
"a_objEzsigntemplatepackage"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackage": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackage-RequestCompound"
}
}
}
},
"ezsigntemplatepackage-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatepackage",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackage-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackage-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatepackage",
"required": [
"a_pkiEzsigntemplatepackageID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatepackageID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
}
}
}
},
"ezsigntemplatepackage-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners",
"required": [
"a_objEzsigntemplatepackagesigner"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackagesigner": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-RequestCompound"
}
}
}
},
"ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackage-editEzsigntemplatepackagesigners-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners",
"required": [
"a_pkiEzsigntemplatepackagesignerID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatepackagesignerID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
}
}
}
},
"ezsigntemplatepackage-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}",
"required": [
"objEzsigntemplatepackage"
],
"type": "object",
"properties": {
"objEzsigntemplatepackage": {
"$ref": "#/components/schemas/ezsigntemplatepackage-RequestCompound"
}
}
},
"ezsigntemplatepackage-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackage-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatepackage/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackage-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackage-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsigntemplatepackage/getAutocomplete",
"required": [
"a_objEzsigntemplatepackage"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackage": {
"description": "An array of Ezsigntemplatepackage autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackage-AutocompleteElement-Response"
}
}
}
},
"ezsigntemplatepackage-getList-v1-Response": {
"description": "Response for GET /1/object/ezsigntemplatepackage/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackage-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"ezsigntemplatepackage-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/ezsigntemplatepackage/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objEzsigntemplatepackage"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackage-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"ezsigntemplatepackage-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackage-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackage-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}",
"required": [
"objEzsigntemplatepackage"
],
"type": "object",
"properties": {
"objEzsigntemplatepackage": {
"$ref": "#/components/schemas/ezsigntemplatepackage-ResponseCompound"
}
}
},
"ezsigntemplatepackagemembership-Request": {
"description": "A Ezsigntemplatepackagemembership Object",
"required": [
"fkiEzsigntemplatepackageID",
"fkiEzsigntemplateID"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackagemembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
},
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
}
}
},
"ezsigntemplatepackagemembership-RequestCompound": {
"description": "A Ezsigntemplatepackagemembership Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplatepackagemembership-Response": {
"description": "A Ezsigntemplatepackagemembership Object",
"required": [
"pkiEzsigntemplatepackagemembershipID",
"fkiEzsigntemplatepackageID",
"fkiEzsigntemplateID",
"iEzsigntemplatepackagemembershipOrder"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackagemembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
},
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"iEzsigntemplatepackagemembershipOrder": {
"$ref": "#/components/schemas/Field-iEzsigntemplatepackagemembershipOrder"
}
}
},
"ezsigntemplatepackagemembership-ResponseCompound": {
"description": "A Ezsigntemplatepackagemembership Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-Response"
},
{
"required": [
"objEzsigntemplate",
"a_objEzsigntemplatepackagesignermembership"
],
"type": "object",
"properties": {
"objEzsigntemplate": {
"$ref": "#/components/schemas/ezsigntemplate-ResponseCompound"
},
"a_objEzsigntemplatepackagesignermembership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-ResponseCompound"
}
}
}
}
]
},
"ezsigntemplatepackagemembership-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatepackagemembership",
"required": [
"a_objEzsigntemplatepackagemembership"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackagemembership": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-RequestCompound"
}
}
}
},
"ezsigntemplatepackagemembership-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatepackagemembership",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagemembership-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatepackagemembership",
"required": [
"a_pkiEzsigntemplatepackagemembershipID",
"bEzsigntemplatepackageNeedvalidation",
"bEzsignbulksendNeedvalidation"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatepackagemembershipID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
}
},
"bEzsigntemplatepackageNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageNeedvalidation"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
}
}
},
"ezsigntemplatepackagemembership-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagemembership-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagemembership-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}",
"required": [
"objEzsigntemplatepackagemembership"
],
"type": "object",
"properties": {
"objEzsigntemplatepackagemembership": {
"$ref": "#/components/schemas/ezsigntemplatepackagemembership-ResponseCompound"
}
}
},
"ezsigntemplatepackagesigner-Request": {
"description": "A Ezsigntemplatepackagesigner Object",
"required": [
"fkiEzsigntemplatepackageID",
"sEzsigntemplatepackagesignerDescription"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackagesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"sEzsigntemplatepackagesignerDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackagesignerDescription"
}
}
},
"ezsigntemplatepackagesigner-RequestCompound": {
"description": "A Ezsigntemplatepackagesigner Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplatepackagesigner-Response": {
"description": "A Ezsigntemplatepackagesigner Object",
"required": [
"pkiEzsigntemplatepackagesignerID",
"fkiEzsigntemplatepackageID",
"sEzsigntemplatepackagesignerDescription"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackagesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"fkiEzsigntemplatepackageID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackageID"
},
"sEzsigntemplatepackagesignerDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatepackagesignerDescription"
}
}
},
"ezsigntemplatepackagesigner-ResponseCompound": {
"description": "A Ezsigntemplatepackagesigner Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-Response"
},
{
"type": "object"
}
]
},
"ezsigntemplatepackagesigner-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatepackagesigner",
"required": [
"a_objEzsigntemplatepackagesigner"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackagesigner": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-RequestCompound"
}
}
}
},
"ezsigntemplatepackagesigner-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatepackagesigner",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesigner-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatepackagesigner",
"required": [
"a_pkiEzsigntemplatepackagesignerID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatepackagesignerID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
}
}
}
},
"ezsigntemplatepackagesigner-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-deleteObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesigner-deleteObject-v1-Response-mPayload": {
"description": "Payload for DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}",
"required": [
"bEzsigntemplatepackageNeedvalidation",
"bEzsignbulksendNeedvalidation"
],
"type": "object",
"properties": {
"bEzsigntemplatepackageNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageNeedvalidation"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
}
}
},
"ezsigntemplatepackagesigner-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}",
"required": [
"objEzsigntemplatepackagesigner"
],
"type": "object",
"properties": {
"objEzsigntemplatepackagesigner": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-RequestCompound"
}
}
},
"ezsigntemplatepackagesigner-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesigner-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesigner-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}",
"required": [
"objEzsigntemplatepackagesigner"
],
"type": "object",
"properties": {
"objEzsigntemplatepackagesigner": {
"$ref": "#/components/schemas/ezsigntemplatepackagesigner-ResponseCompound"
}
}
},
"ezsigntemplatepackagesignermembership-Request": {
"description": "A Ezsigntemplatepackagesignermembership Object",
"required": [
"fkiEzsigntemplatepackagemembershipID",
"fkiEzsigntemplatepackagesignerID",
"fkiEzsigntemplatesignerID"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackagesignermembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignermembershipID"
},
"fkiEzsigntemplatepackagemembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
},
"fkiEzsigntemplatepackagesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"iEzsigntemplatepackagesignermembershipCopy": {
"$ref": "#/components/schemas/Field-iEzsigntemplatepackagesignermembershipCopy"
}
}
},
"ezsigntemplatepackagesignermembership-RequestCompound": {
"description": "A Ezsigntemplatepackagesignermembership Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplatepackagesignermembership-Response": {
"description": "A Ezsigntemplatepackagesignermembership Object",
"required": [
"pkiEzsigntemplatepackagesignermembershipID",
"fkiEzsigntemplatepackagemembershipID",
"fkiEzsigntemplatepackagesignerID",
"fkiEzsigntemplatesignerID"
],
"type": "object",
"properties": {
"pkiEzsigntemplatepackagesignermembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignermembershipID"
},
"fkiEzsigntemplatepackagemembershipID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagemembershipID"
},
"fkiEzsigntemplatepackagesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignerID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"iEzsigntemplatepackagesignermembershipCopy": {
"$ref": "#/components/schemas/Field-iEzsigntemplatepackagesignermembershipCopy"
}
}
},
"ezsigntemplatepackagesignermembership-ResponseCompound": {
"description": "A Ezsigntemplatepackagesignermembership Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-Response"
},
{
"type": "object"
}
]
},
"ezsigntemplatepackagesignermembership-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatepackagesignermembership",
"required": [
"a_objEzsigntemplatepackagesignermembership"
],
"type": "object",
"properties": {
"a_objEzsigntemplatepackagesignermembership": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-RequestCompound"
}
}
}
},
"ezsigntemplatepackagesignermembership-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatepackagesignermembership",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesignermembership-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatepackagesignermembership",
"required": [
"a_pkiEzsigntemplatepackagesignermembershipID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatepackagesignermembershipID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatepackagesignermembershipID"
}
}
}
},
"ezsigntemplatepackagesignermembership-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-deleteObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesignermembership-deleteObject-v1-Response-mPayload": {
"description": "Payload for DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}",
"required": [
"bEzsigntemplatepackageNeedvalidation",
"bEzsignbulksendNeedvalidation"
],
"type": "object",
"properties": {
"bEzsigntemplatepackageNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageNeedvalidation"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
}
}
},
"ezsigntemplatepackagesignermembership-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatepackagesignermembership-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}",
"required": [
"objEzsigntemplatepackagesignermembership"
],
"type": "object",
"properties": {
"objEzsigntemplatepackagesignermembership": {
"$ref": "#/components/schemas/ezsigntemplatepackagesignermembership-ResponseCompound"
}
}
},
"ezsigntemplatesignature-Request": {
"description": "A Ezsigntemplatesignature Object",
"required": [
"fkiEzsigntemplatedocumentID",
"fkiEzsigntemplatesignerID",
"iEzsigntemplatedocumentpagePagenumber",
"iEzsigntemplatesignatureX",
"iEzsigntemplatesignatureY",
"iEzsigntemplatesignatureStep",
"eEzsigntemplatesignatureType"
],
"type": "object",
"properties": {
"pkiEzsigntemplatesignatureID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignatureID"
},
"fkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"fkiEzsigntemplatesignerIDValidation": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"iEzsigntemplatedocumentpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpagePagenumber"
},
"iEzsigntemplatesignatureX": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureX"
},
"iEzsigntemplatesignatureY": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureY"
},
"iEzsigntemplatesignatureWidth": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureWidth"
},
"iEzsigntemplatesignatureHeight": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureHeight"
},
"iEzsigntemplatesignatureStep": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureStep"
},
"eEzsigntemplatesignatureType": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureType"
},
"tEzsigntemplatesignatureTooltip": {
"$ref": "#/components/schemas/Field-tEzsigntemplatesignatureTooltip"
},
"eEzsigntemplatesignatureTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureTooltipposition"
},
"eEzsigntemplatesignatureFont": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureFont"
},
"bEzsigntemplatesignatureRequired": {
"$ref": "#/components/schemas/Field-bEzsigntemplatesignatureRequired"
},
"eEzsigntemplatesignatureAttachmentnamesource": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureAttachmentnamesource"
},
"sEzsigntemplatesignatureAttachmentdescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesignatureAttachmentdescription"
},
"iEzsigntemplatesignatureValidationstep": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureValidationstep"
},
"iEzsigntemplatesignatureMaxlength": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureMaxlength"
},
"sEzsigntemplatesignatureRegexp": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesignatureRegexp"
},
"eEzsigntemplatesignatureTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
}
}
},
"ezsigntemplatesignature-RequestCompound": {
"description": "A Ezsigntemplatesignature Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatesignature-Request"
},
{
"type": "object",
"properties": {
"bEzsigntemplatesignatureCustomdate": {
"$ref": "#/components/schemas/Field-bEzsigntemplatesignatureCustomdate"
},
"a_objEzsigntemplatesignaturecustomdate": {
"description": "An array of custom date blocks that will be filled at the time of signature.\n\nCan only be used if bEzsigntemplatesignatureCustomdate is true.\n\nUse an empty array if you don't want to have a date at all.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesignaturecustomdate-RequestCompound"
}
}
}
}
]
},
"ezsigntemplatesignature-Response": {
"description": "A Ezsigntemplatesignature Object",
"required": [
"pkiEzsigntemplatesignatureID",
"fkiEzsigntemplatedocumentID",
"fkiEzsigntemplatesignerID",
"iEzsigntemplatedocumentpagePagenumber",
"iEzsigntemplatesignatureX",
"iEzsigntemplatesignatureY",
"iEzsigntemplatesignatureStep",
"eEzsigntemplatesignatureType"
],
"type": "object",
"properties": {
"pkiEzsigntemplatesignatureID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignatureID"
},
"fkiEzsigntemplatedocumentID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatedocumentID"
},
"fkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"fkiEzsigntemplatesignerIDValidation": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"iEzsigntemplatedocumentpagePagenumber": {
"$ref": "#/components/schemas/Field-iEzsigntemplatedocumentpagePagenumber"
},
"iEzsigntemplatesignatureX": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureX"
},
"iEzsigntemplatesignatureY": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureY"
},
"iEzsigntemplatesignatureWidth": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureWidth"
},
"iEzsigntemplatesignatureHeight": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureHeight"
},
"iEzsigntemplatesignatureStep": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureStep"
},
"eEzsigntemplatesignatureType": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureType"
},
"tEzsigntemplatesignatureTooltip": {
"$ref": "#/components/schemas/Field-tEzsigntemplatesignatureTooltip"
},
"eEzsigntemplatesignatureTooltipposition": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureTooltipposition"
},
"eEzsigntemplatesignatureFont": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureFont"
},
"iEzsigntemplatesignatureValidationstep": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureValidationstep"
},
"sEzsigntemplatesignatureAttachmentdescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesignatureAttachmentdescription"
},
"eEzsigntemplatesignatureAttachmentnamesource": {
"$ref": "#/components/schemas/Field-eEzsigntemplatesignatureAttachmentnamesource"
},
"bEzsigntemplatesignatureRequired": {
"$ref": "#/components/schemas/Field-bEzsigntemplatesignatureRequired"
},
"iEzsigntemplatesignatureMaxlength": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignatureMaxlength"
},
"sEzsigntemplatesignatureRegexp": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesignatureRegexp"
},
"eEzsigntemplatesignatureTextvalidation": {
"$ref": "#/components/schemas/Enum-Textvalidation"
}
}
},
"ezsigntemplatesignature-ResponseCompound": {
"description": "A Ezsigntemplatesignature Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatesignature-Response"
},
{
"type": "object",
"properties": {
"bEzsigntemplatesignatureCustomdate": {
"$ref": "#/components/schemas/Field-bEzsigntemplatesignatureCustomdate"
},
"a_objEzsigntemplatesignaturecustomdate": {
"description": "An array of custom date blocks that will be filled at the time of signature.\n\nCan only be used if bEzsigntemplatesignatureCustomdate is true.\n\nUse an empty array if you don't want to have a date at all.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesignaturecustomdate-ResponseCompound"
}
}
}
}
]
},
"ezsigntemplatesignature-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatesignature",
"required": [
"a_objEzsigntemplatesignature"
],
"type": "object",
"properties": {
"a_objEzsigntemplatesignature": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesignature-RequestCompound"
}
}
}
},
"ezsigntemplatesignature-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatesignature",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatesignature-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesignature-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatesignature",
"required": [
"a_pkiEzsigntemplatesignatureID"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatesignatureID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignatureID"
}
}
}
},
"ezsigntemplatesignature-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesignature-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}",
"required": [
"objEzsigntemplatesignature"
],
"type": "object",
"properties": {
"objEzsigntemplatesignature": {
"$ref": "#/components/schemas/ezsigntemplatesignature-RequestCompound"
}
}
},
"ezsigntemplatesignature-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesignature-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatesignature-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesignature-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}",
"required": [
"objEzsigntemplatesignature"
],
"type": "object",
"properties": {
"objEzsigntemplatesignature": {
"$ref": "#/components/schemas/ezsigntemplatesignature-ResponseCompound"
}
}
},
"ezsigntemplatesignaturecustomdate-Request": {
"description": "An Ezsigntemplatesignaturecustomdate Object",
"required": [
"iEzsigntemplatesignaturecustomdateX",
"iEzsigntemplatesignaturecustomdateY",
"sEzsigntemplatesignaturecustomdateFormat"
],
"type": "object",
"properties": {
"pkiEzsigntemplatesignaturecustomdateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignaturecustomdateID"
},
"iEzsigntemplatesignaturecustomdateX": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignaturecustomdateX"
},
"iEzsigntemplatesignaturecustomdateY": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignaturecustomdateY"
},
"sEzsigntemplatesignaturecustomdateFormat": {
"$ref": "#/components/schemas/Common-Format-CustomDateFormat"
}
}
},
"ezsigntemplatesignaturecustomdate-RequestCompound": {
"description": "An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatesignaturecustomdate-Request"
}
]
},
"ezsigntemplatesignaturecustomdate-Response": {
"description": "An Ezsigntemplatesignaturecustomdate Object",
"required": [
"pkiEzsigntemplatesignaturecustomdateID",
"iEzsigntemplatesignaturecustomdateX",
"iEzsigntemplatesignaturecustomdateY",
"sEzsigntemplatesignaturecustomdateFormat"
],
"type": "object",
"properties": {
"pkiEzsigntemplatesignaturecustomdateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignaturecustomdateID"
},
"iEzsigntemplatesignaturecustomdateX": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignaturecustomdateX"
},
"iEzsigntemplatesignaturecustomdateY": {
"$ref": "#/components/schemas/Field-iEzsigntemplatesignaturecustomdateY"
},
"sEzsigntemplatesignaturecustomdateFormat": {
"$ref": "#/components/schemas/Common-Format-CustomDateFormat"
}
}
},
"ezsigntemplatesignaturecustomdate-ResponseCompound": {
"description": "An Ezsigntemplatesignaturecustomdate Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatesignaturecustomdate-Response"
}
]
},
"ezsigntemplatesigner-Request": {
"description": "A Ezsigntemplatesigner Object",
"required": [
"fkiEzsigntemplateID",
"sEzsigntemplatesignerDescription"
],
"type": "object",
"properties": {
"pkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"sEzsigntemplatesignerDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesignerDescription"
}
}
},
"ezsigntemplatesigner-RequestCompound": {
"description": "A Ezsigntemplatesigner Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatesigner-Request"
},
{
"type": "object"
}
]
},
"ezsigntemplatesigner-Response": {
"description": "A Ezsigntemplatesigner Object",
"required": [
"pkiEzsigntemplatesignerID",
"fkiEzsigntemplateID",
"sEzsigntemplatesignerDescription"
],
"type": "object",
"properties": {
"pkiEzsigntemplatesignerID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
},
"fkiEzsigntemplateID": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplateID"
},
"sEzsigntemplatesignerDescription": {
"$ref": "#/components/schemas/Field-sEzsigntemplatesignerDescription"
}
}
},
"ezsigntemplatesigner-ResponseCompound": {
"description": "A Ezsigntemplatesigner Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ezsigntemplatesigner-Response"
},
{
"type": "object"
}
]
},
"ezsigntemplatesigner-createObject-v1-Request": {
"description": "Request for POST /1/object/ezsigntemplatesigner",
"required": [
"a_objEzsigntemplatesigner"
],
"type": "object",
"properties": {
"a_objEzsigntemplatesigner": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntemplatesigner-RequestCompound"
}
}
}
},
"ezsigntemplatesigner-createObject-v1-Response": {
"description": "Response for POST /1/object/ezsigntemplatesigner",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatesigner-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesigner-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/ezsigntemplatesigner",
"required": [
"a_pkiEzsigntemplatesignerID",
"bEzsigntemplatepackageNeedvalidation",
"bEzsignbulksendNeedvalidation"
],
"type": "object",
"properties": {
"a_pkiEzsigntemplatesignerID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiEzsigntemplatesignerID"
}
},
"bEzsigntemplatepackageNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsigntemplatepackageNeedvalidation"
},
"bEzsignbulksendNeedvalidation": {
"$ref": "#/components/schemas/Field-bEzsignbulksendNeedvalidation"
}
}
},
"ezsigntemplatesigner-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}",
"type": "object",
"allOf": [
{
"type": "object"
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesigner-editObject-v1-Request": {
"description": "Request for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}",
"required": [
"objEzsigntemplatesigner"
],
"type": "object",
"properties": {
"objEzsigntemplatesigner": {
"$ref": "#/components/schemas/ezsigntemplatesigner-RequestCompound"
}
}
},
"ezsigntemplatesigner-editObject-v1-Response": {
"description": "Response for PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}",
"type": "object",
"allOf": [
{
"type": "object"
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesigner-getObject-v2-Response": {
"description": "Response for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntemplatesigner-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntemplatesigner-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}",
"required": [
"objEzsigntemplatesigner"
],
"type": "object",
"properties": {
"objEzsigntemplatesigner": {
"$ref": "#/components/schemas/ezsigntemplatesigner-ResponseCompound"
}
}
},
"ezsigntsarequirement-AutocompleteElement-Response": {
"description": "A Ezsigntsarequirement AutocompleteElement Response",
"required": [
"sEzsigntsarequirementDescriptionX",
"pkiEzsigntsarequirementID",
"bEzsigntsarequirementIsactive",
"bDisabled"
],
"type": "object",
"properties": {
"sEzsigntsarequirementDescriptionX": {
"$ref": "#/components/schemas/Field-sEzsigntsarequirementDescriptionX"
},
"pkiEzsigntsarequirementID": {
"$ref": "#/components/schemas/Field-pkiEzsigntsarequirementID"
},
"bEzsigntsarequirementIsactive": {
"$ref": "#/components/schemas/Field-bEzsigntsarequirementIsactive"
},
"bDisabled": {
"description": "Indicates if the element is disabled in the context",
"type": "boolean"
}
}
},
"ezsigntsarequirement-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/ezsigntsarequirement/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/ezsigntsarequirement-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"ezsigntsarequirement-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/ezsigntsarequirement/getAutocomplete",
"required": [
"a_objEzsigntsarequirement"
],
"type": "object",
"properties": {
"a_objEzsigntsarequirement": {
"description": "An array of Ezsigntsarequirement autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ezsigntsarequirement-AutocompleteElement-Response"
}
}
}
},
"font-AutocompleteElement-Response": {
"description": "A Font AutocompleteElement Response",
"required": [
"sFontName",
"pkiFontID",
"bFontIsactive"
],
"type": "object",
"properties": {
"sFontName": {
"$ref": "#/components/schemas/Field-sFontName"
},
"pkiFontID": {
"$ref": "#/components/schemas/Field-pkiFontID"
},
"bFontIsactive": {
"$ref": "#/components/schemas/Field-bFontIsactive"
}
}
},
"font-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/font/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/font-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"font-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/font/getAutocomplete",
"required": [
"a_objfont"
],
"type": "object",
"properties": {
"a_objFont": {
"description": "An array of Font autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/font-AutocompleteElement-Response"
}
}
}
},
"franchisebroker-AutocompleteElement-Response": {
"description": "A Franchisebroker AutocompleteElement Response",
"required": [
"sFranchisebrokerName",
"pkiFranchisebrokerID",
"bFranchisebrokerIsactive"
],
"type": "object",
"properties": {
"sFranchisebrokerName": {
"$ref": "#/components/schemas/Field-sFranchisebrokerName"
},
"pkiFranchisebrokerID": {
"$ref": "#/components/schemas/Field-pkiFranchisebrokerID"
},
"bFranchisebrokerIsactive": {
"$ref": "#/components/schemas/Field-bFranchisebrokerIsactive"
}
}
},
"franchisebroker-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/franchisebroker/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/franchisebroker-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"franchisebroker-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/franchisebroker/getAutocomplete",
"required": [
"a_objfranchisebroker"
],
"type": "object",
"properties": {
"a_objFranchisebroker": {
"description": "An array of Franchisebroker autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/franchisebroker-AutocompleteElement-Response"
}
}
}
},
"franchiseoffice-AutocompleteElement-Response": {
"description": "A Franchiseoffice AutocompleteElement Response",
"required": [
"sFranchiseofficeDescription",
"pkiFranchiseofficeID",
"bFranchiseofficeIsactive"
],
"type": "object",
"properties": {
"sFranchiseofficeDescription": {
"$ref": "#/components/schemas/Field-sFranchiseofficeDescription"
},
"pkiFranchiseofficeID": {
"$ref": "#/components/schemas/Field-pkiFranchiseofficeID"
},
"bFranchiseofficeIsactive": {
"$ref": "#/components/schemas/Field-bFranchiseofficeIsactive"
}
}
},
"franchiseoffice-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/franchiseoffice/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/franchiseoffice-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"franchiseoffice-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/franchiseoffice/getAutocomplete",
"required": [
"a_objfranchiseoffice"
],
"type": "object",
"properties": {
"a_objFranchiseoffice": {
"description": "An array of Franchiseoffice autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/franchiseoffice-AutocompleteElement-Response"
}
}
}
},
"franchisereferalincome-Request": {
"description": "An Franchisereferalincome Object",
"required": [
"fkiFranchisebrokerID",
"fkiFranchisereferalincomeprogramID",
"fkiPeriodID",
"dFranchisereferalincomeLoan",
"dFranchisereferalincomeFranchiseamount",
"dFranchisereferalincomeFranchisoramount",
"dFranchisereferalincomeAgentamount",
"dtFranchisereferalincomeDisbursed",
"tFranchisereferalincomeComment",
"objAddress",
"fkiFranchiseofficeID",
"sFranchisereferalincomeRemoteid"
],
"type": "object",
"properties": {
"pkiFranchisereferalincomeID": {
"$ref": "#/components/schemas/Field-pkiFranchisereferalincomeID"
},
"fkiFranchisebrokerID": {
"$ref": "#/components/schemas/Field-pkiFranchisebrokerID"
},
"fkiFranchisereferalincomeprogramID": {
"$ref": "#/components/schemas/Field-pkiFranchisereferalincomeprogramID"
},
"fkiPeriodID": {
"$ref": "#/components/schemas/Field-pkiPeriodID"
},
"dFranchisereferalincomeLoan": {
"$ref": "#/components/schemas/Field-dFranchisereferalincomeLoan"
},
"dFranchisereferalincomeFranchiseamount": {
"$ref": "#/components/schemas/Field-dFranchisereferalincomeFranchiseamount"
},
"dFranchisereferalincomeFranchisoramount": {
"$ref": "#/components/schemas/Field-dFranchisereferalincomeFranchisoramount"
},
"dFranchisereferalincomeAgentamount": {
"$ref": "#/components/schemas/Field-dFranchisereferalincomeAgentamount"
},
"dtFranchisereferalincomeDisbursed": {
"$ref": "#/components/schemas/Field-dtFranchisereferalincomeDisbursed"
},
"tFranchisereferalincomeComment": {
"$ref": "#/components/schemas/Field-tFranchisereferalincomeComment"
},
"fkiFranchiseofficeID": {
"$ref": "#/components/schemas/Field-pkiFranchiseofficeID"
},
"sFranchisereferalincomeRemoteid": {
"description": "",
"type": "string"
}
}
},
"franchisereferalincome-RequestCompound": {
"description": "A Franchisereferalincome Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/franchisereferalincome-Request"
},
{
"required": [
"a_objContact"
],
"type": "object",
"properties": {
"objAddress": {
"$ref": "#/components/schemas/address-Request"
},
"a_objContact": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact-RequestCompound"
}
}
}
}
]
},
"franchisereferalincome-createObject-v1-Request": {
"description": "Request for POST /1/object/franchisereferalincome",
"type": "object",
"properties": {
"objFranchisereferalincome": {
"$ref": "#/components/schemas/franchisereferalincome-Request"
},
"objFranchisereferalincomeCompound": {
"$ref": "#/components/schemas/franchisereferalincome-RequestCompound"
}
}
},
"franchisereferalincome-createObject-v1-Response": {
"description": "Response for POST /1/object/franchisereferalincome",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/franchisereferalincome-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"franchisereferalincome-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/franchisereferalincome",
"required": [
"a_pkiFranchisereferalincomeID"
],
"type": "object",
"properties": {
"a_pkiFranchisereferalincomeID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiFranchisereferalincomeID"
}
}
}
},
"franchisereferalincome-createObject-v2-Request": {
"description": "Request for POST /2/object/franchisereferalincome",
"required": [
"a_objFranchisereferalincome"
],
"type": "object",
"properties": {
"a_objFranchisereferalincome": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/franchisereferalincome-RequestCompound"
}
}
}
},
"franchisereferalincome-createObject-v2-Response": {
"description": "Response for POST /2/object/franchisereferalincome",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/franchisereferalincome-createObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"franchisereferalincome-createObject-v2-Response-mPayload": {
"description": "Payload for POST /2/object/franchisereferalincome",
"required": [
"a_pkiFranchisereferalincomeID"
],
"type": "object",
"properties": {
"a_pkiFranchisereferalincomeID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiFranchisereferalincomeID"
}
}
}
},
"global-customer-getEndpoint-v1-Response": {
"description": "Response for GET /1/customer/{pksCustomerCode}/endpoint",
"required": [
"sEndpointURL"
],
"type": "object",
"properties": {
"sEndpointURL": {
"description": "The endpoint's URL",
"type": "string"
}
},
"example": {
"sEndpointURL": "https://prod.api.appcluster01.ca-central-1.ezmax.com/"
}
},
"global-ezmaxclient-version-v1-Response": {
"description": "Response for GET /1/ezmaxclient/{pksEzmaxclientOs}/version",
"required": [
"sEzmaxclientVersion"
],
"type": "object",
"properties": {
"sEzmaxclientVersion": {
"description": "The version on the store",
"type": "string"
}
},
"example": {
"sEzmaxclientVersion": "4.2.2.0"
}
},
"global-ezmaxcustomer-getConfiguration-v1-Response": {
"description": "Response for GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration",
"required": [
"sInfrastructureregionCode",
"sInfrastructureregionCodeWeb",
"sInfrastructureenvironmenttypeDescription",
"sCognitoClientIDEzmaxpublic"
],
"type": "object",
"properties": {
"sInfrastructureregionCode": {
"$ref": "#/components/schemas/Field-sInfrastructureregionCode"
},
"sInfrastructureregionCodeWeb": {
"$ref": "#/components/schemas/Field-sInfrastructureregionCode"
},
"sInfrastructureenvironmenttypeDescription": {
"$ref": "#/components/schemas/Field-sInfrastructureenvironmenttypeDescription"
},
"sCognitoClientIDExternal": {
"$ref": "#/components/schemas/Field-sCognitoClientID"
},
"sCognitoClientIDEzmaxpublic": {
"$ref": "#/components/schemas/Field-sCognitoClientID"
}
}
},
"module-Response": {
"description": "A Module Object",
"required": [
"pkiModuleID",
"fkiModulegroupID",
"eModuleInternalname",
"sModuleNameX",
"bModuleRegistered",
"bModuleRegisteredapi"
],
"type": "object",
"properties": {
"pkiModuleID": {
"$ref": "#/components/schemas/Field-pkiModuleID"
},
"fkiModulegroupID": {
"$ref": "#/components/schemas/Field-pkiModulegroupID"
},
"eModuleInternalname": {
"$ref": "#/components/schemas/Field-eModuleInternalname"
},
"sModuleNameX": {
"$ref": "#/components/schemas/Field-sModuleNameX"
},
"bModuleRegistered": {
"$ref": "#/components/schemas/Field-bModuleRegistered"
},
"bModuleRegisteredapi": {
"$ref": "#/components/schemas/Field-bModuleRegisteredapi"
}
}
},
"module-ResponseCompound": {
"description": "A Module Object",
"required": [
"a_objModulesection"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/module-Response"
},
{
"type": "object",
"properties": {
"a_objModulesection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulesection-ResponseCompound"
}
}
}
}
]
},
"modulegroup-Response": {
"description": "A Modulegroup Object",
"required": [
"pkiModulegroupID",
"sModulegroupNameX"
],
"type": "object",
"properties": {
"pkiModulegroupID": {
"$ref": "#/components/schemas/Field-pkiModulegroupID"
},
"sModulegroupNameX": {
"$ref": "#/components/schemas/Field-sModulegroupNameX"
}
}
},
"modulegroup-ResponseCompound": {
"description": "A Modulegroup Object",
"required": [
"a_objModule"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/modulegroup-Response"
},
{
"type": "object",
"properties": {
"a_objModule": {
"type": "array",
"items": {
"$ref": "#/components/schemas/module-ResponseCompound"
}
}
}
}
]
},
"modulegroup-getAll-v1-Response": {
"description": "Response for GET /1/object/modulegroup/getAll",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/modulegroup-getAll-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"modulegroup-getAll-v1-Response-mPayload": {
"description": "Response for GET /1/object/modulegroup/getAll",
"required": [
"a_objModulegroup"
],
"type": "object",
"properties": {
"a_objModulegroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulegroup-ResponseCompound"
}
}
}
},
"modulesection-Response": {
"description": "A Modulesection Object",
"required": [
"pkiModulesectionID",
"fkiModuleID",
"sModulesectionInternalname",
"sModulesectionNameX"
],
"type": "object",
"properties": {
"pkiModulesectionID": {
"$ref": "#/components/schemas/Field-pkiModulesectionID"
},
"fkiModuleID": {
"$ref": "#/components/schemas/Field-pkiModuleID"
},
"sModulesectionInternalname": {
"$ref": "#/components/schemas/Field-sModulesectionInternalname"
},
"sModulesectionNameX": {
"$ref": "#/components/schemas/Field-sModulesectionNameX"
}
}
},
"modulesection-ResponseCompound": {
"description": "A Modulesection Object",
"required": [
"a_objPermission"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/modulesection-Response"
},
{
"type": "object",
"properties": {
"a_objPermission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission-ResponseCompound"
}
}
}
}
]
},
"notificationsection-getNotificationtests-v1-Response": {
"description": "Response for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/notificationsection-getNotificationtests-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"notificationsection-getNotificationtests-v1-Response-mPayload": {
"description": "Payload for GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests",
"required": [
"a_objNotificationsubsection"
],
"type": "object",
"properties": {
"a_objNotificationsubsection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Notificationsubsectiongetnotificationtests-Response"
}
}
}
},
"notificationsubsection-Response": {
"description": "A Notificationsubsection Object",
"required": [
"pkiNotificationsubsectionID",
"fkiNotificationsectionID",
"sNotificationsubsectionNameX"
],
"type": "object",
"properties": {
"pkiNotificationsubsectionID": {
"$ref": "#/components/schemas/Field-pkiNotificationsubsectionID"
},
"fkiNotificationsectionID": {
"$ref": "#/components/schemas/Field-pkiNotificationsectionID"
},
"objNotificationsubsectionName": {
"$ref": "#/components/schemas/Multilingual-NotificationsubsectionName"
},
"sNotificationsectionNameX": {
"$ref": "#/components/schemas/Field-sNotificationsectionNameX"
},
"sNotificationsubsectionNameX": {
"$ref": "#/components/schemas/Field-sNotificationsubsectionNameX"
}
}
},
"notificationtest-Response": {
"description": "A Notificationtest Object",
"required": [
"pkiNotificationtestID",
"objNotificationtestName",
"fkiNotificationsubsectionID",
"sNotificationtestFunction",
"sNotificationtestNameX"
],
"type": "object",
"properties": {
"pkiNotificationtestID": {
"$ref": "#/components/schemas/Field-pkiNotificationtestID"
},
"objNotificationtestName": {
"$ref": "#/components/schemas/Multilingual-NotificationtestName"
},
"fkiNotificationsubsectionID": {
"$ref": "#/components/schemas/Field-pkiNotificationsubsectionID"
},
"sNotificationtestFunction": {
"$ref": "#/components/schemas/Field-sNotificationtestFunction"
},
"sNotificationtestNameX": {
"$ref": "#/components/schemas/Field-sNotificationtestNameX"
}
}
},
"notificationtest-getElements-v1-Response": {
"description": "Response for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/notificationtest-getElements-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"notificationtest-getElements-v1-Response-mPayload": {
"description": "Payload for GET /1/object/notificationtest/{pkiNotificationtestID}/getElements",
"required": [
"pkiNotificationtestID",
"sNotificationtestFunction",
"a_sProperty",
"a_objVariableobject"
],
"type": "object",
"properties": {
"pkiNotificationtestID": {
"$ref": "#/components/schemas/Field-pkiNotificationtestID"
},
"sNotificationtestFunction": {
"$ref": "#/components/schemas/Field-sNotificationtestFunction"
},
"a_sVariableobjectProperty": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-sVariableobjectProperty"
}
},
"a_objVariableobject": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Variableobject-Response"
}
}
}
},
"paymentterm-AutocompleteElement-Response": {
"description": "A Paymentterm AutocompleteElement Response",
"required": [
"pkiPaymenttermID",
"sPaymenttermDescriptionX",
"bPaymenttermIsactive"
],
"type": "object",
"properties": {
"pkiPaymenttermID": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
},
"sPaymenttermDescriptionX": {
"$ref": "#/components/schemas/Field-sPaymenttermDescriptionX"
},
"bPaymenttermIsactive": {
"$ref": "#/components/schemas/Field-bPaymenttermIsactive"
}
}
},
"paymentterm-ListElement": {
"description": "A Paymentterm List Element",
"required": [
"pkiPaymenttermID",
"sPaymenttermCode",
"ePaymenttermType",
"iPaymenttermDay",
"sPaymenttermDescriptionX",
"bPaymenttermIsactive"
],
"type": "object",
"properties": {
"pkiPaymenttermID": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
},
"sPaymenttermCode": {
"$ref": "#/components/schemas/Field-sPaymenttermCode"
},
"ePaymenttermType": {
"$ref": "#/components/schemas/Field-ePaymenttermType"
},
"iPaymenttermDay": {
"$ref": "#/components/schemas/Field-iPaymenttermDay"
},
"sPaymenttermDescriptionX": {
"$ref": "#/components/schemas/Field-sPaymenttermDescriptionX"
},
"bPaymenttermIsactive": {
"$ref": "#/components/schemas/Field-bPaymenttermIsactive"
}
}
},
"paymentterm-Request": {
"description": "A Paymentterm Object",
"required": [
"sPaymenttermCode",
"ePaymenttermType",
"iPaymenttermDay",
"objPaymenttermDescription",
"bPaymenttermIsactive"
],
"type": "object",
"properties": {
"pkiPaymenttermID": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
},
"sPaymenttermCode": {
"$ref": "#/components/schemas/Field-sPaymenttermCode"
},
"ePaymenttermType": {
"$ref": "#/components/schemas/Field-ePaymenttermType"
},
"iPaymenttermDay": {
"$ref": "#/components/schemas/Field-iPaymenttermDay"
},
"objPaymenttermDescription": {
"$ref": "#/components/schemas/Multilingual-PaymenttermDescription"
},
"bPaymenttermIsactive": {
"$ref": "#/components/schemas/Field-bPaymenttermIsactive"
}
}
},
"paymentterm-RequestCompound": {
"description": "A Paymentterm Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/paymentterm-Request"
},
{
"type": "object"
}
]
},
"paymentterm-Response": {
"description": "A Paymentterm Object",
"required": [
"pkiPaymenttermID",
"sPaymenttermCode",
"ePaymenttermType",
"iPaymenttermDay",
"objPaymenttermDescription",
"bPaymenttermIsactive",
"objAudit"
],
"type": "object",
"properties": {
"pkiPaymenttermID": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
},
"sPaymenttermCode": {
"$ref": "#/components/schemas/Field-sPaymenttermCode"
},
"ePaymenttermType": {
"$ref": "#/components/schemas/Field-ePaymenttermType"
},
"iPaymenttermDay": {
"$ref": "#/components/schemas/Field-iPaymenttermDay"
},
"objPaymenttermDescription": {
"$ref": "#/components/schemas/Multilingual-PaymenttermDescription"
},
"bPaymenttermIsactive": {
"$ref": "#/components/schemas/Field-bPaymenttermIsactive"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"paymentterm-ResponseCompound": {
"description": "A Paymentterm Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/paymentterm-Response"
},
{
"type": "object"
}
]
},
"paymentterm-createObject-v1-Request": {
"description": "Request for POST /1/object/paymentterm",
"required": [
"a_objPaymentterm"
],
"type": "object",
"properties": {
"a_objPaymentterm": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentterm-RequestCompound"
}
}
}
},
"paymentterm-createObject-v1-Response": {
"description": "Response for POST /1/object/paymentterm",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/paymentterm-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"paymentterm-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/paymentterm",
"required": [
"a_pkiPaymenttermID"
],
"type": "object",
"properties": {
"a_pkiPaymenttermID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiPaymenttermID"
}
}
}
},
"paymentterm-editObject-v1-Request": {
"description": "Request for PUT /1/object/paymentterm/{pkiPaymenttermID}",
"required": [
"objPaymentterm"
],
"type": "object",
"properties": {
"objPaymentterm": {
"$ref": "#/components/schemas/paymentterm-RequestCompound"
}
}
},
"paymentterm-editObject-v1-Response": {
"description": "Response for PUT /1/object/paymentterm/{pkiPaymenttermID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"paymentterm-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/paymentterm/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/paymentterm-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"paymentterm-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/paymentterm/getAutocomplete",
"required": [
"a_objpaymentterm"
],
"type": "object",
"properties": {
"a_objPaymentterm": {
"description": "An array of Paymentterm autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentterm-AutocompleteElement-Response"
}
}
}
},
"paymentterm-getList-v1-Response": {
"description": "Response for GET /1/object/paymentterm/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/paymentterm-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"paymentterm-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/paymentterm/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objPaymentterm"
],
"type": "object",
"properties": {
"a_objPaymentterm": {
"type": "array",
"items": {
"$ref": "#/components/schemas/paymentterm-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"paymentterm-getObject-v2-Response": {
"description": "Response for GET /2/object/paymentterm/{pkiPaymenttermID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/paymentterm-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"paymentterm-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/paymentterm/{pkiPaymenttermID}",
"required": [
"objPaymentterm"
],
"type": "object",
"properties": {
"objPaymentterm": {
"$ref": "#/components/schemas/paymentterm-ResponseCompound"
}
}
},
"period-AutocompleteElement-Response": {
"description": "A Period AutocompleteElement Response",
"required": [
"sPeriodYYYYMM",
"pkiPeriodID",
"bPeriodIsactive"
],
"type": "object",
"properties": {
"sPeriodYYYYMM": {
"$ref": "#/components/schemas/Field-sPeriodYYYYMM"
},
"pkiPeriodID": {
"$ref": "#/components/schemas/Field-pkiPeriodID"
},
"bPeriodIsactive": {
"$ref": "#/components/schemas/Field-bPeriodIsactive"
}
}
},
"period-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/period/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/period-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"period-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/period/getAutocomplete",
"required": [
"a_objperiod"
],
"type": "object",
"properties": {
"a_objPeriod": {
"description": "An array of Period autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/period-AutocompleteElement-Response"
}
}
}
},
"permission-Request": {
"description": "A Permission Object",
"required": [
"fkiModulesectionID"
],
"type": "object",
"properties": {
"pkiPermissionID": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiCompanyID": {
"$ref": "#/components/schemas/Field-pkiCompanyID"
},
"fkiModulesectionID": {
"$ref": "#/components/schemas/Field-pkiModulesectionID"
}
}
},
"permission-RequestCompound": {
"description": "A Permission Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/permission-Request"
}
]
},
"permission-Response": {
"description": "A Permission Object",
"required": [
"pkiPermissionID",
"fkiModulesectionID"
],
"type": "object",
"properties": {
"pkiPermissionID": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiCompanyID": {
"$ref": "#/components/schemas/Field-pkiCompanyID"
},
"fkiModulesectionID": {
"$ref": "#/components/schemas/Field-pkiModulesectionID"
},
"sCompanyNameX": {
"$ref": "#/components/schemas/Field-sCompanyNameX"
}
}
},
"permission-ResponseCompound": {
"description": "A Permission Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/permission-Response"
}
]
},
"permission-createObject-v1-Request": {
"description": "Request for POST /1/object/permission",
"required": [
"a_objPermission"
],
"type": "object",
"properties": {
"a_objPermission": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/permission-RequestCompound"
}
}
}
},
"permission-createObject-v1-Response": {
"description": "Response for POST /1/object/permission",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/permission-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"permission-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/permission",
"required": [
"a_pkiPermissionID"
],
"type": "object",
"properties": {
"a_pkiPermissionID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
}
}
}
},
"permission-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/permission/{pkiPermissionID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"permission-editObject-v1-Request": {
"description": "Request for PUT /1/object/permission/{pkiPermissionID}",
"required": [
"objPermission"
],
"type": "object",
"properties": {
"objPermission": {
"$ref": "#/components/schemas/permission-RequestCompound"
}
}
},
"permission-editObject-v1-Response": {
"description": "Response for PUT /1/object/permission/{pkiPermissionID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"permission-getObject-v2-Response": {
"description": "Response for GET /2/object/permission/{pkiPermissionID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/permission-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"permission-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/permission/{pkiPermissionID}",
"required": [
"objPermission"
],
"type": "object",
"properties": {
"objPermission": {
"$ref": "#/components/schemas/permission-ResponseCompound"
}
}
},
"phone-Request": {
"description": "A Phone Object",
"required": [
"fkiPhonetypeID"
],
"type": "object",
"properties": {
"pkiPhoneID": {
"$ref": "#/components/schemas/Field-pkiPhoneID"
},
"fkiPhonetypeID": {
"$ref": "#/components/schemas/Field-pkiPhonetypeID"
},
"ePhoneType": {
"$ref": "#/components/schemas/Field-ePhoneType"
},
"sPhoneRegion": {
"$ref": "#/components/schemas/Field-sPhoneRegion"
},
"sPhoneExchange": {
"$ref": "#/components/schemas/Field-sPhoneExchange"
},
"sPhoneNumber": {
"$ref": "#/components/schemas/Field-iPhoneNumber"
},
"sPhoneInternational": {
"$ref": "#/components/schemas/Field-sPhoneInternational"
},
"sPhoneExtension": {
"$ref": "#/components/schemas/Field-sPhoneExtension"
},
"sPhoneE164": {
"$ref": "#/components/schemas/Field-sPhoneE164"
}
}
},
"phone-RequestCompound": {
"description": "A Phone Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/phone-Request"
}
]
},
"phone-Response": {
"description": "A Phone Object",
"required": [
"pkiPhoneID",
"fkiPhonetypeID"
],
"type": "object",
"properties": {
"pkiPhoneID": {
"$ref": "#/components/schemas/Field-pkiPhoneID"
},
"fkiPhonetypeID": {
"$ref": "#/components/schemas/Field-pkiPhonetypeID"
},
"ePhoneType": {
"$ref": "#/components/schemas/Field-ePhoneType"
},
"sPhoneE164": {
"$ref": "#/components/schemas/Field-sPhoneE164"
},
"sPhoneExtension": {
"$ref": "#/components/schemas/Field-sPhoneExtension"
}
}
},
"phone-ResponseCompound": {
"description": "A Phone Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/phone-Response"
}
]
},
"phonestatic-Response": {
"description": "A Phonestatic Object",
"required": [
"pkiPhonestaticID"
],
"type": "object",
"properties": {
"pkiPhonestaticID": {
"$ref": "#/components/schemas/Field-pkiPhonestaticID"
},
"sPhonestaticE164": {
"$ref": "#/components/schemas/Field-sPhonestaticE164"
},
"sPhonestaticExtension": {
"$ref": "#/components/schemas/Field-sPhonestaticExtension"
}
}
},
"phonestatic-ResponseCompound": {
"description": "A Phonestatic Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/phonestatic-Response"
}
]
},
"phonetype-AutocompleteElement-Response": {
"description": "A Phonetype AutocompleteElement Response",
"required": [
"pkiPhonetypeID",
"sPhonetypeNameX",
"bPhonetypeIsactive"
],
"type": "object",
"properties": {
"pkiPhonetypeID": {
"$ref": "#/components/schemas/Field-pkiPhonetypeID"
},
"sPhonetypeNameX": {
"$ref": "#/components/schemas/Field-sPhonetypeNameX"
},
"bPhonetypeIsactive": {
"$ref": "#/components/schemas/Field-bPhonetypeIsactive"
}
}
},
"phonetype-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/phonetype/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/phonetype-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"phonetype-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/phonetype/getAutocomplete",
"required": [
"a_objphonetype"
],
"type": "object",
"properties": {
"a_objPhonetype": {
"description": "An array of Phonetype autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/phonetype-AutocompleteElement-Response"
}
}
}
},
"secretquestion-AutocompleteElement-Response": {
"description": "A Secretquestion AutocompleteElement Response",
"required": [
"sSecretquestionTextX",
"pkiSecretquestionID",
"bSecretquestionIsactive"
],
"type": "object",
"properties": {
"sSecretquestionTextX": {
"$ref": "#/components/schemas/Field-sSecretquestionTextX"
},
"pkiSecretquestionID": {
"$ref": "#/components/schemas/Field-pkiSecretquestionID"
},
"bSecretquestionIsactive": {
"$ref": "#/components/schemas/Field-bSecretquestionIsactive"
}
}
},
"secretquestion-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/secretquestion/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/secretquestion-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"secretquestion-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/secretquestion/getAutocomplete",
"required": [
"a_objSecretquestion"
],
"type": "object",
"properties": {
"a_objSecretquestion": {
"description": "An array of Secretquestion autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/secretquestion-AutocompleteElement-Response"
}
}
}
},
"sessionhistory-ListElement": {
"description": "A Sessionhistory List Element",
"required": [
"pkiSessionhistoryID",
"dtSessionhistoryFirsthit",
"dtSessionhistoryLasthit",
"eSessionhistoryEndby",
"sSessionhistoryDuration",
"sSessionhistoryIP"
],
"type": "object",
"properties": {
"pkiSessionhistoryID": {
"$ref": "#/components/schemas/Field-pkiSessionhistoryID"
},
"fkiComputerID": {
"$ref": "#/components/schemas/Field-pkiComputerID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"dtSessionhistoryFirsthit": {
"$ref": "#/components/schemas/Field-dtSessionhistoryFirsthit"
},
"dtSessionhistoryLasthit": {
"$ref": "#/components/schemas/Field-dtSessionhistoryLasthit"
},
"eSessionhistoryEndby": {
"$ref": "#/components/schemas/Field-eSessionhistoryEndby"
},
"sComputerDescription": {
"$ref": "#/components/schemas/Field-sComputerDescription"
},
"sSessionhistoryDuration": {
"$ref": "#/components/schemas/Computed-sSessionhistoryDuration"
},
"sSessionhistoryIP": {
"$ref": "#/components/schemas/Common-Format-IP"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
}
}
},
"sessionhistory-getList-v1-Response": {
"description": "Response for GET /1/object/sessionhistory/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/sessionhistory-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"sessionhistory-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/sessionhistory/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objSessionhistory"
],
"type": "object",
"properties": {
"a_objSessionhistory": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sessionhistory-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"signature-Request": {
"description": "A Signature Object",
"required": [
"tSignatureSvg"
],
"type": "object",
"properties": {
"pkiSignatureID": {
"$ref": "#/components/schemas/Field-pkiSignatureID"
},
"tSignatureSvg": {
"$ref": "#/components/schemas/Field-tSignatureSvg"
}
}
},
"signature-RequestCompound": {
"description": "A Signature Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/signature-Request"
},
{
"type": "object"
}
]
},
"signature-Response": {
"description": "A Signature Object",
"required": [
"pkiSignatureID",
"sSignatureUrl"
],
"type": "object",
"properties": {
"pkiSignatureID": {
"$ref": "#/components/schemas/Field-pkiSignatureID"
},
"sSignatureUrl": {
"$ref": "#/components/schemas/Computed-sSignatureUrl"
}
}
},
"signature-ResponseCompound": {
"description": "A Signature Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/signature-Response"
},
{
"type": "object"
}
]
},
"signature-createObject-v1-Request": {
"description": "Request for POST /1/object/signature",
"required": [
"a_objSignature"
],
"type": "object",
"properties": {
"a_objSignature": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/signature-RequestCompound"
}
}
}
},
"signature-createObject-v1-Response": {
"description": "Response for POST /1/object/signature",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/signature-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"signature-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/signature",
"required": [
"a_pkiSignatureID"
],
"type": "object",
"properties": {
"a_pkiSignatureID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiSignatureID"
}
}
}
},
"signature-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/signature/{pkiSignatureID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"signature-editObject-v1-Request": {
"description": "Request for PUT /1/object/signature/{pkiSignatureID}",
"required": [
"objSignature"
],
"type": "object",
"properties": {
"objSignature": {
"$ref": "#/components/schemas/signature-RequestCompound"
}
}
},
"signature-editObject-v1-Response": {
"description": "Response for PUT /1/object/signature/{pkiSignatureID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"signature-getObject-v2-Response": {
"description": "Response for GET /2/object/signature/{pkiSignatureID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/signature-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"signature-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/signature/{pkiSignatureID}",
"required": [
"objSignature"
],
"type": "object",
"properties": {
"objSignature": {
"$ref": "#/components/schemas/signature-ResponseCompound"
}
}
},
"subnet-Request": {
"description": "A Subnet Object",
"required": [
"objSubnetDescription",
"iSubnetNetwork",
"iSubnetMask"
],
"type": "object",
"properties": {
"pkiSubnetID": {
"$ref": "#/components/schemas/Field-pkiSubnetID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"objSubnetDescription": {
"$ref": "#/components/schemas/Multilingual-SubnetDescription"
},
"iSubnetNetwork": {
"$ref": "#/components/schemas/Field-iSubnetNetwork"
},
"iSubnetMask": {
"$ref": "#/components/schemas/Field-iSubnetMask"
}
}
},
"subnet-RequestCompound": {
"description": "A Subnet Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/subnet-Request"
},
{
"type": "object"
}
]
},
"subnet-Response": {
"description": "A Subnet Object",
"required": [
"pkiSubnetID",
"objSubnetDescription",
"iSubnetNetwork",
"iSubnetMask"
],
"type": "object",
"properties": {
"pkiSubnetID": {
"$ref": "#/components/schemas/Field-pkiSubnetID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiApikeyID": {
"$ref": "#/components/schemas/Field-pkiApikeyID"
},
"objSubnetDescription": {
"$ref": "#/components/schemas/Multilingual-SubnetDescription"
},
"iSubnetNetwork": {
"$ref": "#/components/schemas/Field-iSubnetNetwork"
},
"iSubnetMask": {
"$ref": "#/components/schemas/Field-iSubnetMask"
}
}
},
"subnet-ResponseCompound": {
"description": "A Subnet Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/subnet-Response"
},
{
"type": "object"
}
]
},
"subnet-createObject-v1-Request": {
"description": "Request for POST /1/object/subnet",
"required": [
"a_objSubnet"
],
"type": "object",
"properties": {
"a_objSubnet": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/subnet-RequestCompound"
}
}
}
},
"subnet-createObject-v1-Response": {
"description": "Response for POST /1/object/subnet",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/subnet-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"subnet-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/subnet",
"required": [
"a_pkiSubnetID"
],
"type": "object",
"properties": {
"a_pkiSubnetID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiSubnetID"
}
}
}
},
"subnet-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/subnet/{pkiSubnetID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"subnet-editObject-v1-Request": {
"description": "Request for PUT /1/object/subnet/{pkiSubnetID}",
"required": [
"objSubnet"
],
"type": "object",
"properties": {
"objSubnet": {
"$ref": "#/components/schemas/subnet-RequestCompound"
}
}
},
"subnet-editObject-v1-Response": {
"description": "Response for PUT /1/object/subnet/{pkiSubnetID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"subnet-getObject-v2-Response": {
"description": "Response for GET /2/object/subnet/{pkiSubnetID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/subnet-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"subnet-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/subnet/{pkiSubnetID}",
"required": [
"objSubnet"
],
"type": "object",
"properties": {
"objSubnet": {
"$ref": "#/components/schemas/subnet-ResponseCompound"
}
}
},
"systemconfiguration-Request": {
"description": "A Systemconfiguration Object",
"required": [
"eSystemconfigurationNewexternaluseraction",
"eSystemconfigurationLanguage1",
"eSystemconfigurationLanguage2",
"bSystemconfigurationEzsignpersonnal",
"bSystemconfigurationSspr"
],
"type": "object",
"properties": {
"pkiSystemconfigurationID": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationID"
},
"eSystemconfigurationNewexternaluseraction": {
"$ref": "#/components/schemas/Field-eSystemconfigurationNewexternaluseraction"
},
"eSystemconfigurationLanguage1": {
"$ref": "#/components/schemas/Field-eSystemconfigurationLanguage1"
},
"eSystemconfigurationLanguage2": {
"$ref": "#/components/schemas/Field-eSystemconfigurationLanguage2"
},
"eSystemconfigurationEzsign": {
"$ref": "#/components/schemas/Field-eSystemconfigurationEzsign"
},
"bSystemconfigurationEzsignpersonnal": {
"$ref": "#/components/schemas/Field-bSystemconfigurationEzsignpersonnal"
},
"bSystemconfigurationSspr": {
"$ref": "#/components/schemas/Field-bSystemconfigurationSspr"
},
"dtSystemconfigurationReadonlyexpirationstart": {
"$ref": "#/components/schemas/Field-dtSystemconfigurationReadonlyexpirationstart"
},
"dtSystemconfigurationReadonlyexpirationend": {
"$ref": "#/components/schemas/Field-dtSystemconfigurationReadonlyexpirationend"
}
}
},
"systemconfiguration-RequestCompound": {
"description": "A Systemconfiguration Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/systemconfiguration-Request"
},
{
"type": "object"
}
]
},
"systemconfiguration-Response": {
"description": "A Systemconfiguration Object",
"required": [
"pkiSystemconfigurationID",
"fkiSystemconfigurationtypeID",
"sSystemconfigurationtypeDescriptionX",
"objSystemconfigurationLanguage",
"eSystemconfigurationNewexternaluseraction",
"eSystemconfigurationLanguage1",
"eSystemconfigurationLanguage2",
"eSystemconfigurationEzsign",
"bSystemconfigurationEzsignpersonnal",
"bSystemconfigurationSspr"
],
"type": "object",
"properties": {
"pkiSystemconfigurationID": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationID"
},
"fkiSystemconfigurationtypeID": {
"$ref": "#/components/schemas/Field-pkiSystemconfigurationtypeID"
},
"sSystemconfigurationtypeDescriptionX": {
"$ref": "#/components/schemas/Field-sSystemconfigurationtypeDescriptionX"
},
"eSystemconfigurationNewexternaluseraction": {
"$ref": "#/components/schemas/Field-eSystemconfigurationNewexternaluseraction"
},
"eSystemconfigurationLanguage1": {
"$ref": "#/components/schemas/Field-eSystemconfigurationLanguage1"
},
"eSystemconfigurationLanguage2": {
"$ref": "#/components/schemas/Field-eSystemconfigurationLanguage2"
},
"eSystemconfigurationEzsign": {
"$ref": "#/components/schemas/Field-eSystemconfigurationEzsign"
},
"bSystemconfigurationEzsignpersonnal": {
"$ref": "#/components/schemas/Field-bSystemconfigurationEzsignpersonnal"
},
"bSystemconfigurationSspr": {
"$ref": "#/components/schemas/Field-bSystemconfigurationSspr"
},
"dtSystemconfigurationReadonlyexpirationstart": {
"$ref": "#/components/schemas/Field-dtSystemconfigurationReadonlyexpirationstart"
},
"dtSystemconfigurationReadonlyexpirationend": {
"$ref": "#/components/schemas/Field-dtSystemconfigurationReadonlyexpirationend"
}
}
},
"systemconfiguration-ResponseCompound": {
"description": "A Systemconfiguration Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/systemconfiguration-Response"
},
{
"type": "object"
}
]
},
"systemconfiguration-editObject-v1-Request": {
"description": "Request for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID}",
"required": [
"objSystemconfiguration"
],
"type": "object",
"properties": {
"objSystemconfiguration": {
"$ref": "#/components/schemas/systemconfiguration-RequestCompound"
}
}
},
"systemconfiguration-editObject-v1-Response": {
"description": "Response for PUT /1/object/systemconfiguration/{pkiSystemconfigurationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"systemconfiguration-getObject-v2-Response": {
"description": "Response for GET /2/object/systemconfiguration/{pkiSystemconfigurationID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/systemconfiguration-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"systemconfiguration-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/systemconfiguration/{pkiSystemconfigurationID}",
"required": [
"objSystemconfiguration"
],
"type": "object",
"properties": {
"objSystemconfiguration": {
"$ref": "#/components/schemas/systemconfiguration-ResponseCompound"
}
}
},
"taxassignment-AutocompleteElement-Response": {
"description": "A Taxassignment AutocompleteElement Response",
"required": [
"sTaxassignmentDescriptionX",
"pkiTaxassignmentID",
"bTaxassignmentIsactive"
],
"type": "object",
"properties": {
"sTaxassignmentDescriptionX": {
"$ref": "#/components/schemas/Field-sTaxassignmentDescriptionX"
},
"pkiTaxassignmentID": {
"$ref": "#/components/schemas/Field-pkiTaxassignmentID"
},
"bTaxassignmentIsactive": {
"$ref": "#/components/schemas/Field-bTaxassignmentIsactive"
}
}
},
"taxassignment-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/taxassignment/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/taxassignment-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"taxassignment-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/taxassignment/getAutocomplete",
"required": [
"a_objTaxassignment"
],
"type": "object",
"properties": {
"a_objTaxassignment": {
"description": "An array of Taxassignment autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/taxassignment-AutocompleteElement-Response"
}
}
}
},
"textstylestatic-Response": {
"description": "A Textstylestatic Object",
"required": [
"fkiFontID",
"bTextstylestaticBold",
"bTextstylestaticUnderline",
"bTextstylestaticItalic",
"bTextstylestaticStrikethrough",
"iTextstylestaticFontcolor",
"iTextstylestaticSize"
],
"type": "object",
"properties": {
"pkiTextstylestaticID": {
"$ref": "#/components/schemas/Field-pkiTextstylestaticID"
},
"fkiFontID": {
"$ref": "#/components/schemas/Field-pkiFontID"
},
"bTextstylestaticBold": {
"$ref": "#/components/schemas/Field-bTextstylestaticBold"
},
"bTextstylestaticUnderline": {
"$ref": "#/components/schemas/Field-bTextstylestaticUnderline"
},
"bTextstylestaticItalic": {
"$ref": "#/components/schemas/Field-bTextstylestaticItalic"
},
"bTextstylestaticStrikethrough": {
"$ref": "#/components/schemas/Field-bTextstylestaticStrikethrough"
},
"iTextstylestaticFontcolor": {
"$ref": "#/components/schemas/Field-iTextstylestaticFontcolor"
},
"iTextstylestaticSize": {
"$ref": "#/components/schemas/Field-iTextstylestaticSize"
}
}
},
"textstylestatic-ResponseCompound": {
"description": "A Textstylestatic Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/textstylestatic-Response"
},
{
"type": "object"
}
]
},
"timezone-AutocompleteElement-Response": {
"description": "A Timezone AutocompleteElement Response",
"required": [
"sTimezoneName",
"pkiTimezoneID",
"bTimezoneIsactive"
],
"type": "object",
"properties": {
"sTimezoneName": {
"$ref": "#/components/schemas/Field-sTimezoneName"
},
"pkiTimezoneID": {
"$ref": "#/components/schemas/Field-pkiTimezoneID"
},
"bTimezoneIsactive": {
"$ref": "#/components/schemas/Field-bTimezoneIsactive"
}
}
},
"timezone-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/timezone/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/timezone-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"timezone-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/timezone/getAutocomplete",
"required": [
"a_objTimezone"
],
"type": "object",
"properties": {
"a_objTimezone": {
"description": "An array of Timezone autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/timezone-AutocompleteElement-Response"
}
}
}
},
"user-AutocompleteElement-Response": {
"description": "A User AutocompleteElement Response",
"required": [
"eUserType",
"sUserName",
"pkiUserID",
"bUserIsactive"
],
"type": "object",
"properties": {
"eUserType": {
"$ref": "#/components/schemas/Field-eUserType"
},
"sUserName": {
"$ref": "#/components/schemas/Computed-sUserName"
},
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"bUserIsactive": {
"$ref": "#/components/schemas/Field-bUserIsactive"
}
}
},
"user-ListElement": {
"description": "A User List Element",
"required": [
"pkiUserID",
"sUserFirstname",
"sUserLastname",
"sUserLoginname",
"bUserIsactive",
"eUserType",
"eUserOrigin",
"eUserEzsignaccess",
"sEmailAddress"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"bUserIsactive": {
"$ref": "#/components/schemas/Field-bUserIsactive"
},
"eUserType": {
"$ref": "#/components/schemas/Field-eUserType"
},
"eUserOrigin": {
"$ref": "#/components/schemas/Field-eUserOrigin"
},
"eUserEzsignaccess": {
"$ref": "#/components/schemas/Field-eUserEzsignaccess"
},
"dtUserEzsignprepaidexpiration": {
"$ref": "#/components/schemas/Field-dtUserEzsignprepaidexpiration"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
}
}
},
"user-Request": {
"description": "A User Object",
"required": [
"fkiCompanyIDDefault",
"fkiDepartmentIDDefault",
"fkiTimezoneID",
"fkiLanguageID",
"objEmail",
"fkiBillingentityinternalID",
"sUserFirstname",
"sUserLastname",
"eUserType",
"eUserLogintype",
"sUserLoginname",
"eUserEzsignaccess",
"bUserIsactive"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiAgentID": {
"$ref": "#/components/schemas/Field-pkiAgentID"
},
"fkiBrokerID": {
"$ref": "#/components/schemas/Field-pkiBrokerID"
},
"fkiAssistantID": {
"$ref": "#/components/schemas/Field-pkiAssistantID"
},
"fkiEmployeeID": {
"$ref": "#/components/schemas/Field-pkiEmployeeID"
},
"fkiCompanyIDDefault": {
"$ref": "#/components/schemas/Field-pkiCompanyID"
},
"fkiDepartmentIDDefault": {
"$ref": "#/components/schemas/Field-pkiDepartmentID"
},
"fkiTimezoneID": {
"$ref": "#/components/schemas/Field-pkiTimezoneID"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"objEmail": {
"$ref": "#/components/schemas/email-RequestCompound"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"objPhoneHome": {
"$ref": "#/components/schemas/phone-RequestCompound"
},
"objPhoneSMS": {
"$ref": "#/components/schemas/phone-RequestCompound"
},
"fkiSecretquestionID": {
"$ref": "#/components/schemas/Field-pkiSecretquestionID"
},
"sUserSecretresponse": {
"$ref": "#/components/schemas/Field-sUserSecretresponse"
},
"fkiModuleIDForm": {
"$ref": "#/components/schemas/Field-pkiModuleID"
},
"eUserType": {
"$ref": "#/components/schemas/Field-eUserType"
},
"eUserLogintype": {
"$ref": "#/components/schemas/Field-eUserLogintype"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"eUserEzsignaccess": {
"$ref": "#/components/schemas/Field-eUserEzsignaccess"
},
"bUserIsactive": {
"$ref": "#/components/schemas/Field-bUserIsactive"
},
"bUserValidatebyadministration": {
"$ref": "#/components/schemas/Field-bUserValidatebyadministration"
},
"bUserValidatebydirector": {
"$ref": "#/components/schemas/Field-bUserValidatebydirector"
},
"bUserAttachmentautoverified": {
"$ref": "#/components/schemas/Field-bUserAttachmentautoverified"
},
"bUserChangepassword": {
"$ref": "#/components/schemas/Field-bUserChangepassword"
}
}
},
"user-RequestCompound": {
"description": "A User Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user-Request"
},
{
"type": "object"
}
]
},
"user-Response": {
"description": "A User Object",
"required": [
"pkiUserID",
"fkiCompanyIDDefault",
"sCompanyNameX",
"fkiDepartmentIDDefault",
"sDepartmentNameX",
"fkiTimezoneID",
"sTimezoneName",
"fkiLanguageID",
"sLanguageNameX",
"objEmail",
"fkiBillingentityinternalID",
"sBillingentityinternalDescriptionX",
"sUserFirstname",
"sUserLastname",
"eUserOrigin",
"eUserType",
"eUserLogintype",
"sUserLoginname",
"eUserEzsignaccess",
"bUserIsactive",
"bUserChangepassword",
"objAudit"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"fkiAgentID": {
"$ref": "#/components/schemas/Field-pkiAgentID"
},
"fkiBrokerID": {
"$ref": "#/components/schemas/Field-pkiBrokerID"
},
"fkiAssistantID": {
"$ref": "#/components/schemas/Field-pkiAssistantID"
},
"fkiEmployeeID": {
"$ref": "#/components/schemas/Field-pkiEmployeeID"
},
"fkiCompanyIDDefault": {
"$ref": "#/components/schemas/Field-pkiCompanyID"
},
"sCompanyNameX": {
"$ref": "#/components/schemas/Field-sCompanyNameX"
},
"fkiDepartmentIDDefault": {
"$ref": "#/components/schemas/Field-pkiDepartmentID"
},
"sDepartmentNameX": {
"$ref": "#/components/schemas/Field-sDepartmentNameX"
},
"fkiTimezoneID": {
"$ref": "#/components/schemas/Field-pkiTimezoneID"
},
"sTimezoneName": {
"$ref": "#/components/schemas/Field-sTimezoneName"
},
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sLanguageNameX": {
"$ref": "#/components/schemas/Field-sLanguageNameX"
},
"objEmail": {
"$ref": "#/components/schemas/email-ResponseCompound"
},
"fkiBillingentityinternalID": {
"$ref": "#/components/schemas/Field-pkiBillingentityinternalID"
},
"sBillingentityinternalDescriptionX": {
"$ref": "#/components/schemas/Field-sBillingentityinternalDescriptionX"
},
"objPhoneHome": {
"$ref": "#/components/schemas/phone-ResponseCompound"
},
"objPhoneSMS": {
"$ref": "#/components/schemas/phone-ResponseCompound"
},
"fkiSecretquestionID": {
"$ref": "#/components/schemas/Field-pkiSecretquestionID"
},
"fkiModuleIDForm": {
"$ref": "#/components/schemas/Field-pkiModuleID"
},
"sModuleNameX": {
"$ref": "#/components/schemas/Field-sModuleNameX"
},
"eUserOrigin": {
"$ref": "#/components/schemas/Field-eUserOrigin"
},
"eUserType": {
"$ref": "#/components/schemas/Field-eUserType"
},
"eUserLogintype": {
"$ref": "#/components/schemas/Field-eUserLogintype"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"eUserEzsignaccess": {
"$ref": "#/components/schemas/Field-eUserEzsignaccess"
},
"dtUserLastlogondate": {
"$ref": "#/components/schemas/Field-dtUserLastlogondate"
},
"dtUserPasswordchanged": {
"$ref": "#/components/schemas/Field-dtUserPasswordchanged"
},
"dtUserEzsignprepaidexpiration": {
"$ref": "#/components/schemas/Field-dtUserEzsignprepaidexpiration"
},
"bUserIsactive": {
"$ref": "#/components/schemas/Field-bUserIsactive"
},
"bUserValidatebyadministration": {
"$ref": "#/components/schemas/Field-bUserValidatebyadministration"
},
"bUserValidatebydirector": {
"$ref": "#/components/schemas/Field-bUserValidatebydirector"
},
"bUserAttachmentautoverified": {
"$ref": "#/components/schemas/Field-bUserAttachmentautoverified"
},
"bUserChangepassword": {
"$ref": "#/components/schemas/Field-bUserChangepassword"
},
"objAudit": {
"$ref": "#/components/schemas/Common-Audit"
}
}
},
"user-ResponseCompound": {
"description": "A User Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/user-Response"
}
]
},
"user-createEzsignuser-v1-Request": {
"description": "Request for POST /1/module/user/createEzsignuser",
"required": [
"fkiLanguageID",
"sUserFirstname",
"sUserLastname",
"sEmailAddress",
"sPhoneRegion",
"sPhoneExchange",
"sPhoneNumber"
],
"type": "object",
"properties": {
"fkiLanguageID": {
"$ref": "#/components/schemas/Field-pkiLanguageID"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sPhoneRegion": {
"$ref": "#/components/schemas/Field-sPhoneRegion"
},
"sPhoneExchange": {
"$ref": "#/components/schemas/Field-sPhoneExchange"
},
"sPhoneNumber": {
"$ref": "#/components/schemas/Field-iPhoneNumber"
},
"sPhoneExtension": {
"$ref": "#/components/schemas/Field-sPhoneExtension"
}
}
},
"user-createEzsignuser-v1-Response": {
"description": "Response for POST /1/module/user/createEzsignuser",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-createEzsignuser-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-createEzsignuser-v1-Response-mPayload": {
"description": "Payload for POST /1/module/user/createEzsignuser",
"required": [
"a_sEmailAddressSuccess",
"a_sEmailAddressFailure"
],
"type": "object",
"properties": {
"a_sEmailAddressSuccess": {
"description": "An array of email addresses that succeeded.",
"type": "array",
"items": {
"type": "string"
}
},
"a_sEmailAddressFailure": {
"description": "An array of email addresses that failed.",
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"a_sEmailAddressSuccess": [
"someone@example.com",
"someone2@example.com"
],
"a_sEmailAddressFailure": [
"UserAlreadyExists@example.com"
]
}
},
"user-createObject-v1-Request": {
"description": "Request for POST /1/object/user",
"required": [
"a_objUser"
],
"type": "object",
"properties": {
"a_objUser": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/user-RequestCompound"
}
}
}
},
"user-createObject-v1-Response": {
"description": "Response for POST /1/object/user",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/user",
"required": [
"a_pkiUserID"
],
"type": "object",
"properties": {
"a_pkiUserID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
}
},
"user-editObject-v1-Request": {
"description": "Request for PUT /1/object/user/{pkiUserID}",
"required": [
"objUser"
],
"type": "object",
"properties": {
"objUser": {
"$ref": "#/components/schemas/user-RequestCompound"
}
}
},
"user-editObject-v1-Response": {
"description": "Response for PUT /1/object/user/{pkiUserID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-editPermissions-v1-Request": {
"description": "Request for PUT /1/object/user/{pkiUserID}/editPermissions",
"required": [
"a_objPermission"
],
"type": "object",
"properties": {
"a_objPermission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission-RequestCompound"
}
}
}
},
"user-editPermissions-v1-Response": {
"description": "Response for PUT /1/object/user/{pkiUserID}/editPermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-editPermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-editPermissions-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/user/{pkiUserID}/editPermissions",
"required": [
"a_pkiPermissionID"
],
"type": "object",
"properties": {
"a_pkiPermissionID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
}
}
}
},
"user-getApikeys-v1-Response": {
"description": "Response for GET /1/object/user/{pkiUserID}/getApikeys",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getApikeys-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-getApikeys-v1-Response-mPayload": {
"description": "Response for GET /1/object/user/{pkiUserID}/getApikeys",
"required": [
"a_objApikey"
],
"type": "object",
"properties": {
"a_objApikey": {
"minItems": 0,
"type": "array",
"items": {
"$ref": "#/components/schemas/apikey-ResponseCompound"
}
}
}
},
"user-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/user/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/user/getAutocomplete",
"required": [
"a_objUser"
],
"type": "object",
"properties": {
"a_objUser": {
"description": "An array of User autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/user-AutocompleteElement-Response"
}
}
}
},
"user-getEffectivePermissions-v1-Response": {
"description": "Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getEffectivePermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-getEffectivePermissions-v1-Response-mPayload": {
"description": "Response for GET /1/object/user/{pkiUserID}/getEffectivePermissions",
"required": [
"a_objModulegroup"
],
"type": "object",
"properties": {
"a_objModulegroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulegroup-ResponseCompound"
}
}
}
},
"user-getList-v1-Response": {
"description": "Response for GET /1/object/user/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"user-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/user/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objUser"
],
"type": "object",
"properties": {
"a_objUser": {
"type": "array",
"items": {
"$ref": "#/components/schemas/user-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"user-getObject-v2-Response": {
"description": "Response for GET /2/object/user/{pkiUserID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/user/{pkiUserID}",
"required": [
"objUser"
],
"type": "object",
"properties": {
"objUser": {
"$ref": "#/components/schemas/user-ResponseCompound"
}
}
},
"user-getPermissions-v1-Response": {
"description": "Response for GET /1/object/user/{pkiUserID}/getPermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getPermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-getPermissions-v1-Response-mPayload": {
"description": "Response for GET /1/object/user/{pkiUserID}/getPermissions",
"required": [
"a_objModulegroup"
],
"type": "object",
"properties": {
"a_objModulegroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulegroup-ResponseCompound"
}
}
}
},
"user-getSubnets-v1-Response": {
"description": "Response for GET /1/object/user/{pkiUserID}/getSubnets",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/user-getSubnets-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"user-getSubnets-v1-Response-mPayload": {
"description": "Response for GET /1/object/user/{pkiUserID}/getSubnets",
"required": [
"a_objSubnet"
],
"type": "object",
"properties": {
"a_objSubnet": {
"type": "array",
"items": {
"$ref": "#/components/schemas/subnet-ResponseCompound"
}
}
}
},
"user-sendPasswordReset-v1-Request": {
"description": "Request for POST /1/object/user/{pkiUserID}/sendPasswordReset\n\nIntentionally empty for future-proofing",
"type": "object"
},
"user-sendPasswordReset-v1-Response": {
"description": "Response for POST /1/object/user/{pkiUserID}/sendPasswordReset",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-AutocompleteElement-Response": {
"description": "A Usergroup AutocompleteElement Response",
"required": [
"sUsergroupNameX",
"pkiUsergroupID",
"bUsergroupIsactive"
],
"type": "object",
"properties": {
"sUsergroupNameX": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
},
"pkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"bUsergroupIsactive": {
"$ref": "#/components/schemas/Field-bUsergroupIsactive"
}
}
},
"usergroup-ListElement": {
"description": "A Usergroup List Element",
"required": [
"pkiUsergroupID",
"sUsergroupNameX",
"iCountUser"
],
"type": "object",
"properties": {
"pkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"sUsergroupNameX": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
},
"iCountUser": {
"$ref": "#/components/schemas/Field-iCountUser"
}
}
},
"usergroup-Request": {
"description": "A Usergroup Object",
"required": [
"objUsergroupName"
],
"type": "object",
"properties": {
"pkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"objUsergroupName": {
"$ref": "#/components/schemas/Multilingual-UsergroupName"
}
}
},
"usergroup-RequestCompound": {
"description": "A Usergroup Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/usergroup-Request"
},
{
"type": "object"
}
]
},
"usergroup-Response": {
"description": "A Usergroup Object",
"required": [
"pkiUsergroupID",
"objUsergroupName"
],
"type": "object",
"properties": {
"pkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"objUsergroupName": {
"$ref": "#/components/schemas/Multilingual-UsergroupName"
}
}
},
"usergroup-ResponseCompound": {
"description": "A Usergroup Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/usergroup-Response"
},
{
"type": "object"
}
]
},
"usergroup-createObject-v1-Request": {
"description": "Request for POST /1/object/usergroup",
"required": [
"a_objUsergroup"
],
"type": "object",
"properties": {
"a_objUsergroup": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroup-RequestCompound"
}
}
}
},
"usergroup-createObject-v1-Response": {
"description": "Response for POST /1/object/usergroup",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/usergroup",
"required": [
"a_pkiUsergroupID"
],
"type": "object",
"properties": {
"a_pkiUsergroupID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
}
}
}
},
"usergroup-editObject-v1-Request": {
"description": "Request for PUT /1/object/usergroup/{pkiUsergroupID}",
"required": [
"objUsergroup"
],
"type": "object",
"properties": {
"objUsergroup": {
"$ref": "#/components/schemas/usergroup-RequestCompound"
}
}
},
"usergroup-editObject-v1-Response": {
"description": "Response for PUT /1/object/usergroup/{pkiUsergroupID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-editPermissions-v1-Request": {
"description": "Request for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions",
"required": [
"a_objPermission"
],
"type": "object",
"properties": {
"a_objPermission": {
"type": "array",
"items": {
"$ref": "#/components/schemas/permission-RequestCompound"
}
}
}
},
"usergroup-editPermissions-v1-Response": {
"description": "Response for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-editPermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-editPermissions-v1-Response-mPayload": {
"description": "Payload for PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions",
"required": [
"a_pkiPermissionID"
],
"type": "object",
"properties": {
"a_pkiPermissionID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiPermissionID"
}
}
}
},
"usergroup-editUsergroupdelegations-v1-Request": {
"description": "Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations",
"required": [
"a_objUsergroupdelegation"
],
"type": "object",
"properties": {
"a_objUsergroupdelegation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroupdelegation-RequestCompound"
}
}
}
},
"usergroup-editUsergroupdelegations-v1-Response": {
"description": "Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-editUsergroupdelegations-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-editUsergroupdelegations-v1-Response-mPayload": {
"description": "Response for PUT /1/object/usergroup/{pkiUsergroupID}/EditUsergroupdelegations",
"required": [
"a_pkiUsergroupdelegationID"
],
"type": "object",
"properties": {
"a_pkiUsergroupdelegationID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUsergroupdelegationID"
}
}
}
},
"usergroup-editUsergroupmemberships-v1-Request": {
"description": "Request for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships",
"required": [
"a_objUsergroupmembership"
],
"type": "object",
"properties": {
"a_objUsergroupmembership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroupmembership-RequestCompound"
}
}
}
},
"usergroup-editUsergroupmemberships-v1-Response": {
"description": "Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-editUsergroupmemberships-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-editUsergroupmemberships-v1-Response-mPayload": {
"description": "Response for PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships",
"required": [
"a_pkiUsergroupmembershipID"
],
"type": "object",
"properties": {
"a_pkiUsergroupmembershipID": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUsergroupmembershipID"
}
}
}
},
"usergroup-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/usergroup/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/usergroup/getAutocomplete",
"required": [
"a_objUsergroup"
],
"type": "object",
"properties": {
"a_objUsergroup": {
"description": "An array of Usergroup autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroup-AutocompleteElement-Response"
}
}
}
},
"usergroup-getList-v1-Response": {
"description": "Response for GET /1/object/usergroup/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"usergroup-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/usergroup/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objUsergroup"
],
"type": "object",
"properties": {
"a_objUsergroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroup-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"usergroup-getObject-v2-Response": {
"description": "Response for GET /2/object/usergroup/{pkiUsergroupID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/usergroup/{pkiUsergroupID}",
"required": [
"objUsergroup"
],
"type": "object",
"properties": {
"objUsergroup": {
"$ref": "#/components/schemas/usergroup-ResponseCompound"
}
}
},
"usergroup-getPermissions-v1-Response": {
"description": "Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-getPermissions-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-getPermissions-v1-Response-mPayload": {
"description": "Response for GET /1/object/usergroup/{pkiUsergroupID}/getPermissions",
"required": [
"a_objModulegroup"
],
"type": "object",
"properties": {
"a_objModulegroup": {
"type": "array",
"items": {
"$ref": "#/components/schemas/modulegroup-ResponseCompound"
}
}
}
},
"usergroup-getUsergroupdelegations-v1-Response": {
"description": "Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-getUsergroupdelegations-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-getUsergroupdelegations-v1-Response-mPayload": {
"description": "Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations",
"required": [
"a_objUsergroupdelegation"
],
"type": "object",
"properties": {
"a_objUsergroupdelegation": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroupdelegation-ResponseCompound"
}
}
}
},
"usergroup-getUsergroupmemberships-v1-Response": {
"description": "Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroup-getUsergroupmemberships-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroup-getUsergroupmemberships-v1-Response-mPayload": {
"description": "Response for GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships",
"required": [
"a_objUsergroupmembership"
],
"type": "object",
"properties": {
"a_objUsergroupmembership": {
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroupmembership-ResponseCompound"
}
}
}
},
"usergroupdelegation-Request": {
"description": "A Usergroupdelegation Object",
"required": [
"fkiUsergroupID",
"fkiUserID"
],
"type": "object",
"properties": {
"pkiUsergroupdelegationID": {
"$ref": "#/components/schemas/Field-pkiUsergroupdelegationID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
},
"usergroupdelegation-RequestCompound": {
"description": "A Usergroupdelegation Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/usergroupdelegation-Request"
},
{
"type": "object"
}
]
},
"usergroupdelegation-Response": {
"description": "A Usergroupdelegation Object",
"required": [
"pkiUsergroupdelegationID",
"fkiUsergroupID",
"fkiUserID",
"sUserFirstname",
"sUserLastname",
"sUserLoginname",
"sUsergroupNameX"
],
"type": "object",
"properties": {
"pkiUsergroupdelegationID": {
"$ref": "#/components/schemas/Field-pkiUsergroupdelegationID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sUsergroupNameX": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
}
}
},
"usergroupdelegation-ResponseCompound": {
"description": "A Usergroupdelegation Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/usergroupdelegation-Response"
},
{
"type": "object"
}
]
},
"usergroupdelegation-createObject-v1-Request": {
"description": "Request for POST /1/object/usergroupdelegation",
"required": [
"a_objUsergroupdelegation"
],
"type": "object",
"properties": {
"a_objUsergroupdelegation": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroupdelegation-RequestCompound"
}
}
}
},
"usergroupdelegation-createObject-v1-Response": {
"description": "Response for POST /1/object/usergroupdelegation",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroupdelegation-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupdelegation-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/usergroupdelegation",
"required": [
"a_pkiUsergroupdelegationID"
],
"type": "object",
"properties": {
"a_pkiUsergroupdelegationID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUsergroupdelegationID"
}
}
}
},
"usergroupdelegation-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupdelegation-editObject-v1-Request": {
"description": "Request for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID}",
"required": [
"objUsergroupdelegation"
],
"type": "object",
"properties": {
"objUsergroupdelegation": {
"$ref": "#/components/schemas/usergroupdelegation-RequestCompound"
}
}
},
"usergroupdelegation-editObject-v1-Response": {
"description": "Response for PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupdelegation-getObject-v2-Response": {
"description": "Response for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroupdelegation-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupdelegation-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID}",
"required": [
"objUsergroupdelegation"
],
"type": "object",
"properties": {
"objUsergroupdelegation": {
"$ref": "#/components/schemas/usergroupdelegation-ResponseCompound"
}
}
},
"usergroupmembership-Request": {
"description": "A Usergroupmembership Object",
"required": [
"fkiUsergroupID",
"fkiUserID"
],
"type": "object",
"properties": {
"pkiUsergroupmembershipID": {
"$ref": "#/components/schemas/Field-pkiUsergroupmembershipID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
},
"usergroupmembership-RequestCompound": {
"description": "A Usergroupmembership Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/usergroupmembership-Request"
},
{
"type": "object"
}
]
},
"usergroupmembership-Response": {
"description": "A Usergroupmembership Object",
"required": [
"pkiUsergroupmembershipID",
"fkiUsergroupID",
"fkiUserID",
"sUserFirstname",
"sUserLastname",
"sUserLoginname",
"sUsergroupNameX"
],
"type": "object",
"properties": {
"pkiUsergroupmembershipID": {
"$ref": "#/components/schemas/Field-pkiUsergroupmembershipID"
},
"fkiUsergroupID": {
"$ref": "#/components/schemas/Field-pkiUsergroupID"
},
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
},
"sUserFirstname": {
"$ref": "#/components/schemas/Field-sUserFirstname"
},
"sUserLastname": {
"$ref": "#/components/schemas/Field-sUserLastname"
},
"sUserLoginname": {
"$ref": "#/components/schemas/Field-sUserLoginname"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sUsergroupNameX": {
"$ref": "#/components/schemas/Field-sUsergroupNameX"
}
}
},
"usergroupmembership-ResponseCompound": {
"description": "A Usergroupmembership Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/usergroupmembership-Response"
},
{
"type": "object"
}
]
},
"usergroupmembership-createObject-v1-Request": {
"description": "Request for POST /1/object/usergroupmembership",
"required": [
"a_objUsergroupmembership"
],
"type": "object",
"properties": {
"a_objUsergroupmembership": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/usergroupmembership-RequestCompound"
}
}
}
},
"usergroupmembership-createObject-v1-Response": {
"description": "Response for POST /1/object/usergroupmembership",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroupmembership-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupmembership-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/usergroupmembership",
"required": [
"a_pkiUsergroupmembershipID"
],
"type": "object",
"properties": {
"a_pkiUsergroupmembershipID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiUsergroupmembershipID"
}
}
}
},
"usergroupmembership-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupmembership-editObject-v1-Request": {
"description": "Request for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID}",
"required": [
"objUsergroupmembership"
],
"type": "object",
"properties": {
"objUsergroupmembership": {
"$ref": "#/components/schemas/usergroupmembership-RequestCompound"
}
}
},
"usergroupmembership-editObject-v1-Response": {
"description": "Response for PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupmembership-getObject-v2-Response": {
"description": "Response for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/usergroupmembership-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"usergroupmembership-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/usergroupmembership/{pkiUsergroupmembershipID}",
"required": [
"objUsergroupmembership"
],
"type": "object",
"properties": {
"objUsergroupmembership": {
"$ref": "#/components/schemas/usergroupmembership-ResponseCompound"
}
}
},
"userstaged-ListElement": {
"description": "A Userstaged List Element",
"required": [
"pkiUserstagedID",
"sEmailAddress",
"sUserstagedFirstname",
"sUserstagedLastname",
"sUserstagedExternalid"
],
"type": "object",
"properties": {
"pkiUserstagedID": {
"$ref": "#/components/schemas/Field-pkiUserstagedID"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sUserstagedFirstname": {
"$ref": "#/components/schemas/Field-sUserstagedFirstname"
},
"sUserstagedLastname": {
"$ref": "#/components/schemas/Field-sUserstagedLastname"
},
"sUserstagedExternalid": {
"$ref": "#/components/schemas/Field-sUserstagedExternalid"
}
}
},
"userstaged-Response": {
"description": "A Userstaged Object",
"required": [
"pkiUserstagedID",
"fkiEmailID",
"sEmailAddress",
"sUserstagedFirstname",
"sUserstagedLastname",
"sUserstagedExternalid"
],
"type": "object",
"properties": {
"pkiUserstagedID": {
"$ref": "#/components/schemas/Field-pkiUserstagedID"
},
"fkiEmailID": {
"$ref": "#/components/schemas/Field-pkiEmailID"
},
"sEmailAddress": {
"$ref": "#/components/schemas/Field-sEmailAddress"
},
"sUserstagedFirstname": {
"$ref": "#/components/schemas/Field-sUserstagedFirstname"
},
"sUserstagedLastname": {
"$ref": "#/components/schemas/Field-sUserstagedLastname"
},
"sUserstagedExternalid": {
"$ref": "#/components/schemas/Field-sUserstagedExternalid"
}
}
},
"userstaged-ResponseCompound": {
"description": "A Userstaged Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/userstaged-Response"
}
]
},
"userstaged-createUser-v1-Request": {
"description": "Request for POST /1/object/userstaged/{pkiUserstagedID}/createUser",
"type": "object"
},
"userstaged-createUser-v1-Response": {
"description": "Response for POST /1/object/userstaged/{pkiUserstagedID}/createUser",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/userstaged-createUser-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"userstaged-createUser-v1-Response-mPayload": {
"description": "Payload for POST /1/object/userstaged/{pkiUserstagedID}/createUser",
"required": [
"pkiUserID"
],
"type": "object",
"properties": {
"pkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
},
"userstaged-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/userstaged/{pkiUserstagedID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"userstaged-getList-v1-Response": {
"description": "Response for GET /1/object/userstaged/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/userstaged-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"userstaged-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/userstaged/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objUserstaged"
],
"type": "object",
"properties": {
"a_objUserstaged": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userstaged-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"userstaged-getObject-v2-Response": {
"description": "Response for GET /2/object/userstaged/{pkiUserstagedID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/userstaged-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"userstaged-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/userstaged/{pkiUserstagedID}",
"required": [
"objUserstaged"
],
"type": "object",
"properties": {
"objUserstaged": {
"$ref": "#/components/schemas/userstaged-ResponseCompound"
}
}
},
"userstaged-map-v1-Request": {
"description": "Request for POST /1/object/userstaged/{pkiUserstagedID}/map",
"required": [
"fkiUserID"
],
"type": "object",
"properties": {
"fkiUserID": {
"$ref": "#/components/schemas/Field-pkiUserID"
}
}
},
"userstaged-map-v1-Response": {
"description": "Response for POST /1/object/userstaged/{pkiUserstagedID}/map",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"variableexpense-AutocompleteElement-Response": {
"description": "A Variableexpense AutocompleteElement Response",
"required": [
"sVariableexpenseDescriptionX",
"pkiVariableexpenseID",
"bVariableexpenseIsactive"
],
"type": "object",
"properties": {
"sVariableexpenseDescriptionX": {
"$ref": "#/components/schemas/Field-sVariableexpenseDescriptionX"
},
"pkiVariableexpenseID": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
},
"bVariableexpenseIsactive": {
"$ref": "#/components/schemas/Field-bVariableexpenseIsactive"
}
}
},
"variableexpense-ListElement": {
"description": "A Variableexpense List Element",
"required": [
"pkiVariableexpenseID"
],
"type": "object",
"properties": {
"pkiVariableexpenseID": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
},
"sVariableexpenseCode": {
"$ref": "#/components/schemas/Field-sVariableexpenseCode"
},
"sVariableexpenseDescriptionX": {
"$ref": "#/components/schemas/Field-sVariableexpenseDescriptionX"
},
"eVariableexpenseTaxable": {
"$ref": "#/components/schemas/Field-eVariableexpenseTaxable"
},
"bVariableexpenseIsactive": {
"$ref": "#/components/schemas/Field-bVariableexpenseIsactive"
}
}
},
"variableexpense-Request": {
"description": "A Variableexpense Object",
"required": [
"sVariableexpenseCode",
"objVariableexpenseDescription",
"eVariableexpenseTaxable",
"bVariableexpenseIsactive"
],
"type": "object",
"properties": {
"pkiVariableexpenseID": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
},
"sVariableexpenseCode": {
"$ref": "#/components/schemas/Field-sVariableexpenseCode"
},
"objVariableexpenseDescription": {
"$ref": "#/components/schemas/Multilingual-VariableexpenseDescription"
},
"eVariableexpenseTaxable": {
"$ref": "#/components/schemas/Field-eVariableexpenseTaxable"
},
"bVariableexpenseIsactive": {
"$ref": "#/components/schemas/Field-bVariableexpenseIsactive"
}
}
},
"variableexpense-RequestCompound": {
"description": "A Variableexpense Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/variableexpense-Request"
},
{
"type": "object"
}
]
},
"variableexpense-Response": {
"description": "A Variableexpense Object",
"required": [
"pkiVariableexpenseID",
"objVariableexpenseDescription"
],
"type": "object",
"properties": {
"pkiVariableexpenseID": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
},
"sVariableexpenseCode": {
"$ref": "#/components/schemas/Field-sVariableexpenseCode"
},
"objVariableexpenseDescription": {
"$ref": "#/components/schemas/Multilingual-VariableexpenseDescription"
},
"eVariableexpenseTaxable": {
"$ref": "#/components/schemas/Field-eVariableexpenseTaxable"
},
"bVariableexpenseIsactive": {
"$ref": "#/components/schemas/Field-bVariableexpenseIsactive"
}
}
},
"variableexpense-ResponseCompound": {
"description": "A Variableexpense Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/variableexpense-Response"
},
{
"type": "object"
}
]
},
"variableexpense-createObject-v1-Request": {
"description": "Request for POST /1/object/variableexpense",
"required": [
"a_objVariableexpense"
],
"type": "object",
"properties": {
"a_objVariableexpense": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/variableexpense-RequestCompound"
}
}
}
},
"variableexpense-createObject-v1-Response": {
"description": "Response for POST /1/object/variableexpense",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/variableexpense-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"variableexpense-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/variableexpense",
"required": [
"a_pkiVariableexpenseID"
],
"type": "object",
"properties": {
"a_pkiVariableexpenseID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiVariableexpenseID"
}
}
}
},
"variableexpense-editObject-v1-Request": {
"description": "Request for PUT /1/object/variableexpense/{pkiVariableexpenseID}",
"required": [
"objVariableexpense"
],
"type": "object",
"properties": {
"objVariableexpense": {
"$ref": "#/components/schemas/variableexpense-RequestCompound"
}
}
},
"variableexpense-editObject-v1-Response": {
"description": "Response for PUT /1/object/variableexpense/{pkiVariableexpenseID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"variableexpense-getAutocomplete-v2-Response": {
"description": "Response for GET /2/object/variableexpense/getAutocomplete",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/variableexpense-getAutocomplete-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"variableexpense-getAutocomplete-v2-Response-mPayload": {
"description": "Payload for POST /2/object/variableexpense/getAutocomplete",
"required": [
"a_objvariableexpense"
],
"type": "object",
"properties": {
"a_objVariableexpense": {
"description": "An array of Variableexpense autocomplete element response.",
"type": "array",
"items": {
"$ref": "#/components/schemas/variableexpense-AutocompleteElement-Response"
}
}
}
},
"variableexpense-getList-v1-Response": {
"description": "Response for GET /1/object/variableexpense/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/variableexpense-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"variableexpense-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/variableexpense/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objVariableexpense"
],
"type": "object",
"properties": {
"a_objVariableexpense": {
"type": "array",
"items": {
"$ref": "#/components/schemas/variableexpense-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"variableexpense-getObject-v2-Response": {
"description": "Response for GET /2/object/variableexpense/{pkiVariableexpenseID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/variableexpense-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"variableexpense-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/variableexpense/{pkiVariableexpenseID}",
"required": [
"objVariableexpense"
],
"type": "object",
"properties": {
"objVariableexpense": {
"$ref": "#/components/schemas/variableexpense-ResponseCompound"
}
}
},
"versionhistory-Response": {
"description": "A Versionhistory Object",
"required": [
"pkiVersionhistoryID",
"dtVersionhistoryDate",
"eVersionhistoryType",
"bVersionhistoryDraft",
"objVersionhistoryDetail"
],
"type": "object",
"properties": {
"pkiVersionhistoryID": {
"$ref": "#/components/schemas/Field-pkiVersionhistoryID"
},
"fkiModuleID": {
"$ref": "#/components/schemas/Field-pkiModuleID"
},
"fkiModulesectionID": {
"$ref": "#/components/schemas/Field-pkiModulesectionID"
},
"sModuleNameX": {
"$ref": "#/components/schemas/Field-sModuleNameX"
},
"sModulesectionNameX": {
"$ref": "#/components/schemas/Field-sModulesectionNameX"
},
"eVersionhistoryUsertype": {
"$ref": "#/components/schemas/Field-eVersionhistoryUsertype"
},
"objVersionhistoryDetail": {
"$ref": "#/components/schemas/Multilingual-VersionhistoryDetail"
},
"dtVersionhistoryDate": {
"$ref": "#/components/schemas/Field-dtVersionhistoryDate"
},
"dtVersionhistoryDateend": {
"$ref": "#/components/schemas/Field-dtVersionhistoryDateend"
},
"eVersionhistoryType": {
"$ref": "#/components/schemas/Field-eVersionhistoryType"
},
"bVersionhistoryDraft": {
"$ref": "#/components/schemas/Field-bVersionhistoryDraft"
}
}
},
"versionhistory-ResponseCompound": {
"description": "A Versionhistory Object",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/versionhistory-Response"
},
{
"type": "object"
}
]
},
"versionhistory-getObject-v2-Response": {
"description": "Response for GET /2/object/versionhistory/{pkiVersionhistoryID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/versionhistory-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"versionhistory-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/versionhistory/{pkiVersionhistoryID}",
"required": [
"objVersionhistory"
],
"type": "object",
"properties": {
"objVersionhistory": {
"$ref": "#/components/schemas/versionhistory-ResponseCompound"
}
}
},
"webhook-ListElement": {
"description": "A Webhook List Element",
"required": [
"pkiWebhookID",
"sWebhookDescription",
"sWebhookUrl",
"sWebhookEvent",
"sWebhookEmailfailed",
"eWebhookModule",
"bWebhookIsactive"
],
"type": "object",
"properties": {
"pkiWebhookID": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"sWebhookDescription": {
"$ref": "#/components/schemas/Field-sWebhookDescription"
},
"sWebhookUrl": {
"$ref": "#/components/schemas/Field-sWebhookUrl"
},
"sWebhookEvent": {
"$ref": "#/components/schemas/Computed-sWebhookEvent"
},
"sWebhookEmailfailed": {
"$ref": "#/components/schemas/Field-sWebhookEmailfailed"
},
"eWebhookModule": {
"$ref": "#/components/schemas/Field-eWebhookModule"
},
"eWebhookEzsignevent": {
"$ref": "#/components/schemas/Field-eWebhookEzsignevent"
},
"eWebhookManagementevent": {
"$ref": "#/components/schemas/Field-eWebhookManagementevent"
},
"bWebhookIsactive": {
"$ref": "#/components/schemas/Field-bWebhookIsactive"
}
}
},
"webhook-Request": {
"description": "A Webhook Object",
"required": [
"sWebhookDescription",
"eWebhookModule",
"sWebhookUrl",
"sWebhookEmailfailed",
"bWebhookIsactive",
"bWebhookSkipsslvalidation"
],
"type": "object",
"properties": {
"pkiWebhookID": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"sWebhookDescription": {
"$ref": "#/components/schemas/Field-sWebhookDescription"
},
"eWebhookModule": {
"$ref": "#/components/schemas/Field-eWebhookModule"
},
"eWebhookEzsignevent": {
"$ref": "#/components/schemas/Field-eWebhookEzsignevent"
},
"eWebhookManagementevent": {
"$ref": "#/components/schemas/Field-eWebhookManagementevent"
},
"sWebhookUrl": {
"$ref": "#/components/schemas/Field-sWebhookUrl"
},
"sWebhookEmailfailed": {
"$ref": "#/components/schemas/Field-sWebhookEmailfailed"
},
"bWebhookIsactive": {
"$ref": "#/components/schemas/Field-bWebhookIsactive"
},
"bWebhookSkipsslvalidation": {
"$ref": "#/components/schemas/Field-bWebhookSkipsslvalidation"
}
}
},
"webhook-RequestCompound": {
"description": "A Webhook Object and children",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhook-Request"
},
{
"type": "object"
}
]
},
"webhook-Response": {
"description": "A webhook object",
"required": [
"pkiWebhookID",
"sWebhookDescription",
"eWebhookModule",
"sWebhookUrl",
"bWebhookTest",
"bWebhookSkipsslvalidation",
"sWebhookEmailfailed"
],
"type": "object",
"properties": {
"pkiWebhookID": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
},
"sWebhookDescription": {
"$ref": "#/components/schemas/Field-sWebhookDescription"
},
"fkiEzsignfoldertypeID": {
"$ref": "#/components/schemas/Field-pkiEzsignfoldertypeID"
},
"sEzsignfoldertypeNameX": {
"$ref": "#/components/schemas/Field-sEzsignfoldertypeNameX"
},
"eWebhookModule": {
"$ref": "#/components/schemas/Field-eWebhookModule"
},
"eWebhookEzsignevent": {
"$ref": "#/components/schemas/Field-eWebhookEzsignevent"
},
"eWebhookManagementevent": {
"$ref": "#/components/schemas/Field-eWebhookManagementevent"
},
"sWebhookUrl": {
"$ref": "#/components/schemas/Field-sWebhookUrl"
},
"sWebhookEmailfailed": {
"$ref": "#/components/schemas/Field-sWebhookEmailfailed"
},
"bWebhookIsactive": {
"$ref": "#/components/schemas/Field-bWebhookIsactive"
},
"bWebhookSkipsslvalidation": {
"$ref": "#/components/schemas/Field-bWebhookSkipsslvalidation"
}
}
},
"webhook-ResponseCompound": {
"description": "A Webhook Object",
"required": [
"sWebhookEvent"
],
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/webhook-Response"
},
{
"type": "object",
"properties": {
"sWebhookEvent": {
"$ref": "#/components/schemas/Computed-sWebhookEvent"
}
}
}
]
},
"webhook-createObject-v1-Request": {
"description": "Request for POST /1/object/webhook",
"required": [
"a_objWebhook"
],
"type": "object",
"properties": {
"a_objWebhook": {
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook-RequestCompound"
}
}
}
},
"webhook-createObject-v1-Response": {
"description": "Response for POST /1/object/webhook",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/webhook-createObject-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"webhook-createObject-v1-Response-mPayload": {
"description": "Payload for POST /1/object/webhook",
"required": [
"a_pkiWebhookID"
],
"type": "object",
"properties": {
"a_pkiWebhookID": {
"description": "An array of unique IDs representing the object that were requested to be created.\n\nThey are returned in the same order as the array containing the objects to be created that was sent in the request.",
"minItems": 1,
"type": "array",
"items": {
"$ref": "#/components/schemas/Field-pkiWebhookID"
}
}
}
},
"webhook-deleteObject-v1-Response": {
"description": "Response for DELETE /1/object/webhook/{pkiWebhookID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"webhook-editObject-v1-Request": {
"description": "Request for PUT /1/object/webhook/{pkiWebhookID}",
"required": [
"objWebhook"
],
"type": "object",
"properties": {
"objWebhook": {
"$ref": "#/components/schemas/webhook-RequestCompound"
}
}
},
"webhook-editObject-v1-Response": {
"description": "Response for PUT /1/object/webhook/{pkiWebhookID}",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"webhook-getHistory-v1-Response": {
"description": "Response for GET /1/object/webhook/{pkiWebhookID}/getHistory",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/webhook-getHistory-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"webhook-getHistory-v1-Response-mPayload": {
"description": "Payload for GET /1/object/webhook/{pkiWebhookID}/getHistory",
"type": "object",
"allOf": [
{
"required": [
"a_objWebhooklog"
],
"type": "object",
"properties": {
"a_objWebhooklog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Custom-Webhooklog-Response"
}
}
}
}
]
},
"webhook-getList-v1-Response": {
"description": "Response for GET /1/object/webhook/getList",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/webhook-getList-v1-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response_getList"
}
]
},
"webhook-getList-v1-Response-mPayload": {
"description": "Payload for GET /1/object/webhook/getList",
"type": "object",
"allOf": [
{
"required": [
"a_objWebhook"
],
"type": "object",
"properties": {
"a_objWebhook": {
"type": "array",
"items": {
"$ref": "#/components/schemas/webhook-ListElement"
}
}
}
},
{
"$ref": "#/components/schemas/Common-getList-v1-Response-mPayload"
}
]
},
"webhook-getObject-v2-Response": {
"description": "Response for GET /2/object/webhook/{pkiWebhookID}",
"type": "object",
"allOf": [
{
"required": [
"mPayload"
],
"type": "object",
"properties": {
"mPayload": {
"$ref": "#/components/schemas/webhook-getObject-v2-Response-mPayload"
}
}
},
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"webhook-getObject-v2-Response-mPayload": {
"description": "Payload for GET /2/object/webhook/{pkiWebhookID}",
"required": [
"objWebhook"
],
"type": "object",
"properties": {
"objWebhook": {
"$ref": "#/components/schemas/webhook-ResponseCompound"
}
}
},
"webhook-test-v1-Request": {
"description": "Request for POST /1/object/webhook/{pkiWebhookID}/test\n\nIntentionally empty for future-proofing",
"type": "object"
},
"webhook-test-v1-Response": {
"description": "Response for POST /1/object/webhook/{pkiWebhookID}/test",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Common-Response"
}
]
},
"website-Request": {
"description": "A Website Object",
"required": [
"fkiWebsitetypeID",
"sWebsiteAddress"
],
"type": "object",
"properties": {
"fkiWebsitetypeID": {
"$ref": "#/components/schemas/Field-pkiWebsitetypeID"
},
"sWebsiteAddress": {
"$ref": "#/components/schemas/Field-sWebsiteAddress"
}
}
},
"website-RequestCompound": {
"description": "A Website Object and children to create a complete structure",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/website-Request"
}
]
}
},
"responses": {
"Response-Error-403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error"
}
}
},
"description": "The request is not allowed to be executed. Look for detail about the error in the body"
},
"Response-Error-404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error"
}
}
},
"description": "The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body"
},
"Response-Error-406": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error"
}
}
},
"description": "The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header \"Accept: application/json\" but the function can only return \"Content-type: image/png\""
},
"Response-Error-422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error"
}
}
},
"description": "The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body"
},
"Response-Error-422-EzsignformValidation": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error-EzsignformValidation"
}
}
},
"description": "The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body."
},
"Response-Error-422-sTemporaryFileUrl": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error-sTemporaryFileUrl"
}
}
},
"description": "The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body. If the error is recoverable sTemporaryFileUrl will be set and you can use this url to try a new request without sending the file over again"
},
"Response-Error-429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Error-TooManyRequests"
}
}
},
"description": "Too Many Requests"
},
"Response-Redirect-350": {
"description": "The user must authenticate before he can continue with this request"
},
"Response-Redirect-351": {
"description": "The user is configured with 2FA and needs to validate its phone number before he can continue with this request"
},
"Response-Redirect-352": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Common-Response-Redirect-sSecretquestionTextX"
}
}
},
"description": "The user is configured with 2FA and needs to answer a Secretquestion before he can continue with this request"
},
"Response-Redirect-353": {
"description": "The user must accept clauses before he can continue with this request"
},
"Response-Redirect-354": {
"description": "The user's computer must be validated before he can continue with this request"
},
"Response-Redirect-355": {
"description": "The user must change its password before he can continue with this request"
},
"Response-Redirect-356": {
"description": "The user is not running the latest version of the native application. He must valide or update its version before he can continue with this request"
},
"Response-Webhook-202": {
"description": "The Webhook event notification was successfully received by the receiving web server."
},
"Response-Webhook-204": {
"description": "The Webhook event notification was successfully received and processed by the receiving web server."
},
"Response-Websocket": {
"description": "Fake response to normalize documentation as websocket doesn't return a code"
}
},
"parameters": {
"AcceptLanguage": {
"name": "Accept-Language",
"schema": {
"$ref": "#/components/schemas/Header-Accept-Language"
},
"in": "header",
"required": false
},
"iRowMax": {
"name": "iRowMax",
"schema": {
"$ref": "#/components/schemas/Field-iRowMax"
},
"in": "query"
},
"iRowOffset": {
"name": "iRowOffset",
"schema": {
"$ref": "#/components/schemas/Field-iRowOffset"
},
"in": "query",
"required": false
},
"sFilter": {
"name": "sFilter",
"schema": {
"$ref": "#/components/schemas/Field-sFilter"
},
"in": "query",
"required": false
},
"sQuery": {
"name": "sQuery",
"description": "Allow to filter the returned results",
"schema": {
"type": "string"
},
"in": "query",
"required": false
}
},
"examples": {
"PdfAsBase64": {
"summary": "A BASE64 encoded PDF",
"value": "JVBERi0xLjENCiXCpcKxw6sNCg0KMSAwIG9iag0KICA8PCAvVHlwZSAvQ2F0YWxvZw0KICAgICAvUGFnZXMgMiAwIFINCiAgPj4NCmVuZG9iag0KDQoyIDAgb2JqDQogIDw8IC9UeXBlIC9QYWdlcw0KICAgICAvS2lkcyBbMyAwIFJdDQogICAgIC9Db3VudCAxDQogICAgIC9NZWRpYUJveCBbMCAwIDMwMCAxNDRdDQogID4+DQplbmRvYmoNCg0KMyAwIG9iag0KICA8PCAgL1R5cGUgL1BhZ2UNCiAgICAgIC9QYXJlbnQgMiAwIFINCiAgICAgIC9SZXNvdXJjZXMNCiAgICAgICA8PCAvRm9udA0KICAgICAgICAgICA8PCAvRjENCiAgICAgICAgICAgICAgIDw8IC9UeXBlIC9Gb250DQogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTENCiAgICAgICAgICAgICAgICAgIC9CYXNlRm9udCAvVGltZXMtUm9tYW4NCiAgICAgICAgICAgICAgID4+DQogICAgICAgICAgID4+DQogICAgICAgPj4NCiAgICAgIC9Db250ZW50cyA0IDAgUg0KICA+Pg0KZW5kb2JqDQoNCjQgMCBvYmoNCiAgPDwgL0xlbmd0aCA1NSA+Pg0Kc3RyZWFtDQogIEJUDQogICAgL0YxIDE4IFRmDQogICAgMCAwIFRkDQogICAgKEhlbGxvIFdvcmxkKSBUag0KICBFVA0KZW5kc3RyZWFtDQplbmRvYmoNCg0KeHJlZg0KMCA1DQowMDAwMDAwMDAwIDY1NTM1IGYgDQowMDAwMDAwMDE4IDAwMDAwIG4gDQowMDAwMDAwMDc3IDAwMDAwIG4gDQowMDAwMDAwMTc4IDAwMDAwIG4gDQowMDAwMDAwNDU3IDAwMDAwIG4gDQp0cmFpbGVyDQogIDw8ICAvUm9vdCAxIDAgUg0KICAgICAgL1NpemUgNQ0KICA+Pg0Kc3RhcnR4cmVmDQo1NjUNCiUlRU9G"
},
"PngAsBase64": {
"summary": "A BASE64 encoded PNG",
"value": "iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAAY0lEQVR42u3QAREAAAQEMJKL/nI4W4R1JVOPtQABAgQIECBAgAABAgQIECBAgAABAgQIECBAgAABAgQIECBAgAABAgQIECBAgAABAgQIECBAgAABAgQIECBAgAABAgQIEHDfArMdn4FHyLy9AAAAAElFTkSuQmCC"
},
"Svg": {
"summary": "A Svg file",
"value": "<svg version=\"1.1\" id=\"Layer_2\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" x=\"0px\" y=\"0px\" \t viewBox=\"0 0 175 75\" enable-background=\"new 0 0 175 75\" xml:space=\"preserve\"> <path fill=\"#FFFFFF\" d=\"M51,47.4c-0.8,1.6-1.7,3.1-2.8,4.5H31.9l15-17.6H36.7c-1.2,0-2.2-1-2.2-2.2s1-2.2,2.2-2.2l0,0h15 \tc0.5,1.4,0.9,2.9,1.1,4.4L41.6,47.4H51z M32,48.6c-2.2,2.2-5.1,3.3-8,3.3s-5.8-1.1-8-3.3c-4.4-4.4-4.4-11.6,0-16s11.6-4.4,16,0 \tc2.1,2.1,3.3,5,3.3,8v2.3l-17.8-0.2c0.3,1,0.9,1.9,1.7,2.7c2.7,2.7,7,2.7,9.7,0c0.9-0.9,2.3-0.9,3.2,0C32.9,46.3,32.9,47.7,32,48.6z \t M17.6,38.2l12.9,0.1c-0.3-1-0.9-1.8-1.6-2.6c-2.7-2.7-7-2.7-9.7,0C18.5,36.5,18,37.3,17.6,38.2z\"/> <path fill=\"#D12A2F\" d=\"M46.9,34.3H36.7c-1.2,0-2.2-1-2.2-2.2s1-2.2,2.2-2.2l0,0h15C48.5,21,40,14.7,30.1,14.7 \tc-12.7,0-23,10.3-23,23s10.3,23,23,23c7.3,0,13.8-3.4,18-8.7H31.8L46.9,34.3z M24,51.9c-2.9,0-5.8-1.1-8-3.3c-4.4-4.4-4.4-11.6,0-16 \ts11.6-4.4,16,0c2.1,2.1,3.3,5,3.3,8v2.3l-17.8-0.2c0.3,1,0.9,1.9,1.7,2.7c2.7,2.7,7,2.7,9.7,0c0.9-0.9,2.3-0.9,3.2,0 \tc0.9,0.9,0.9,2.3,0,3.2C29.8,50.8,26.9,51.9,24,51.9z M30.5,38.3l-12.8-0.1c0.3-0.9,0.9-1.7,1.6-2.4c2.7-2.7,7-2.7,9.7,0 \tC29.6,36.5,30.1,37.4,30.5,38.3z M41.6,47.4l11.2-13.2c0.2,1.1,0.2,2.2,0.2,3.4c0,3.5-0.8,6.8-2.2,9.8H41.6z\"/> </svg>"
}
},
"securitySchemes": {
"Authorization": {
"type": "apiKey",
"description": "This is the normal Authorization scheme where the apiKey is sent in the Authorization http header",
"name": "Authorization",
"in": "header"
},
"Bearer": {
"scheme": "bearer",
"type": "http",
"description": "This is the Bearer scheme where the apiKey is sent in the Authorization http header prefixed with \"Bearer \""
},
"Presigned": {
"type": "apiKey",
"description": "This is a special Authorization scheme where the apiKey is sent in a url parameter.\n\nThat kind of Authorization can only generated by the server since it's used only for presigned Urls.",
"name": "sAuthorization",
"in": "query"
}
}
},
"tags": [
{
"name": "General_Changelog",
"description": "All notable changes to this project will be documented in this section.\r\n\r\nVersion numbers are using **MAJOR**.**MINOR**.**PATCH** numbering format for example 1.2.23\r\n\r\n**MAJOR** will be incremented only if there is an incompatible breaking change. New distinct documentation and specification files will be published.\r\n\r\n**MINOR** will be incremented only if a function becomes deprecated or deleted (after being deprecated in a previous version)\r\n\r\n**PATCH** will be incremented everytime changes and additions are released.\r\n\r\nFor each version, there will be the list of changes:\r\n* **Added** for new features.\r\n* **Changed** for changes in existing functionality.\r\n* **Deprecated** for soon-to-be removed features.\r\n* **Removed** for now removed features.\r\n* **Fixed** for any bug fixes.\r\n* **Security** in case of vulnerabilities.\r\n\r\n**Removal lifecycle**<br>\r\nOnce a function becomes **Deprecated**, we monitor its usage to track how many users are still using it.\r\nAfter a long period of time, if a minority of users are still using the function, we might ask users to update to the newer version of the function and give them ample time to do so.\r\nOnly after that delay expires (or no more users are still using it), we will have the function **Removed**.\r\n\r\n## 1.1.X Releases\r\n\r\n### [1.1.19] - 2023-08-\r\n\r\n#### Added\r\n- DELETE /1/object/usergroupdelegation/{pkiUsergroupdelegationID}\r\n- GET /1/object/activesession/getDocumentationUrl\r\n- GET /1/object/user/{pkiUserID}/getApikeys\r\n- GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations\r\n- GET /2/object/usergroupdelegation/{pkiUsergroupdelegationID}\r\n- POST /1/object/user/{pkiUserID}/sendPasswordReset\r\n- POST /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations\r\n- POST /1/object/usergroupdelegation\r\n- PUT /1/object/usergroupdelegation/{pkiUsergroupdelegationID}\r\n- Added property bVersionDeprecated in Common-Response-objDebugPayload\r\n- Added property eEzsigndocumentSteptype in ezsigndocument-ResponseCompound\r\n- Added property iEzsigntemplatesignatureWidth and iEzsigntemplatesignatureHeight in object ezsigntemplatesignature-Request and ezsigntemplatesignature-Response\r\n- Added property eEzsignformfieldgroupTextvalidation in ezsignformfieldgroup-Response\r\n- Added property eEzsigntemplateformfieldgroupTextvalidation in ezsigntemplateformfieldgroup-Request and ezsigntemplateformfieldgroup-Response\r\n- Added property iEzsignsignatureMaxlength in ezsignsignature-Request and ezsignsignature-Response\r\n- Added properties iEzsigntemplatesignatureMaxlength, sEzsigntemplatesignatureRegexp and eEzsigntemplatesignatureTextvalidation in ezsigntemplatesignature-Request and ezsigntemplatesignature-Response\r\n- Added value AgentBrokerEzsignUserNormal for sSelector in GET /2/object/user/getAutocomplete/{sSelector}\r\n### [1.1.18] - 2023-07-22\r\n\r\n#### Added\r\n- DELETE /1/object/cors/{pkiCorsID}\r\n- DELETE /1/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}\r\n- DELETE /1/object/permission/{pkiPermissionID}\r\n- DELETE /1/object/signature/{pkiSignatureID}\r\n- DELETE /1/object/subnet/{pkiSubnetID}\r\n- DELETE /1/object/usergroupmembership/{pkiUsergroupmembershipID}\r\n- DELETE /2/scim/Groups/{groupId}\r\n- DELETE /2/scim/Users/{userId}\r\n- GET /1/object/apikey/getList\r\n- GET /1/object/apikey/{pkiApkiID}\r\n- GET /1/object/apikey/{pkiApkiID}/getCors\r\n- GET /1/object/apikey/{pkiApkiID}/getPermissions\r\n- GET /1/object/apikey/{pkiApkiID}/getSubnets\r\n- GET /1/module/report/getReportFromCache/{sReportgroupCacheID}\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociationsmine\r\n- GET /1/object/ezsignsignature/{pkiEzsignsignatureID}/getEzsignsignatureattachment\r\n- GET /1/object/modulegroup/getAll/{eContext}\r\n- GET /1/object/user/getList\r\n- GET /1/object/user/{pkiUserID}/getEffectivePermissions\r\n- GET /1/object/user/{pkiUserID}/getPermissions\r\n- GET /1/object/user/{pkiUserID}/getSubnets\r\n- GET /1/object/usergroup/{pkiUsergroupID}/getPermissions\r\n- GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships\r\n- GET /1/object/usergroupmembership/{pkiUsergroupmembershipID}\r\n- GET /2/object/company/getAutocomplete/{sSelector}\r\n- GET /2/object/cors/{pkiCorsID}\r\n- GET /2/object/emailtype/getAutocomplete/{sSelector}\r\n- GET /2/object/ezsignsignergroupmembership/{pkiEzsignsignergroupmembershipID}\r\n- GET /2/object/permission/{pkiPermissionID}\r\n- GET /2/object/phonetype/getAutocomplete/{sSelector}\r\n- GET /2/object/signature/{pkiSignatureID}\r\n- GET /2/object/subnet/{pkiSubnetID} \r\n- GET /2/object/systemconfiguration/{pkiSystemconfigurationID}\r\n- GET /2/object/user/{pkiUserID}\r\n- GET /2/scim/Groups\r\n- GET /2/scim/Groups/{groupId}\r\n- GET /2/scim/ServiceProviderConfig\r\n- GET /2/scim/Users\r\n- GET /2/scim/Users/{userId}\r\n- POST /1/object/apikey/{pkiApikeyID}/regenerate\r\n- POST /1/object/cors\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/submitEzsignform\r\n- POST /1/object/ezsignpage/{pkiEzsignpageID}/consult\r\n- POST /1/object/ezsignsignergroupmembership\r\n- POST /1/object/permission\r\n- POST /1/object/signature\r\n- POST /1/object/subnet\r\n- POST /1/object/usergroupmembership\r\n- POST /1/object/userstaged/{pkiUserstagedID}/createUser\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign\r\n- POST /1/object/user\r\n- POST /1/report/accountsreceivable/accountsreceivablereport\r\n- POST /2/scim/Groups\r\n- POST /2/scim/Users\r\n- PUT /1/object/apikey/{pkiApikeyID}\r\n- PUT /1/object/apikey/{pkiApikeyID}/editPermissions\r\n- PUT /1/object/cors/{pkiCorsID}\r\n- PUT /1/object/permission/{pkiPermissionID} \r\n- PUT /1/object/signature/{pkiSignatureID} \r\n- PUT /1/object/subnet/{pkiSubnetID}\r\n- PUT /1/object/systemconfiguration/{pkiSystemconfigurationID}\r\n- PUT /1/object/user/{pkiUserID}\r\n- PUT /1/object/user/{pkiUserID}/editPermissions\r\n- PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions\r\n- PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships\r\n- PUT /1/object/usergroupmembership/{pkiUsergroupmembershipID}\r\n- PUT /2/scim/Groups/{groupId}\r\n- PUT /2/scim/Users/{userId}\r\n- Webhook Userstaged Created in Userstaged\r\n- Websocket RequestServer-GetWebsocketID-V1\r\n- Websocket Response-Error-V1\r\n- Websocket Response-GetWebsocketID-V1\r\n- Websocket Response-Information-V1\r\n- Added property a_objBillingentityinternalproduct in billingentityinternal-RequestCompound and billingentityinternal-ResponseCompound\r\n- Added property bCommunicationPrivate in objet communication-Response\r\n- Added property eEzsignformfieldgroupTextvalidation in object ezsignformfieldgroup-Request and ezsignformfieldgroup-Response \r\n- Added property fkiEmailID, sBrandingName and sEmailAddress in object branding-Response \r\n- Added property fkiSignatureID in object activesession-Response\r\n- Added property iEzsignsignatureattachmentCount, iEzsignsignatureWidth, iEzsignsignatureHeight, sEzsignsignatureRegexp and eEzsignsignatureTextvalidation in object ezsignsignature-Request and ezsignsignature-Response\r\n- Added property sBrandingName and sEmailAddress in objet branding-Request\r\n- Added property sEmailAddress in object userstaged-Response\r\n- Added property sEzsignsignatureDescription and objSignature in object ezsignsignature-Response\r\n- Added property sDownloadUrl and objSignature in object communicationattachment-Response\r\n- Added property a_objFile, eDecision, sReason and sSvg in ezsignsignature-sign-v1-Request\r\n- Added value FieldText and FieldTextarea for property eEzsignsignatureType\r\n- Added Websocket section in servers section of the documentation\r\n- New 401 error code UNAUTHORIZED_EXPIRED\r\n- New 422 error code UNPROCESSABLEENTITY_EZSIGNFORM_VALIDATION\r\n- New 500 error code ERROR_CONFIGURATION\r\n\r\n\r\n### [1.1.17] - 2023-05-22\r\n\r\n#### Added\r\n- DELETE /1/object/ezsignannotation/{pkiEzsignannotationID}\r\n- DELETE /1/object/userstaged/{pkiUserstagedID}\r\n- GET /1/ezmaxclient/{pksEzmaxclientOs}/version\r\n- GET /1/ezmaxcustomer/{pksEzmaxcustomerCode}/getConfiguration\r\n- GET /1/object/activesession/getList\r\n- GET /1/object/billingentityinternal/getList\r\n- GET /1/object/clonehistory/getList\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignsignaturesAutomatic\r\n- GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getCompletedElements\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignannotations\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationCount\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getCommunicationList\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignsignaturesAutomatic\r\n- GET /1/object/ezsignsignature/getEzsignsignaturesAutomatic\r\n- GET /1/object/paymentterm/getList\r\n- GET /1/object/usergroup/getList\r\n- GET /1/object/userstaged/getList\r\n- GET /2/object/billingentityinternal/{pkiBillingentityinternalID}\r\n- GET /2/object/billingentityexternal/getAutocomplete/{sSelector} \r\n- GET /2/object/communication/{pkiCommunicationID}\r\n- GET /2/object/ezmaxproduct/getAutocomplete/{sSelector} \r\n- GET /2/object/ezsignannotation/{pkiEzsignannotationID}\r\n- GET /2/object/paymentterm/{pkiPaymenttermID}\r\n- GET /2/object/paymentterm/getAutocomplete/{sSelector} \r\n- GET /1/object/sessionhistory/getList\r\n- GET /2/object/usergroup/{pkiUsergroupID}\r\n- GET /2/object/userstaged/{pkiUserstagedID}\r\n- POST /1/object/billingentityinternal\r\n- POST /1/object/ezsignannotation\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/flatten\r\n- POST /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/flatten\r\n- POST /1/object/paymentterm\r\n- POST /1/object/usergroup\r\n- POST /1/object/userstaged/{pkiUserstagedID}/map\r\n- PUT /1/object/billingentityinternal/{pkiBillingentityinternalID}\r\n- PUT /1/object/ezsignannotation/{pkiEzsignannotationID}\r\n- PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignannotations\r\n- PUT /1/object/paymentterm/{pkiPaymenttermID}\r\n- PUT /1/object/usergroup/{pkiUsergroupID}\r\n- Webhook Ezsignsigner Accept Clause in Ezsignfoldersignerassociation\r\n- Webhook Ezsignsigner Connect in Ezsignfoldersignerassociation\r\n- New 403 error code FORBIDDEN_PERMISSION\r\n- New 403 error code FORBIDDEN_USER_ORIGIN_EXTERNAL\r\n- New 403 error code UNPROCESSABLEENTITY_DATA_UNIQUE\r\n- New 422 error code UNPROCESSABLEENTITY_PDF_SIGNATURE\r\n- Added property bEzsigndocumentHassignedsignatures in object ezsigndocument-Response\r\n- Added property bEzsigntemplatedocumentHassignedsignatures in object ezsigntemplatedocument-Response\r\n- Added property dtEzsignsignatureDate in object ezsignsignature-Response\r\n- Added property eActivesessionUsertype in object activesession-Response\r\n- Added property objCreditcardtransaction in object ezsignsignature-Response\r\n- Added property objContactName in object ezsignsignature-Response\r\n- Added property sEzsignfolderDescription in object Custom-Ezsignfoldertransmission-Response\r\n- Added property sEzsigndocumentExternalid in object ezsigndocument-Request\r\n- Added property sEzsigndocumentExternalid in object ezsigndocument-Response\r\n- Added property sEzsignfolderExternalid in object ezsignfolder-Request\r\n- Added property sEzsignfolderExternalid in object ezsignfolder-Response\r\n- Added value AgentBrokerEmployeeNormalBuiltIn for sSelector in GET /2/object/user/getAutocomplete/{sSelector}\r\n- Added value EzsignuserBuiltIn for sSelector in GET /2/object/user/getAutocomplete/{sSelector}\r\n \r\n### Removed\r\n- GET /1/object/billingentityinternal/getAutocomplete/{sSelector}\r\n- GET /1/object/branding/{pkiBrandingID}\r\n- GET /1/object/branding/getAutocomplete/{sSelector}\r\n- GET /1/object/department/getAutocomplete/{sSelector}\r\n- GET /1/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- GET /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}\r\n- GET /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}\r\n- GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}\r\n- GET /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}\r\n- GET /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}\r\n- GET /1/object/ezsignsignature/{pkiEzsignsignatureID}\r\n- GET /1/object/ezsigntemplate/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}\r\n- GET /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}\r\n- GET /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}\r\n- GET /1/object/ezsigntemplatepackage/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}\r\n- GET /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}\r\n- GET /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}\r\n- GET /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}\r\n- GET /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}\r\n- GET /1/object/ezsigntsarequirement/getAutocomplete/{sSelector}\r\n- GET /1/object/franchiseoffice/getAutocomplete/{sSelector}\r\n- GET /1/object/secretquestion/getAutocomplete/{sSelector}\r\n- GET /1/object/taxassignment/getAutocomplete/{sSelector}\r\n- GET /1/object/timezone/getAutocomplete/{sSelector}\r\n- GET /1/object/user/getAutocomplete/{sSelector}\r\n- GET /1/object/usergroup/getAutocomplete/{sSelector}\r\n- GET /1/object/versionhistory/{pkiVersionhistoryID}\r\n- GET /1/object/webhook/{pkiWebhookID}\r\n- POST /1/object/apikey\r\n\r\n### [1.1.16] - 2022-11-10\r\n\r\n#### Added\r\n- POST /1/object/ezsigntemplate/{pkiEzsigntemplateID}/copy\r\n- Properties fkiEzsignfoldersignerassociationIDDeclinedtosign and tEzsigndocumentDeclinedtosignreason in ezsigndocument-Response\r\n\r\n### [1.1.15] - 2022-11-07\r\n\r\n#### Added\r\n- PATCH /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}\r\n- POST /3/object/ezsignfolder/{pkiEzsignfolderID}/send\r\n- Enum value 'PendingSend' for eEzsignfolderStep\r\n- Property bEzsignfoldersignerassociationDelayedsend in ezsignfoldersignerassociation-Response\r\n- Property dtEzsignfolderDelayedsenddate in ezsignfolder-Response\r\n\r\n#### Deprecated\r\n- POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send\r\n\r\n\r\n### [1.1.14] - 2022-11-01\r\n\r\n#### Added\r\n- GET /2/object/period/getAutocomplete/{sSelector}\r\n- GET /2/object/franchisebroker/getAutocomplete/{sSelector}\r\n- GET /2/object/franchiseoffice/getAutocomplete/{sSelector}\r\n\r\n#### Deprecated\r\n- GET /1/object/period/getAutocomplete/{sSelector}\r\n- GET /1/object/franchisebroker/getAutocomplete/{sSelector}\r\n- GET /1/object/franchiseoffice/getAutocomplete/{sSelector}\r\n\r\n### [1.1.13] - 2022-10-28\r\n\r\n#### Added\r\n\r\n- GET /1/object/ezmaxinvoicing/getAutocomplete/{sSelector}\r\n- GET /1/object/ezmaxinvoicing/getProvisional\r\n- GET /1/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}\r\n- GET /2/object/billingentityinternal/getAutocomplete/{sSelector}\r\n- GET /2/object/branding/getAutocomplete/{sSelector}\r\n- GET /2/object/department/getAutocomplete/{sSelector}\r\n- GET /2/object/ezmaxinvoicing/getAutocomplete/{sSelector}\r\n- GET /2/object/ezsignfoldertype/getAutocomplete/{sSelector}\r\n- GET /2/object/ezsigntemplate/getAutocomplete/{sSelector}\r\n- GET /2/object/ezsigntemplatepackage/getAutocomplete/{sSelector}\r\n- GET /2/object/ezsigntsarequirement/getAutocomplete/{sSelector}\r\n- GET /2/object/secretquestion/getAutocomplete/{sSelector}\r\n- GET /2/object/taxassignment/getAutocomplete/{sSelector}\r\n- GET /2/object/timezone/getAutocomplete/{sSelector}\r\n- GET /2/object/user/getAutocomplete/{sSelector}\r\n- GET /2/object/usergroup/getAutocomplete/{sSelector}\r\n- GET /2/object/branding/{pkiBrandingID}\r\n- GET /2/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}\r\n- GET /2/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- GET /2/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}\r\n- GET /2/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}\r\n- GET /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}\r\n- GET /2/object/ezsigndocument/{pkiEzsigndocumentID}\r\n- GET /2/object/ezsignfolder/{pkiEzsignfolderID}\r\n- GET /2/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}\r\n- GET /2/object/ezsignfoldertype/{pkiEzsignfoldertypeID}\r\n- GET /2/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}\r\n- GET /2/object/ezsignsignature/{pkiEzsignsignatureID}\r\n- GET /2/object/ezsigntemplate/{pkiEzsigntemplateID}\r\n- GET /2/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}\r\n- GET /2/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}\r\n- GET /2/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}\r\n- GET /2/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}\r\n- GET /2/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}\r\n- GET /2/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}\r\n- GET /2/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}\r\n- GET /2/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}\r\n- GET /2/object/webhook/{pkiWebhookID}\r\n- Accepted value 'Attachments' for field eEzsigntemplatesignatureType\r\n- Added property eEzsignfoldertypePrivacylevel in object ezsignbulksend-Response\r\n- Added properties bEzsignfoldertypeIncludeproofsigner and bEzsignfoldertypeIncludeproofuser in object ezsignfoldertype-Request and ezsignfoldertype-Response\r\n- Added properties bEzsigntemplatesignatureRequired, eEzsigntemplatesignatureAttachmentnamesource, sEzsigntemplatesignatureAttachmentdescription, iEzsigntemplatesignatureValidationstep in object ezsigntemplatesignature-Response and ezsigntemplatesignature-Response\r\n- Added selector ClonableUsers in /1/object/user/getAutocomplete/{sSelector}\r\n- New 422 error code UNPROCESSABLEENTITY_EZSIGNSIGNERCONNECTED\r\n- New 429 error codes TOOMANYREQUESTS and TOOMANYREQUESTS_THIRDPARTY\r\n- Rename sImageUrl to sComputedImageurl in object ezsigntemplatedocumentpage-Response and ezsignpage-Response\r\n\r\n#### Deprecated\r\n- GET /1/object/billingentityinternal/getAutocomplete/{sSelector}\r\n- GET /1/object/branding/getAutocomplete/{sSelector}\r\n- GET /1/object/department/getAutocomplete/{sSelector}\r\n- GET /1/object/ezmaxinvoicing/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntemplate/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntemplatepackage/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntsarequirement/getAutocomplete/{sSelector}\r\n- GET /1/object/secretquestion/getAutocomplete/{sSelector}\r\n- GET /1/object/taxassignment/getAutocomplete/{sSelector}\r\n- GET /1/object/timezone/getAutocomplete/{sSelector}\r\n- GET /1/object/user/getAutocomplete/{sSelector}\r\n- GET /1/object/usergroup/getAutocomplete/{sSelector}\r\n- GET /1/object/branding/{pkiBrandingID}\r\n- GET /1/object/ezmaxinvoicing/{pkiEzmaxinvoicingID}\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- GET /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}\r\n- GET /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}\r\n- GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}\r\n- GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}\r\n- GET /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}\r\n- GET /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}\r\n- GET /1/object/ezsignsignature/{pkiEzsignsignatureID}\r\n- GET /1/object/ezsigntemplate/{pkiEzsigntemplateID}\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}\r\n- GET /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}\r\n- GET /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}\r\n- GET /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}\r\n- GET /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}\r\n- GET /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}\r\n- GET /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}\r\n- GET /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}\r\n- GET /1/object/webhook/{pkiWebhookID}\r\n\r\n#### Fixed\r\n- (CSharpSDK) We now use the correct encoding of the fingerprint for signing requests\r\n- (CSharkSDK) We can now use variable properties object i.e: /1/object/notificationtest/{pkiNotificationtestID}/getElements\r\n\r\n### [1.1.12] - Skipped\r\n\r\n### [1.1.11] - Skipped\r\n\r\n### [1.1.10] - 2022-08-23\r\n\r\n#### Added\r\n- DELETE /1/object/webhook/{pkiWebhookID}\r\n- GET /1/object/branding/{pkiBrandingID}\r\n- GET /1/object/branding/getList\r\n- GET /1/object/department/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}\r\n- GET /1/object/webhook/{pkiWebhookID}\r\n- GET /1/object/webhook/{pkiWebhookID}/getHistory\r\n- GET /1/object/webhook/getList\r\n- POST /1/object/branding\r\n- POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsignfoldersignerassociations\r\n- POST /1/object/ezsignfoldertype\r\n- POST /1/object/webhook\r\n- POST /1/object/webhook/{pkiWebhookID}/test\r\n- POST /2/object/ezsignfolder/{pkiEzsignfolderID}/send\r\n- PUT /1/object/branding/{pkiBrandingID}\r\n- PUT /1/object/ezsignfoldertype/{pkiEzsignfoldertypeID}\r\n- PUT /1/object/webhook/{pkiWebhookID}\r\n- New supported eEzsignsignatureType: Attachments\r\n- Object Custom-EzsignfoldersignerassociationActionableElement-Response\r\n- Properties fkiUserID, bEzsignsignatureRequired, eEzsignsignatureAttachmentnamesource, sEzsignsignatureAttachmentdescription, iEzsignsignatureValidationstep in object ezsignsignature-Request\r\n- Properties fkiUserID, bEzsignsignatureRequired, eEzsignsignatureAttachmentnamesource, sEzsignsignatureAttachmentdescription, iEzsignsignatureValidationstep in object ezsignsignature-Response\r\n- Properties objNotificationsubsectionName and sNotificationsectionNameX in object notificationsubsection-Response\r\n- Properties objNotificationtestName and sNotificationtestNameX in object notificationtest-Response\r\n- Properties sBrandingDescriptionX, sBillingentityinternalDescriptionX, sEzsigntsarequirementDescriptionX, sUsergroupNameX and sUsergroupNameXRestricted in object ezsignfoldertype-Response\r\n- Property bActive in getAutocomplete endpoints\r\n- Property dtEzsignformCompleted in object ezsigndocument-Response\r\n- Property tEzsignfoldersignerassociationMessage in object ezsignfoldersignerassociation-Request (Optional)\r\n- Property tEzsignfoldersignerassociationMessage in object ezsignfoldersignerassociation-Response (Mandatory)\r\n- Query parameter eFilterActive in getAutocomplete endpoints\r\n\r\n### Changed\r\n- The return object for route GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations is now of type Custom-EzsignfoldersignerassociationActionableElement-Response\r\n\r\n#### Deprecated\r\n- POST /1/object/ezsignfolder/{pkiEzsignfolderID}/send\r\n\r\n### [1.1.9] - 2022-06-20\r\n\r\n#### Changed\r\n- Property dtEzsigndocumentFirstsend in Ezsigndocument is no longer required\r\n- Property dtEzsigndocumentLastsend in Ezsigndocument is no longer required\r\n- Property dtEzsignfolderClose in Ezsignfolder is no longer required\r\n\r\n### [1.1.8] - 2022-06-20\r\n\r\n#### Added\r\n- GET /1/object/activesession/getCurrent fkiTimezoneID, eUserEzsignsendreminderfrequency, iUserInterfacecolor, bUserInterfacedark and iUserListresult\r\n- GET /1/object/billingentityinternal/getAutocomplete/{sSelector}\r\n- GET /1/object/branding/getAutocomplete/{sSelector}\r\n- GET /1/object/notificationtest/{pkiNotificationtestID}/getElements\r\n- GET /1/object/taxassignment/getAutocomplete/{sSelector}\r\n- GET /1/object/timezone/getAutocomplete/{sSelector}\r\n- GET /1/object/user/getAutocomplete/{sSelector}\r\n- GET /1/object/usergroup/getAutocomplete/{sSelector}\r\n- Warning Code MUSTVERIFY added to documentation\r\n \r\n#### Changed\r\n- Property dtEzsignfolderScheduledarchive in Ezsignfolder is no longer required\r\n- Property dtEzsignfolderScheduleddispose in Ezsignfolder is no longer required\r\n\r\n### [1.1.7] - 2022-05-17\r\n\r\n#### Added\r\n- DELETE /1/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- DELETE /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}\r\n- DELETE /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}\r\n- DELETE /1/object/ezsigntemplate/{pkiEzsigntemplateID}\r\n- DELETE /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}\r\n- DELETE /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}\r\n- DELETE /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}\r\n- DELETE /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}\r\n- DELETE /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}\r\n- DELETE /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}\r\n- DELETE /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}\r\n- GET /1/module/ezsign/suggestSigners\r\n- GET /1/module/ezsign/suggestTemplates\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getCsvTemplate\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getFormsData\r\n- GET /1/object/ezsignbulksenddocumentmapping/{pkiEzsignbulksenddocumentmappingID}\r\n- GET /1/object/ezsignbulksendsignermapping/{pkiEzsignbulksendsignermappingID}\r\n- GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getCsvErrors\r\n- GET /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures eEzsignsignatureFont, tEzsignsignatureTooltip and eEzsignsignatureTooltipposition\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getActionableElements\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/batchDownload\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getActionableElements\r\n- GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector} sValue\r\n- GET /1/object/ezsignsignature/{pkiEzsignsignatureID} eEzsignsignatureFont, tEzsignsignatureTooltip and eEzsignsignatureTooltipposition\r\n- GET /1/object/ezsigntemplate/{pkiEzsigntemplateID}\r\n- GET /1/object/ezsigntemplate/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntemplate/getList\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplateformfieldgroups\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatedocumentpages\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getEzsigntemplatesignatures\r\n- GET /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/getWordsPositions\r\n- GET /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}\r\n- GET /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}\r\n- GET /1/object/ezsigntemplatepackage/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsigntemplatepackagemembership/{pkiEzsigntemplatepackagemembershipID}\r\n- GET /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}\r\n- GET /1/object/ezsigntemplatepackagesignermembership/{pkiEzsigntemplatepackagesignermembershipID}\r\n- GET /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}\r\n- GET /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}\r\n- GET /1/object/ezsigntsarequirement/getAutocomplete/{sSelector}\r\n- GET /1/object/notificationsection/{pkiNotificationsectionID}/getNotificationtests\r\n- GET /1/object/secretquestion/getAutocomplete/{sSelector}\r\n- PATCH /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}\r\n- POST /1/object/ezsignbulksend\r\n- POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/createEzsignbulksendtransmission\r\n- POST /1/object/ezsignbulksend/{pkiEzsignbulksendID}/reorder\r\n- POST /1/object/ezsignbulksenddocumentmapping\r\n- POST /1/object/ezsignbulksendsignermapping\r\n- POST /2/object/ezsigndocument eEzsigndocumentSource=Ezsigntemplate and fkiEzsigntemplateID\r\n- POST /1/object/ezsigndocument eEzsigndocumentForm and fkiEzsignfoldersignerassociationID\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/unsend\r\n- POST /1/object/ezsignfolder/{pkiEzsignfolderID}/archive\r\n- POST /1/object/ezsignfolder/{pkiEzsignfolderID}/importEzsigntemplatepackage\r\n- POST /1/object/ezsignfolder/{pkiEzsignfolderID}/reorder\r\n- POST /1/object/ezsignsignature eEzsignsignatureFont, tEzsignsignatureTooltip and eEzsignsignatureTooltipposition\r\n- POST /2/object/ezsignsignature eEzsignsignatureFont, tEzsignsignatureTooltip and eEzsignsignatureTooltipposition\r\n- POST /1/object/ezsignsignature/{pkiEzsignsignatureID}/sign\r\n- POST /1/object/ezsigntemplate\r\n- POST /1/object/ezsigntemplatedocument\r\n- POST /1/object/ezsigntemplateformfieldgroup\r\n- POST /1/object/ezsigntemplatepackage\r\n- POST /1/object/ezsigntemplatepackagemembership\r\n- POST /1/object/ezsigntemplatepackagesigner\r\n- POST /1/object/ezsigntemplatepackagesignermembership\r\n- POST /1/object/ezsigntemplatesignature\r\n- POST /1/object/ezsigntemplatesigner\r\n- PUT /1/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures eEzsignsignatureFont, tEzsignsignatureTooltip and eEzsignsignatureTooltipposition\r\n- PUT /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}\r\n- PUT /1/object/ezsignsignature/{pkiEzsignsignatureID} eEzsignsignatureFont, tEzsignsignatureTooltip and eEzsignsignatureTooltipposition\r\n- PUT /1/object/ezsigntemplate\r\n- PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}\r\n- PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplateformfieldgroups\r\n- PUT /1/object/ezsigntemplatedocument/{pkiEzsigntemplatedocumentID}/editEzsigntemplatesignatures\r\n- PUT /1/object/ezsigntemplateformfieldgroup/{pkiEzsigntemplateformfieldgroupID}\r\n- PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}\r\n- PUT /1/object/ezsigntemplatepackage/{pkiEzsigntemplatepackageID}/editEzsigntemplatepackagesigners\r\n- PUT /1/object/ezsigntemplatepackagesigner/{pkiEzsigntemplatepackagesignerID}\r\n- PUT /1/object/ezsigntemplatesignature/{pkiEzsigntemplatesignatureID}\r\n- PUT /1/object/ezsigntemplatesigner/{pkiEzsigntemplatesignerID}\r\n- Error Code UNPROCESSABLEENTITY_DATA_MISSING added to documentation\r\n- Error Code UNPROCESSABLEENTITY_PDF_FORM\r\n- Error Code UNPROCESSABLEENTITY_PDF_FORM_AND_SIGNATURE\r\n\r\n#### Deprecated\r\n- /1/object/ezsignfoldertype/getAutocomplete/{sSelector} mValue\r\n\r\n### [1.1.6] - 2022-03-04\r\n\r\n#### Added\r\n- DELETE /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}/getEzsignbulksendtransmissions\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignatures\r\n- GET /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}\r\n- GET /1/object/ezsignsignature/{pkiEzsignsignatureID}\r\n- POST /1/object/ezsignformfieldgroup\r\n- POST /2/object/apikey\r\n- POST /2/object/ezsigndocument\r\n- POST /2/object/ezsignfolder\r\n- POST /2/object/ezsignfoldersignerassociation\r\n- POST /2/object/ezsignsignature\r\n- POST /2/object/franchisereferalincome\r\n- PUT /1/object/ezsignformfieldgroup/{pkiEzsignformfieldgroupID}\r\n- PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignformfieldgroups\r\n\r\n#### Changed\r\n- Audit in return response has been hierarchized\r\n\r\n#### Deprecated\r\n- POST /1/object/apikey\r\n- POST /1/object/ezsigndocument\r\n- POST /1/object/ezsignfolder\r\n- POST /1/object/ezsignfoldersignerassociation\r\n- POST /1/object/ezsignsignature\r\n- POST /1/object/franchisereferalincome\r\n\r\n### [1.1.4] - 2022-02-24\r\n\r\n#### Added\r\n- GET /1/object/ezsignbulksend/{pkiEzsignbulksendID}\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID} Added status\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getTemporaryProof\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID} Added fkiBillingentityinternalID, dtEzsignfolderDuedate, sBillingentityinternalDescriptionX, sEzsignfoldertypeNameX, sEzsigntsarequirementDescriptionX, dtEzsignfolderScheduledarchive and dtEzsignfolderScheduleddestruction properties\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsigndocuments\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getEzsignfoldersignerassociations\r\n- GET /1/object/ezsignfoldersignerassociation/{pkiEzsignfoldersignerassociationID}\r\n- PATCH /1/object/ezsigndocument/{pkiEzsigndocumentID}\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/endPrematurely\r\n- POST /1/object/ezsignsignature bEzsignsignatureCustomdate and a_objEzsignsignaturecustomdate\r\n- PUT /1/object/ezsigndocument/{pkiEzsigndocumentID}/editEzsignsignatures\r\n- PUT /1/object/ezsignfolder/{pkiEzsignfolderID}\r\n- Error Code UNPROCESSABLEENTITY_UNMODIFIABLE_FIELD added to documentation\r\n- Error Code UNPROCESSABLEENTITY_CANNOTMODIFY added to documentation\r\n- Error Code UNPROCESSABLEENTITY_DATA_VALIDATION added to documentation\r\n- Error Code UNPROCESSABLEENTITY_DATA_OUTOFBOUND added to documentation\r\n\r\n### [1.1.3] - 2021-12-17\r\n\r\n#### Added\r\n- GET /1/object/ezsignbulksend/getList\r\n- GET /1/object/ezsigntemplatepackage/getList\r\n- POST /1/object/ezsignfoldersignerassociation bEzsignfoldersignerassociationReceivecopy property\r\n- Error Code UNPROCESSABLEENTITY_DOWNLOAD_ERROR added to documentation\r\n- Error Code UNPROCESSABLEENTITY_PDF_REPAIRABLE added to documentation\r\n\r\n#### Changed\r\n- Changed all the OneOf used back to nullable types. When the generators will support 3.1 nullable polymorphism documentation will be improved\r\n\r\n#### Fixed\r\n- (AxiosSDK) Fingerprint header on GET requests was invalid when url parameters contained utf8 special chars\r\n- (CsharpSDK) OneOf not supported for polymorphism was preventing compilation\r\n- \r\n### [1.1.2] - 2021-10-26\r\n\r\n#### Added\r\n- GET /1/object/ezsignfolder/getList eEzsignfoldertypePrivacylevel property\r\n- POST /1/object/ezsigndocument returns a sTemporaryFileUrl on error 422 if error is recoverable\r\n- POST /1/object/ezsigndocument sEzsigndocumentUrl property\r\n- POST /1/object/ezsigndocument eEzsigndocumentSource property now accept \"Url\" as the source\r\n- POST /1/object/ezsigndocument bEzsigndocumentForcerepair property\r\n- Support for \"rg\" operator in date fields in sFilter\r\n- Range operator added to convention section of the documentation\r\n\r\n### [1.1.1] - 2021-10-22\r\n\r\n#### Added\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/unsend\r\n- GET /1/module/list/listpresentation/{sListName}\r\n- POST /1/module/list/listpresentation/{sListName}\r\n- Variables convention documentation now contains type \"m\" for mixed type\r\n- POST /1/object/ezsigndocument/ sEzsigndocumentPassword property\r\n- Support for \"in\" operator for integer fields in sFilter\r\n- Support for \"in\" operator for enum fields in sFilter\r\n\r\n### [1.1.0] - 2021-10-19\r\n\r\n#### Added\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages\r\n- GET /1/object/ezsigndocument/{pkiEzsigndocumentID}/getFormData\r\n- GET /1/object/ezsignfolder/{pkiEzsignfolderID}/getFormsData\r\n- GET /1/object/ezsignfolder/getList\r\n- GET /1/object/ezsignfoldertype/getAutocomplete/{sSelector}\r\n- GET /1/object/ezsignfoldertype/getList\r\n- POST /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/getWordsPositions\r\n- Status Code 406 added to documentation\r\n- Status Code 501 added to documentation\r\n- Error Code NOTACCEPTABLE_CONTENT added to documentation\r\n- Error Code NOTACCEPTABLE_LANGUAGE added to documentation\r\n- Error Code ERROR_NOTIMPLEMENTED added to documentation\r\n- Variables convention added to documentation\r\n- List Filter convention added to documentation\r\n\r\n#### Deprecated\r\n- POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate\r\n \r\n#### Removed\r\n- Support for typescript-angular\r\n- Support for typescript-aurelia\r\n- Support for typescript-fetch\r\n- Support for typescript-jquery\r\n- Support for typescript-node\r\n\r\n#### Fixed\r\n- (AxiosSDK) Fingerprint header on GET requests was invalid when url parameters were used\r\n\r\n## 1.0.X Releases\r\nDocumentation and changelog for version 1.0x can be found here: [1.0.x Releases Documentation (Full)](https://ezmaxinc.github.io/eZmax-API/docs/full/ezmax.v1.0.html)",
"x-displayName": "Changelog"
},
{
"name": "General_Conventions",
"description": "## Variables\n\nWe use a custom type base naming convention for variables.\n\nEach variable name is composed of up to 6 indicators\n1. **Array** (Optional) *a_* when we are dealing with an array.\n2. **Key** (Optional) *pk* when we are dealing with a primary key or *fk* for foreign key.\n3. **Type** Will always be in lowercase and represent the type of the variable.\n4. **Table** The first letter in uppercase and the rest in lowercase and represents the table name from where the variable was retrieved.\n5. **Field** (Optional) The first letter is uppercase and the rest is lowercase and represents the field name.\n6. **Discriminator** (Optional) Will be present only when two identical fields are stored in the same table to differenciate one from the other. \n\nHere is a summary table explaining the convention.\n\n| | Array | Key | Type | Table | Field | Discriminator |\n|---|---|---|---|---|---|---|\n| **Optional** | Yes | Yes | No | No | Yes | Yes |\n| **Naming** | Fixed | Fixed | Lowercase | First letter is uppercase and the rest is lowercase | First letter is uppercase and the rest is lowercase except for the Field *ID* wich is always uppercase | First letter is uppercase and the rest is lowercase |\n| **Values** | a_ | pk<br>fk<br>efk | s (string)<br>t (text)<br>c (char)<br>sha (sha-1 string)<br>md5 (md5 string)<br>bin (binary string)<br>i (integer)<br>f (float)<br>d (decimal)<br>e (enum)<br>dt (date or datetime)<br>b (boolean)<br>obj (object)<br>m (mixed) | Any | Any | Any |\n\nHere are examples of typical variables' names\n\n| Variable name | Array | key | Type | Table | Field | Discriminator | Explanation | Example |\n|---|---|---|---|---|---|---|---|---|\n| pkiContactID | | pk | i | Contact | ID | | Primary key of type integer for the field name *ID* in table *Contact* | 133 |\n| fkiContactID | | fk | i | Contact | ID | | Foreign key of type integer pointing to the field *pkiContactID* in table *Contact* | 133 |\n| efkiContactID | | efk | i | Contact | ID | | External foreign key of type integer pointing to the field *pkiContactID* in table *Contact* | 133 |\n| fkiContactIDOwner | | fk | i | Contact | ID | Owner | Foreign key of type integer pointing to the field *pkiContactID* in table *Contact* with a discriminator of *Owner* | 266 |\n| sContactFirstname | | | s | Contact | Firstname | | String for the Field *Firstname* in table *Contact* | John |\n| bPurchaseIspaid | | | b | Purchase | Ispaid | | Boolean for the field Ispaid in table *Purchase* | true |\n| dPurchaseTotal | | | d | Purchase | Total | | Decimal number for the field *Total* in table *Purchase* | 2199.78 |\n| objEzsignfolder | | | obj | Esignfolder | | | Object of type *Ezsignfolder* | {\"pkiEzsignfolderID\": 122, \"sEzsignfolderName\": \"Test\"} |\n| a_objEzsignfolder | a_ | | obj | Ezsignfolder | | | Array of objects of type *Ezsignfolder* | [{\"pkiEzsignfolderID\": 122, \"sEzsignfolderName\": \"Test\"}, {\"pkiEzsignfolderID\": 234, \"sEzsignfolderName\": \"Test 2\"}] |\n| a_sContactFirstname | a_ | | s | Contact | Firstname | | An array of string for the field *Firstname* in table *Contact* | ['John', 'Mary', 'Jane'] |\n| a_pkiContactIDOwner | a_ | pk | i | Contact | ID | Owner | An array of foreign keys of type integer pointing to the field *pkiContactID* in table *Contact* with a discriminator of *Owner* | [266, 277, 288] |\n\n## List filter\n\nEvery GetList Endpoint has a *sFilter* query parameter that can be used to filter the returned elements.\n\nThe sFilter parameter's syntax is not documented at the endpoint's level since it would be redundant. This section documents the syntax.\n\n* Every property returned by the endpoint can be used to build the *sFilter* string. Except for rare exceptions.\n* Each filter can be joined by the *and* operator\n* Not every property supports every operator. The list of valid operators is based on the variable type. For example, only strings support the *like* operator. You can refer to the *Variables* article in the *Conventions* section of the documentation to learn about variable types.\n* Variables of type *Enum* have predetermined list of filters which will be documented at the endpoint's level.\n* *sFilter*'s value must be url encoded.\n* String values need to be enclosed in single quotes\n\nValid operators for boolean values:\n\n| Operator | Description | Examples |\n|---|---|---|\n| eq | Equals | bEzsigndocumentEzsignclause eq true<br>bEzsigndocumentEzsignclause eq false |\n\nValid operators for integer values:\n\n| Operator | Description | Examples |\n|---|---|---|\n| eq | Equals | iEzsigndocumentPagetotal eq 10 |\n| gt | Greater than | iEzsigndocumentPagetotal gt 10 |\n| gte | Greater than or equal to | iEzsigndocumentPagetotal gte 10 |\n| lt | Less than | iEzsigndocumentPagetotal lt 100 |\n| lte | Less than or equal to | iEzsigndocumentPagetotal lte 100 |\n| in | in list | fkiEzsignfoldertypeID in '1,2,3' |\n\nValid operators for date and datetime values:\n\n| Operator | Description | Examples |\n|---|---|---|\n| eq | Equals | dtEzsigndocumentDuedate eq '2005-07-01 18:15:59'<br>dtEzsigndocumentDuedate eq '2005-07-01' |\n| gt | Greater than | dtEzsigndocumentDuedate gt '2001-01-01 00:00:00'<br>dtEzsigndocumentDuedate gt '2001-01-01' |\n| gte | Greater than or equal to | dtEzsigndocumentDuedate gte '2001-01-01 00:00:00'<br>dtEzsigndocumentDuedate gte '2001-01-01' |\n| lt | Less than | dtEzsigndocumentDuedate lt '2025-12-31 23:59:59'<br>dtEzsigndocumentDuedate lt '2025-12-31' |\n| lte | Less than or equal to | dtEzsigndocumentDuedate lte '2025-12-31 23:59:59'<br>dtEzsigndocumentDuedate lte '2025-12-31' |\n| rg | In the range of<br>*see range documentation*| dtEzsigndocumentDuedate rg '=m,=m+7d' |\n\nValid operators for string values:\n\n| Operator | Description | Examples |\n|---|---|---|\n| eq | Equals | sEzsigndocumentName eq 'Test contract' |\n| like | Search for a partial string with *%* wildcard | sEzsigndocumentName like 'Test contra%'<br>sEzsigndocumentName like '%contract'<br>sEzsigndocumentName like '%con%' |\n\nValid operators for enum values (valid values are documented at the endpoint's level):\n\n| Operator | Description | Examples |\n|---|---|---|\n| eq | Equals | eEzsigndocumentStep eq 'PartiallySigned' |\n| in | in list | eEzsigndocumentStep in 'PartiallySigned,Archived' |\n\nExample of combining multiple filter together:\n\n`sFilter=bEzsigndocumentEzsignclause eq true and iEzsigndocumentPagetotal gt 10 and iEzsigndocumentPagetotal lte 100 and dtEzsigndocumentDuedate gt '2001-01-01 00:00:00' and dtEzsigndocumentDuedate lte '2025-12-31 23:59:59' and sEzsigndocumentName like '%con%' and eEzsigndocumentStep eq 'PartiallySigned' and fkiEzsignfoldertypeID in '1,2,3' and dtEzsigndocumentDuedate rg '=m,=m+7d'`\n\nSame example, but properly url encoded:\n\n`sFilter=bEzsigndocumentEzsignclause%20eq%20true%20and%20iEzsigndocumentPagetotal%20gt%2010%20and%20iEzsigndocumentPagetotal%20lte%20100%20and%20dtEzsigndocumentDuedate%20gt%20%272001-01-01%2000%3A00%3A00%27%20and%20dtEzsigndocumentDuedate%20lte%20%272025-12-31%2023%3A59%3A59%27%20and%20sEzsigndocumentName%20%20like%20%27%25con%25%27%20and%20eEzsigndocumentStep%20eq%20%27PartiallySigned%27%20and%20fkiEzsignfoldertypeID%20in%20%271%2C2%2C3%27%20and%20dtEzsigndocumentDuedate%20rg%20%27%3Dm%2C%3Dm%2B7d%27`\n\n## Range operator\n\nDates in list filter can use a \"rg\" operator for ranges. This allows to filter data based on relative dates. The range operator is just another way to compute filters dates.\n\nFor the rest of this section, let's assume today's date is February 25th 2019 and the time is 10:15:37. Let's assume that we want to filter on dtInvoiceDate.\n\nIf we wanted to get all the invoices that were generated in the previous month, we could do (not url encoded for readability purposes):\nsFilter=dtInvoiceDate gte '2019-01-01 00:00:00' and dtInvoiceDate lte '2019-01-31 23:59:59'\n\nRange operator is useful to transfer the complexity of date computation to the api instead of the calling application.\n\nThe general format of the range operator is:\ndtInvoiceDate rg '**[STARTDATE]**,**[ENDDATE]**'\n\nBoth **[STARTDATE]** and **[ENDDATE]** use the same format which is a sequence of 1 or more **[SUBSECTION]** so for example, we could have:\ndtInvoiceDate rg '**[SUBSECTION]**,**[SUBSECTION][SUBSECTION][SUBSECTION][SUBSECTION]**'\n\nBoth **[STARTDATE]** and **[ENDDATE]** have a starting time equal to current time (so in this example 2019-02-25 10:15:37)\n\n**[SUBSECTION]** start with an operator which can be either **=** to reset the pointer, **+** to move forward in time or **-** to move backward in time. \n\nThe **=** operator can be directly followed by a letter representing the **[PERIOD]** (ex: **=m**) to initialize the date to the start or end of the period or by a number and a letter representing the **[PERIOD]** (ex: **=7m**) to set the **[PERIOD]** to a specific value.\n\nThe **+** and **-** operators are followed by a number then by a letter representing the **[PERIOD]** (ex: **+7d** or **-1m**)\n\nHere is a list of valid **[PERIOD]**\n\n| [Period] | Description |\n|---|---|\n| y | year |\n| m | month |\n| w | week |\n| d | day |\n| h | hour |\n| i | minute |\n| s | second |\n\n**=** operator without a number resets the pointer to either the beginning or the end of the **[Period]** depending if it's being used in the **[STARTDATE]** or **[ENDDATE]**. This table shows the time when the pointer is reset\n\n| Syntax | Description | [STARTDATE] | [ENDDATE] |\n|---|---|---|---|\n| =y | year | 2019-01-01 00:00:00 | 2019-12-31 23:59:59 |\n| =m | month | 2019-02-01 00:00:00 | 2019-02-28 23:59:59 |\n| =w | week\\* | 2019-02-24 00:00:00 | 2019-03-02 23:59:59 |\n| =d | day | 2019-02-25 00:00:00 | 2019-02-25 23:59:59 |\n| =h | hour | 2019-02-25 10:00:00 | 2019-02-25 10:59:59 |\n| =i | minute | 2019-02-25 10:15:00 | 2019-02-25 10:15:59 |\n| =s | second | 2019-02-25 10:15:37 | 2019-02-25 10:15:37 |\n\n\\* Week start day is configurable per user\n\n**=** operator with a number resets the **[PERIOD]** to a specific value and works the same for both **[STARTDATE]** or **[ENDDATE]**. Here are some example. Please note it's not possible to reset the week like this (ex: **=7w**)\n\n| Syntax | Description | New Date |\n|---|---|---|\n| =2025y | year | **2025**-02-25 10:15:37 |\n| =11m | month | 2019-**11**-25 10:15:37 |\n| =7d | day | 2019-02-**07** 10:15:37 |\n| =17h | hour | 2019-02-25 **17**:15:37 |\n| =1i | minute | 2019-02-25 10:**01**:37 |\n| =18s | second | 2019-02-25 10:15:**18** |\n\n### Combining [SUBSECTION]\n\nYou can combine multiple [SUBSECTION] under the same operator. For example:\n- Instead of using \"=m=7d=8h=6m=32s\" you can simplify as \"=m7d8h6m32s\"\n- Instead of using \"+7d+7h+7m+7s\" you can simplify as \"+7d7h7m7s\"\n- Instead of using \"=3m=m\" you can simplify as \"=3mm\"\n\n### Order of precedence\n\n**[STARTDATE]** and **[ENDDATE]** are evaluated from left to right. The order is important. For example, these values would give different results in **[ENDDATE]**:\n- \"=m-1m\" would give \"2019-01-28 23:59:59\"\n- \"-1m=m\" would give \"2019-01-31 23:59:59\"\n\n### Examples of use\n\n| Syntax | Explanation | Date From | Date To |\n|---|---|---|---|\n|sFilter=dtInvoice rg '-7d,=s'|Invoices in the last 7 days up to now|2019-02-18 10:15:37|2019-02-25 10:15:37|\n|sFilter=dtInvoice rg '=d-7d,=s'|Invoices in the last 7 days starting at 00:00:00 up to now|2019-02-18 00:00:00|2019-02-25 10:15:37|\n|sFilter=dtInvoice rg '=m-1m,=m-1m'|Invoices in the last month|2019-01-01 00:00:00|2019-01-31 23:59:59|\n|sFilter=dtInvoice rg '=m,=m'|Invoices in this month|2019-02-01 00:00:00|2019-02-28 23:59:59|\n|sFilter=dtInvoice rg '=m-1m+10d,=s'|Invoices since the 10th of last month up to now|2019-01-10 00:00:00|2019-02-25 10:15:37|\n|sFilter=dtInvoice rg '-10h,=d8h+1d1s'|Invoices in the last 10 hours up to 9h00 tomorrow morning|2019-02-25 00:15:37|2019-02-26 09:00:00|\n|sFilter=dtInvoice rg '-1y=4mm,=3mm'|Invoices from last year second semester up to this year first quarter|2018-04-01 00:00:00|2019-03-31 23:59:59|\n|sFilter=dtInvoice rg '=w-3w,=w'|Invoices in the last 3 weeks (calendar week start day = Sunday) up to the end of the week|2019-02-03 00:00:00|2019-03-02 23:59:59|\n|sFilter=dtInvoice rg '=y,=3mm'|Invoices in the first semester|2019-01-01 00:00:00|2019-03-31 23:59:59|\n|sFilter=dtInvoice rg '=4mm,=6mm'|Invoices in the second semester|2019-04-01 00:00:00|2019-06-30 23:59:59|\n|sFilter=dtInvoice rg '=7mm,=9mm'|Invoices in the third semester|2019-07-01 00:00:00|2019-09-30 23:59:59|\n|sFilter=dtInvoice rg '=10mm,=y'|Invoices in the last semester|2019-10-01 00:00:00|2019-12-31 23:59:59|\n",
"x-displayName": "Conventions"
},
{
"name": "General_ErrorCodes",
"description": "When the API returns an HTTP status code in the range 400-599, a JSON object will be returned with 2 properties:\r\n- eErrorCode\r\n- sErrorMessage\r\n\r\nWe highly suggest you use **eErrorCode** to do any error validation logic in your code or to create your own error message for your users. **sErrorMessage** has more detail for a human to read, but is intended for the developper and is always returned in English.\r\n\r\nHere is the complete list of **eErrorCode** you could receive for each HTTP status code and examples of situations where they could be returned.\r\n\r\n### HTTP 400 (Bad Request)\r\n| eErrorCode | Examples |\r\n| -------------------- | ------------------------------------------------------------------------------ |\r\n| BADREQUEST | Unserializable JSON, invalid parameter, invalid signature, invalid fingerprint |\r\n| BADREQUEST_CLOCKSKEW | The time on the client computer is wrong |\r\n\r\n### HTTP 401 (Unauthorized)\r\n| eErrorCode | Examples |\r\n| -------------------- | ------------------------------------------------------------------ |\r\n| UNAUTHORIZED_BADAUTH | Invalid credentials during Authentication |\r\n| UNAUTHORIZED_BADMFA | Invalid response to the MFA challenge |\r\n| UNAUTHORIZED_EXPIRED | Credentials have expired |\r\n| UNAUTHORIZED_REQUEST | The request is invalid (bad ip source, signature, invalid api key) |\r\n\r\n### HTTP 403 (Forbidden)\r\n| eErrorCode | Examples |\r\n| ------------------------------ | --------------------------------------------------- |\r\n| FORBIDDEN | Generic Forbidden |\r\n| FORBIDDEN_CONFIGURATION | A configured setting prevent access to the element |\r\n| FORBIDDEN_MODULE | Module is not activated |\r\n| FORBIDDEN_NOACCESS | Not allowed to access the element |\r\n| FORBIDDEN_PERMISSION | Missing a permission to access the route |\r\n| FORBIDDEN_SUBSCRIPTION | No subscription, for example to eZsign |\r\n| FORBIDDEN_USERTYPE | This type of User is forbidden for the route |\r\n| FORBIDDEN_USER_ORIGIN_EXTERNAL | Can't modify user informations. |\r\n\r\n### HTTP 404 (Not Found)\r\n| eErrorCode | Examples |\r\n| --------------- | ------------------------------------------- |\r\n| NOTFOUND | Generic not found |\r\n| NOTFOUND_OBJECT | Object does not exist in database |\r\n| NOTFOUND_ROUTE | The route does not exist (url, API version) |\r\n\r\n### HTTP 405 (Method Not Allowed)\r\n| eErrorCode | Examples |\r\n| ---------------- | ----------------------------------------------------------------------------- |\r\n| METHODNOTALLOWED | The route is valid but the method is not allowed ex: POST on a GET only route |\r\n\r\n### HTTP 406 (Not Acceptable)\r\n| eErrorCode | Examples |\r\n| ---------------------- | --------------------------------------------------------------------------------------------- |\r\n| NOTACCEPTABLE_CONTENT | The route is valid but the Accept header is not allowed ex: \"application/json\" vs \"image/png\" |\r\n| NOTACCEPTABLE_LANGUAGE | The route is valid but the Accept-Language header is not allowed ex: \"en\" vs \"es\" |\r\n\r\n### HTTP 422 (Unprocessable entity)\r\n| eErrorCode | Examples |\r\n| -------------------------------------- | ---------------------------------------------------------------------- |\r\n| UNPROCESSABLEENTITY_ACTIVESESSION_ALREADY_CLONING | The user is already cloning another user |\r\n| UNPROCESSABLEENTITY_CANNOTDELETE | The element cannot be deleted |\r\n| UNPROCESSABLEENTITY_CANNOTMODIFY | The element cannot be modified |\r\n| UNPROCESSABLEENTITY_CHANGEPASSWORD_INVALID_CURRENT | The old password supplied does not match the user's current password |\r\n| UNPROCESSABLEENTITY_CHANGEPASSWORD_SAME | The new password is the same as the old password |\r\n| UNPROCESSABLEENTITY_DATA_MISSING | Some data is missing |\r\n| UNPROCESSABLEENTITY_DATA_UNIQUE | The data fails unique check : value exist in other element |\r\n| UNPROCESSABLEENTITY_DATA_VALIDATION | The data fails some validation |\r\n| UNPROCESSABLEENTITY_DATA_OUTOFBOUND | The data contains a value that is out of bound |\r\n| UNPROCESSABLEENTITY_DOWNLOAD_ERROR | We cannot retrieve ressource at supplied url |\r\n| UNPROCESSABLEENTITY_EZSIGNFORM_VALIDATION | The validation of the Ezsignform returned some errors |\r\n| UNPROCESSABLEENTITY_EZSIGNSIGNERCONNECTED | The Ezsignsigner is connected |\r\n| UNPROCESSABLEENTITY_NOTHINGTODO | The request was valid, but no action was necessary |\r\n| UNPROCESSABLEENTITY_NOTREADY | The element is not in a state that allows the action (Sending a document without signature, downloading an unsigned document) |\r\n| UNPROCESSABLEENTITY_PDF_FORM | The pdf document contains a form |\r\n| UNPROCESSABLEENTITY_PDF_SIGNATURE | The pdf document contains a signature(s) |\r\n| UNPROCESSABLEENTITY_PDF_FORM_AND_SIGNATURE | The pdf document contains a form and signature(s) |\r\n| UNPROCESSABLEENTITY_PDF_INCOMPATIBLE | The pdf document cannot be signed |\r\n| UNPROCESSABLEENTITY_PDF_PASSWORD | The pdf document contains a password and cannot be signed |\r\n| UNPROCESSABLEENTITY_PDF_WRONG_PASSWORD | The password cannot open the pdf document since it's incorrect |\r\n| UNPROCESSABLEENTITY_PDF_REPAIRABLE | The pdf document contains errors and can be repaired |\r\n| UNPROCESSABLEENTITY_PDF_XFA | The pdf document contains XFA form and cannot be signed |\r\n| UNPROCESSABLEENTITY_TEMPLATE_MISMATCH | The number of pages between the document and the template do not match |\r\n| UNPROCESSABLEENTITY_UNMODIFIABLE_FIELD | The field is not modifiable in the current state |\r\n| UNPROCESSABLEENTITY_USER_STAGED | The user can't connect since it's currently staged |\r\n\r\n### HTTP 429 (Too Many Requests)\r\n| eErrorCode | Examples |\r\n| -------------------------------------- | ---------------------------------------------------------------------- |\r\n| TOOMANYREQUESTS | The client reached the maximum number of requests allowed in the specific time |\r\n| TOOMANYREQUESTS_THIRDPARTY | Our server encountered a 'Too Many Requests' error from a third party |\r\n\r\n### HTTP 500 (Internal Server Error)\r\n| eErrorCode | Examples |\r\n| -------------- | ------------------------- |\r\n| ERROR_INTERNAL | Unhandled error on server |\r\n| ERROR_CONFIGURATION | A parameter on the server is not configured properly |\r\n\r\n### HTTP 501 (Not Implemented)\r\n| eErrorCode | Examples |\r\n| -------------------- | -------------------------------------------------------- |\r\n| ERROR_NOTIMPLEMENTED | Endpoint not yet available in your region or environment |",
"x-displayName": "Error Codes"
},
{
"name": "General_Introduction",
"description": "We publish everything related to our API on github at this location: <a href=\"https://github.com/eZmaxinc\" target=\"_blank\">https://github.com/eZmaxinc</a>. You'll find git repos for the specification, documentation, SDKs and samples.\n\nDocumentation, SDKs and samples are provided in English only for easier maintenance, but we also have French speaking integrators that can help you out.\n\nMost of our SDKs provide language specific documentation, but you'll find more details on this page about the general use of the API. Both the SDK's specific document (if you choose to use a SDK) and this documentation can be used in complementarity.\n\nIf you find any mistake or omission in the documentation, please notify us. We'll quickly fix the issue.\n\n## Onboarding\nWe highly recommend to schedule an online meeting with your technical team and an eZmax integrator. During this meeting, we go through requirements, business logic, configuration, api key generation, and we go through the list of functions you might need to implement to achieve your goals. Make sure you take this opportunity to speed up your integration project.\n\nIf you need help understanding how to use this API, don't waste too much time searching in it. Contact support-api@ezmax.ca, we're here to help. We are developpers so we know programmers don't like to waste time in documentation. If you don't find what you need in the documentation, let us know, we'll improve it and put you rapidly up on track.\n\n## Open API\nWe highly believe in open standards and open source. We have adopted the Open API vision where all of the functionnalities of our applications are accessible with open source definition files. We use our own public API's to build our interfaces so you can do pretty much everything we can do. Open API has a rich toolset from editor, generators, mock servers, validators, etc. Learn more at <a href=\"https://www.openapis.org/\" target=\"_blank\">OpenAPI Initiative</a>\n\nIf you need our Open API Spec file to use in your toolset, here is a direct link to it: <a href=\"https://raw.githubusercontent.com/eZmaxinc/eZmax-API/master/specs/ezmax.v1.1.json\" target=\"_blank\">ezmax.v1.1.json</a>\n\n## SDK\nWe provide SDKs for customers. They are generated using <a href=\"https://openapi-generator.tech/\" target=\"_blank\">OpenAPI Generator</a>, we encourage customers to use them as we also provide samples for them. You can choose to build your own implementation manually or can use any compatible OpenAPI 3.0 generator like <a href=\"https://openapi-generator.tech/\" target=\"_blank\">OpenAPI Generator</a>, <a href=\"https://swagger.io/tools/swagger-codegen/\" target=\"_blank\">Swagger Codegen</a> or any commercial generators.\n\nWe try to make it as easy as possible for you to use our SDKs so we publish packages on NPM and Composer. If you don't find your favorite language supported or it we could make your life easier by automating package distribution, let us know !",
"x-displayName": "Introduction"
},
{
"name": "General_Security",
"description": "## Authorization\n\nExcept for a few functions that do not require authorization, most of the functions require an API key that is sent in the request headers. The header name is \"Authorization\". \n\nThere are 5 types of API Key that can be used to make requests to the API.\n\n1. **API type key** which is static and not session based. It can be generated from the admin console. This is the most common type of authentication for \"server to server\" kind of integration. Never use this in a web based (client) application as the key could be leaked. This type of key begins with the letter **A**.\n\n2. **Delegated type key** which has an expiration time. It is commonly used in mobile or web application where you cannot use an **API type key** that could be leaked. The application would query a server part that will generate a **Delegated type key** using an **API type key**. The **Delegated type key** could now be used by the mobile or web page application without leaking the **API type key**. This type of key begins with the letter **D**.\n\n3. **User type key** which are session based and can be retrieved after a successful authentication. This type of key is reserved to specific situations where the other types of key are not desirable. This type of key begins with the letter **U**.\n\n4. **Presigned type key** which are used to presign a url. These keys have an expiration date configured at signing time. This type of key begins with the letter **P**.\n\n5. **Special type key** which are for special cases where other types of keys cannot be used. This type of key is reserved to specific situations. This type of key begins with the letter **S**.\n\n## IP restriction\n\nEach API key can be restricted to specific IP addresse(s). This is an optional but recommended security feature you should put in place if all your requests will be coming from a specific range. You can configure the allowed ranges from the eZmax administration console.\n\n## Permissions\n\nEach API Key can be configured to have specific permission(s) so we highly recommend to use the \"Least privileges\" principle. For example, instead of allowing all permissions to an API Key, you should perhaps create an API Keys each for each of your application having just the specific permissions needed. You can configure the API Key's permission in eZmax's administration console.\n\n## Request Signing\n\nRequest Signing is a process of signing the request with a **Secret** that is not transmitted over the Wire. The signing process improves security in case your API Key is leaked or during a MITM attack (Man in the Middle). It will also prevent request manipulation or replay attack. Since all requests must use **https** these kinds of attacks are hard to conduct but sometimes customers might not be aware their underlying library does not verify SSL Certs validity or that their application can disclose their API key if it's not well secured. It takes a bit of effort to sign requests but it's highly recommended to do so.\n\nMandatory requirements of signing varies by used key type. For **API** type keys (most common type), you can configure if signing is mandatory or not in eZmax's administration console. **Delegated**, **User** and **Special** type keys must sign requests otherwise requests will fail.\n\n### How to sign a request\n\nTo apply a signature to your request you will need to send 3 or 4 additional HTTP Headers to the request:\n- Ezmax-Date\n- Ezmax-Expiration (Optional)\n- Ezmax-Fingerprint\n- Ezmax-Signature\n\n### Ezmax-Date\n\n**Ezmax-Date** Is the date/time when you send the request. It needs to be a <a href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601</a> formatted date/time. It's a format that supports timezones so you can either use your local timezone of GMT. Be aware certain implementation adds milliseconds to the formatted date which won't be accepted by the API (ex: Javascript's toISOString function).\n\nThere is a tolerance of ±5 minutes clock skew between the date/time you specify and the server's time so make sure your time is correct. Usage of a NTP server is recommended. Compute the date/time as close as possible to the actual sending of the request. For example, don't set the current time at the beginning of a long running script that sends 50 requests to the server with the same time/date as you might receive errors related to clock skew.\n\nExamples:\n- 2000-12-31T23:59:59Z\n- 2000-12-31T23:59:59-05:00\n \n### Ezmax-Expiration\n\n**Ezmax-Expiration** Is optional. It must be a positive integer representing the number of minutes (starting from Ezmax-Date) after which the signed request will be considered expired.\n\n### Ezmax-Fingerprint\n\n**Ezmax-Fingerprint** Is a fingerprint (aka hash) representing the request you are sending. Any alteration in any part of the request would produce a different fingerprint. The hash is computed using <a href=\"https://en.wikipedia.org/wiki/SHA-2\" target=\"_blank\">SHA256</a>. Most programming languages offer an implementation of SHA256. To make sure your implementation is producing expected values, try to hash the value \"foo\", it should produce the value \"2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae\".\n\nTo compute the Fingerprint, you'll need to concatenate the **Method**, the **URL**, the **Body**, the **API Key**, the **Date** and the **Expiration** (**Expiration** must be appended only if defined). All these values will need to be separated by a line Feed caracter (\\n). Make sure your **Method** is Uppercase (Shoud be \"GET\", not \"Get\" or \"get\"). Make sure your URL Scheme and Host or the **URL** are lowercase (Should be \"https://www.example.com\", not \"HTTPS://WWW.EXAMPLE.COM\"). Also make sure the the URI part of the **URL** is properly URL encoded (Should be \"/Path%20with%20Spaces/?Key=Value%20with%20Spaces\", not \"/Path with Spaces/?Key=Value with Spaces\". If the **Body** is empty (ex: GET request don't have a body), use an empty string.\n\nOnce the SHA256 hash is computed, prefix it with \"v1=\" which is future proofing version identifier.\n\nHere is an example implementation in PHP:\n\n public static function getFingerprintV1 ($sAuthorization, $dtDate, $sMethod, $sURL, $sBody = '', $iExpiration = null) {\n $sContentToHash = \"$sMethod\\n$sURL\\n$sBody\\n$sAuthorization\\n$dtDate\" . (is_null($iExpiration) ? '' : \"\\n$iExpiration\");\n return 'v1='.hash('sha256', $sContentToHash);\n }\n\nHere are two examples of what a GET and POST requests Fingerprints could look like. You can validate if your algorithm work by using these sample values and comparing them to the expected values. In the example below the litteral \"\\n\" should be replaced with a linefeed character.\n\n GET\\n\n https://prod.api.appcluster01.ca-central-1.ezmax.com/rest/1/object/activesession/getCurrent\\n\n \\n\n ThisIsMyAuthorizationKey\\n\n 2000-12-31T23:59:59Z\nExpected result for **Ezmax-Fingerprint** (GET): v1=8f6f3ed75edb6e2cbe777b4fda5cab1a6adaebadc758780eb82c3d49934f354a\n\n POST\\n\n https://prod.api.global.ezmax.com/1/module/sspr/sendUsernames\\n\n {\"pksCustomerCode\": \"demo\",\"fkiLanguageID\": \"2\",\"eUserTypeSSPR\": \"Native\",\"sEmailAddress\": \"email@example.com\"}\\n\n ThisIsMyAuthorizationKey\\n\n 2000-12-31T23:59:59Z\nExpected result for **Ezmax-Fingerprint** (POST): v1=6dbdbc26437f1216f9cd0068a4fc35c272a062b1f638c7557d497ebbf3702ded\n\n### Ezmax-Signature\n\n**Ezmax-Signature** Is the actual signature proving the request was generated by the key owner using its secret. The signature is computed using <a href=\"https://en.wikipedia.org/wiki/HMAC\" target=\"_blank\">HMAC</a> and <a href=\"https://en.wikipedia.org/wiki/SHA-2\" target=\"_blank\">SHA256</a>. Don't confuse **SHA256 (aka SHA2-256)** and **SHA3-256**, these are 2 distinct algorithms. Most programming languages offer an implementation of HMAC with SHA256. To make sure your implementation is producing expected values, try to hash the value \"foo\" with the key \"bar\", it should produce the value \"147933218aaabc0b8b10a2b3a5c34684c8d94341bcf10a4736dc7270f7741851\".\n\nTo compute the Signature, you'll need to concatenate the **Ezmax-Fingerprint**, the **API Key** and the **Ezmax-Date**. The 3 values are concatenated WITHOUT separators. Then calculate the HMAC using SHA256 using your **Secret** as the key.\n\nOnce the HMAC-SHA256 hash is computed, prefix it with \"v1=\" which is future proofing version identifier.\n\nHere is an example implementation in PHP:\n\n public static function getSignatureV1 ($sAuthorization, $dtDate, $sFingerprint, $sSecret) {\n $sContentToSign = \"$sFingerprint$sAuthorization$dtDate\";\n return 'v1='.hash_hmac('sha256', $sContentToSign, $sSecret);\n }\n\nHere are two examples of what the GET and POST requests Signature would be. You can validate if your algorithm work by using these sample values and comparing them to the expected values. For the below examples, we have used the same **API Key**, **Fingerprint** and **Date** as in the Fingerprint section above. The only new variable is the **Secret** which is \"ThisIsTheSecretAssociatedToTheAuthorizationKey\" for this example.\n\n v1=8f6f3ed75edb6e2cbe777b4fda5cab1a6adaebadc758780eb82c3d49934f354aThisIsMyAuthorizationKey2000-12-31T23:59:59Z\nExpected result for **Ezmax-Signature** (GET): v1=3a95fde64d27527745bcb0dd91be8caf7917c6778197e22d1d56c87245f979f5\n\n v1=6dbdbc26437f1216f9cd0068a4fc35c272a062b1f638c7557d497ebbf3702dedThisIsMyAuthorizationKey2000-12-31T23:59:59Z\nExpected result for **Ezmax-Signature** (POST): v1=71e05f01eaab704ec76a078a9a5c49abe9d5a490786e43b86156d281acda7cba\n\n### Wrapping up the examples\n\nThe whole process was detailed above but here is summary of what your http headers should look like to sign these example requests considering the following common variables:\n\n| Variable | Example value |\n| ------------- | ---------------------------------------------- |\n| Date | 2000-12-31T23:59:59Z |\n| Authorization | ThisIsMyAuthorizationKey |\n| Secret | ThisIsTheSecretAssociatedToTheAuthorizationKey |\n\nFor a GET request to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest/1/object/activesession/getCurrent:\n\n Authorization: ThisIsMyAuthorizationKey\n Ezmax-Date: 2000-12-31T23:59:59Z\n Ezmax-Fingerprint: v1=8f6f3ed75edb6e2cbe777b4fda5cab1a6adaebadc758780eb82c3d49934f354a\n Ezmax-Signature: v1=3a95fde64d27527745bcb0dd91be8caf7917c6778197e22d1d56c87245f979f5\n\nFor a POST request to https://prod.api.global.ezmax.com/1/module/sspr/sendUsernames with this body content = '{\"pksCustomerCode\": \"demo\",\"fkiLanguageID\": \"2\",\"eUserTypeSSPR\": \"Native\",\"sEmailAddress\": \"emain@example.com\"}' :\n\n Authorization: ThisIsMyAuthorizationKey\n Ezmax-Date: 2000-12-31T23:59:59Z\n Ezmax-Fingerprint: v1=6dbdbc26437f1216f9cd0068a4fc35c272a062b1f638c7557d497ebbf3702ded\n Ezmax-Signature: v1=71e05f01eaab704ec76a078a9a5c49abe9d5a490786e43b86156d281acda7cba",
"x-displayName": "Security"
},
{
"name": "General_Servers",
"description": "## Regional requests\nWhen you send your API requests, you'll need to send them in the proper region and proper environment where your customer data are stored. Based on your requirements (proximity and legislation), we will create your environment in one of our supported region's.\n\nThe general format of the URL where to send requests is:\nhttps://**{sInfrastructureenvironmenttypeDescription}**.api.appcluster01.**{sInfrastructureregionCode}**.ezmax.com/rest/\n\nWhere \"**{sInfrastructureenvironmenttypeDescription}**\" and \"**{sInfrastructureregionCode}**\" need to be replaced with one of the values in the table below.\n\n## Global requests\nSome of the functions needs to be called on the global infrastructure instead of the regional servers. These functions are all located in the **Global** section of the documentation.\n\nThe general format of the URL where to send requests is:\nhttps://**{sInfrastructureenvironmenttypeDescription}**.api.global.ezmax.com/\n\nWhere \"**{sInfrastructureenvironmenttypeDescription}**\" needs to be replaced with one of the values in the tables below.\n\n## Websocket requests\nWhen you send your Websocket requests, you'll need to send them in the proper region and proper environment where your customer data are stored. Based on your requirements (proximity and legislation), we will create your environment in one of our supported region's.\n\nThe general format of the URL where to send requests is:\nwss://ws.**{sInfrastructureregionCode}**.ezmax.com/**{sInfrastructureenvironmenttypeDescription}**/\n\nWhere \"**{sInfrastructureregionCode}**\" and \"**{sInfrastructureenvironmenttypeDescription}**\" need to be replaced with one of the values in the tables below.\n\n## Environments\n\n| sInfrastructureenvironmenttypeDescription | Description |\n| ----------------------------------------- | ----------------- |\n| prod | Production |\n| stg | Staging |\n| qa | Quality Assurance |\n| dev | Development |\n\nNote: You should always use \"prod\" for the environment unless otherwise instructed by eZmax's support.\n\n## Regions\n\n| sInfrastructureregionCode | Description |\n| ------------------------- | -------------------------- |\n| af-south-1\t | Africa (Cape Town) |\n| ap-east-1\t | Asia Pacific (Hong Kong) |\n| ap-northeast-1\t | Asia Pacific (Tokyo) |\n| ap-northeast-2\t | Asia Pacific (Seoul) |\n| ap-northeast-3\t | Asia Pacific (Osaka-Local) |\n| ap-south-1\t | Asia Pacific (Mumbai) |\n| ap-southeast-1\t | Asia Pacific (Singapore) |\n| ap-southeast-2\t | Asia Pacific (Sydney) |\n| ca-central-1\t | Canada (Central) |\n| eu-central-1\t | Europe (Frankfurt) |\n| eu-north-1\t | Europe (Stockholm) |\n| eu-south-1\t | Europe (Milan) |\n| eu-west-1\t | Europe (Ireland) |\n| eu-west-2\t | Europe (London) |\n| eu-west-3\t | Europe (Paris) |\n| sa-east-1\t | South America (São Paulo) |\n| us-east-1\t | US East (N. Virginia) |\n| us-east-2\t | US East (Ohio) |\n| us-west-1\t | US West (N. California) |\n| us-west-2\t | US West (Oregon) |\n\nNote Our SDKs have a default value of \"ca-central-1\". You will need to call \"setHost\" to change the default value if needed.",
"x-displayName": "Servers"
},
{
"name": "General_StatusCodes",
"description": "We use standard HTTP Status Codes to return details about completed function calls.\r\n\r\nYou should always validate the HTTP response's status code before trying to read the content of the body. Our SDKs do this automatically. In each of the documented function, we document only the function's specific return code to facilitate the reading of the documentation. Even if a generic return code is not documented at the function's level, it could be returned by the API.\r\n\r\n### Generic return codes (Documented at the function's level)\r\n| HTTP Status Code | Meaning | Detail |\r\n| ---------------- | -------------------- | ------ |\r\n| 200 | OK | The request completed successfully and valid data was returned in the body |\r\n| 201 | Created | The request completed successfully. Some elements were created and details about the created items was returned in the body |\r\n| 204 | No Content | The request completed successfully. There was no need to return any data in the body |\r\n| 403 | Forbidden | The request is not allowed to be executed. Look for detail about the error in the body |\r\n| 404 | Not Found | The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body |\r\n| 406 | Not Acceptable | The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header \"Accept: application/json\" but the function can only return \"Content-type: image/png\" |\r\n| 422 | Unprocessable entity | The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body |\r\n\r\n### Generic return codes (Undocumented at the function's level)\r\n| HTTP Status Code | Meaning | Detail |\r\n| ---------------- | --------------------- | ------ |\r\n| 400 | Bad Request | The request does not meet specifications. For example: an invalid type for a variable, a value that does not pass validation or a protocol violation. Look for details about the error in the response's body |\r\n| 401 | Unauthorized | The API Key is either not present, expired, invalid or inactive. It could also mean you are calling the API from an unauthorized IP address |\r\n| 403 | Forbidden | The Provided API Key is valid, but it is not allowed to execute the request. Verify the Key's permissions |\r\n| 404 | Not Found | Your request was sent to a URL that does not exist. Make sure you are calling the proper version number of the function and look for typos in the URL |\r\n| 405 | Method Not Allowed | The URL is valid, but the Method is not allowed. For example, have you call a GET while the function expects a POST ? |\r\n| 406 | Not Acceptable | The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header \"Accept: application/json\" but the function can only return \"Content-type: image/png\" |\r\n| 429 | Too Many Requests | Too many requests were received from your API Key/IP address. Make sure to optimize your requests or ask for a limit increase. For example, make a single request to create 100 objects instead of calling 100 requests each creating a single objet |\r\n| 500 | Internal Server Error | This should never happen. There is either a temporary problem that should resolve quickly or an error you should report to technical support. |\r\n| 501 | Not Implemented | Endpoint not yet available in your region or environment |\r\n| 503 | Service Unavailable | This should never happen. There is either a temporary problem that should resolve quickly or an error you should report to technical support |\r\n\r\n### Custom return codes (Undocumented at the function's level)\r\nThese codes can only be generated for **User** type API Key. The **API**, **Delegated** and **Special** types keys will never return such codes. (See Authorization section for more information). Most users should not be concerned with these status codes.\r\n\r\nThese codes are documented in the Activesession getCurrent endpoint only to simplify the documentation but they can be returned in any of the endpoints.\r\n\r\n| HTTP Status Code | Meaning | Detail |\r\n| ---------------- | -------------------------------- | -------------------------------------------------------------------- |\r\n| 350 | Authentication required | User must authenticate because session is invalid |\r\n| 351 | Phone Validation required | (2FA) User needs to complete a Voice Call or SMS challenge |\r\n| 352 | Question Validation required | (2FA) User needs to complete a question/answer challenge |\r\n| 353 | Clause Acceptance required | User need to accept electronic signature terms and conditions |\r\n| 354 | Computer Validation required | User's computer is not authorized |\r\n| 355 | Password Change required | User must change it's password |\r\n| 356 | Native Application Version Check | The user is not running the latest version of the native application |\r\n\r\n### Webhook delivery successful code\r\nThese codes will be considered as a succesful delivery when they are returned by your webpage during a Webhook delivery.\r\n\r\n| HTTP Status Code | Meaning | Detail |\r\n| ---------------- | -------------------- | ------ |\r\n| 202 | Accepted | The request has been received but not yet acted upon. It is intended for cases where another process or server handles the request, or for batch processing. |\r\n| 204 | No Content | The request completed successfully. There was no need to return any data in the body |\r\n",
"x-displayName": "Status Codes"
},
{
"name": "General_WarningCodes",
"description": "When the API returns an HTTP status code in the range 200-299, a property could be returned indicating one or more warnings occured. The array contain objects with 2 properties:\r\n- eWarningCode\r\n- sWarningMessage\r\n\r\nWe highly suggest you use **eWarningCode** to do any warning validation logic in your code or to create your own warning message for your users. **sWarningMessage** has more detail for a human to read, but is intended for the developper and is always returned in English.\r\n\r\nHere is the complete list of **eWarningCode** you could receive.\r\n\r\n| eWarningCode | Examples |\r\n| -------------------- | -------------------------------------------------------- |\r\n| MUSTVERIFY | An object was changed and a verification is recommended |",
"x-displayName": "Warning Codes"
},
{
"name": "General_Webhooks",
"description": "## Concept\nA Webhook (also called a web callback or HTTP push API) is a way for your application to be notified of an event in real time.\n\nFor example, if you send a contract for signing and need to be notified as soon as it get signed.\n\nYou could program a loop to query the document status every 5 minutes for many days until you receive a response saying the document is signed. This is a bad approach as it will waste a lot of resources everytime you make a call to the API for no reason.\n\nA better approach would be to configure a webhook in the eZmax's administration console to watch for a specific event. In this exemple, the event to monitor is \"DocumentCompleted\" from the module \"Ezsign\". This way, as soon as the document gets signed, a request will be made to YOUR server to let you know about the event that just happened.\n\nWhen you configure eZmax to notify you of events, you must provide your server's URL and a fallback email address. The URL provided must use HTTPS for security reasons.\n\n### Types of Webhook:\nLook for red indicators with the word \"EVENT\" throughout the documentation to see currently available Webhooks events you can subscribe to. If you have a need for an event that is not available, please send a feature request to technical support.\n\n### Important:\n- The event will be delivered using a POST request.\n- Your server will need to reply with a HTTP Status Code 202 or 204 to let eZmax know you've accepted the message and we shall not try to deliver the message again. If the server does not respond with a 202 or 204 Code, the message will be sent over and over until all tries are exhausted.\n- The 202 or 204 response must be returned in less than 30 seconds otherwise a timeout will occur and the event will be retried following the retry schedule.\n- Make sure to secure your Webhook receiving URL to make sure someone does not send forged messages to your application. You can do this by providing a secure token in your URL, for example \"?token=mysecuretoken1234\", or by validating the webhook message's signature.\n\n### Testing\nIn eZmax's administration module, you'll find a \"Test\" button that you can use as many time as you need to test your server code easily with a sample event.\n\n## Retries\neZmax will attempt to deliver the event to your server instantly but will retry many times if your server does not respond successfully for some reason (see schedule below). After all attempts are exhausted, the event will be forwarded to the configured fallback email in the same format as the webhook. The email body will contain the JSON request in the same format as the webhook. This way, you'll be able to send the request to your server using <a href=\"https://www.postman.com/\" target=\"_blank\">Postman</a>, <a href=\"https://curl.se/\" target=\"_blank\">Curl</a> or similar tool.\n\n### Retry Delivery schedule\nThis is the approximate retry schedule. Since there is a 30 seconds timeout on each try, there could be a cumulative overhead up to 3½ minutes.\n\n| Minutes after previous step | Minutes after event | Method |\n| :-------------------------: | :-----------------: | ------ |\n| N/A | 0 | HTTPS |\n| 1 | 1 | HTTPS |\n| 5 | 6 | HTTPS |\n| 15 | 21 | HTTPS |\n| 15 | 36 | HTTPS |\n| 15 | 51 | HTTPS |\n| 15 | 66 | HTTPS |\n| 0 | 66 | Email |\n\n### Failed attempt reporting\nIf you don't receive the event on the first attempt, there will be debugging information about each previous attempt in the body of the event. You'll be able to see the timestamp of each previous attempt and the return code returned by your server or a timeout indication if your server hasn't replied.\n",
"x-displayName": "Webhooks"
},
{
"name": "Global_Customer",
"description": "Customer contains details about the customer code assigned to your account",
"x-displayName": "Customer"
},
{
"name": "Global_Ezmaxclient",
"description": "Ezmaxclient contains details about the native Ezmax Applications",
"x-displayName": "Ezmaxclient"
},
{
"name": "Global_Ezmaxcustomer",
"description": "Customer contains details about the customer code assigned to your account",
"x-displayName": "Ezmaxcustomer"
},
{
"name": "Module_Ezsign",
"description": "Ezsign contains actions related to Ezsign",
"x-displayName": "Ezsign"
},
{
"name": "Module_Report",
"description": "Report contains actions related to utility functions for the reports",
"x-displayName": "Report"
},
{
"name": "Module_User",
"description": "User module contains actions that can be called to interract with users",
"x-displayName": "User"
},
{
"name": "Object_Activesession",
"description": "Activesession contains detail about the currently executing api request",
"x-displayName": "Activesession"
},
{
"name": "Object_Apikey",
"description": "Apikey contains detail about an api key used to access the API",
"x-displayName": "Apikey"
},
{
"name": "Object_Billingentityexternal",
"description": "Billingentityexternal is used to automatically send the invoice to a customer's system.",
"x-displayName": "Billingentityexternal"
},
{
"name": "Object_Billingentityinternal",
"description": "Billingentityinternal contains detail about internal cost separation",
"x-displayName": "Billingentityinternal"
},
{
"name": "Object_Branding",
"description": "Branding contains detail about a company Branding",
"x-displayName": "Branding"
},
{
"name": "Object_Clonehistory",
"description": "Clonehistory contains details about Clonehistorys",
"x-displayName": "Clonehistory"
},
{
"name": "Object_Communication",
"description": "Communication contains detail about a Communication",
"x-displayName": "Communication"
},
{
"name": "Object_Company",
"description": "Company contains details about Companys",
"x-displayName": "Company"
},
{
"name": "Object_Cors",
"description": "Cors contains details about Cors",
"x-displayName": "Cors"
},
{
"name": "Object_Department",
"description": "Department contains detail about a Department",
"x-displayName": "Department"
},
{
"name": "Object_Emailtype",
"description": "Emailtype contains details about Emailtypes",
"x-displayName": "Emailtype"
},
{
"name": "Object_Ezmaxinvoicing",
"description": "Ezmaxinvoicing contains detail about a Ezmaxinvoicing",
"x-displayName": "Ezmaxinvoicing"
},
{
"name": "Object_Ezmaxproduct",
"description": "Ezmaxproduct contains details about Ezmaxproducts",
"x-displayName": "Ezmaxproduct"
},
{
"name": "Object_Ezsignbulksend",
"description": "Ezsignbulksend contains detail about a batch of Ezsignbulksendtransmission",
"x-displayName": "Ezsignbulksend"
},
{
"name": "Object_Ezsignbulksenddocumentmapping",
"description": "Ezsignbulksenddocumentmapping contains detail about a Ezsigntemplate or Ezsigntemplatepackage contained in a Ezsignbulksend",
"x-displayName": "Ezsignbulksenddocumentmapping"
},
{
"name": "Object_Ezsignbulksendsignermapping",
"description": "Ezsignbulksendsignermapping contains detail about a signer role in the Ezsignbulksend",
"x-displayName": "Ezsignbulksendsignermapping"
},
{
"name": "Object_Ezsignbulksendtransmission",
"description": "Ezsignbulksendtransmission contains detail about a batch of Ezsignfolders",
"x-displayName": "Ezsignbulksendtransmission"
},
{
"name": "Object_Ezsigndocument",
"description": "Ezsigndocument contains detail about a document to sign",
"x-displayName": "Ezsigndocument"
},
{
"name": "Object_Ezsignfolder",
"description": "Ezsignfolder contains detail about the container containing signers, documents to sign, etc. Sometimes referred as \"Envelopes\" in competitor products",
"x-displayName": "Ezsignfolder"
},
{
"name": "Object_Ezsignfoldersignerassociation",
"description": "Ezsignfoldersignerassociation contains detail about the signers that will be invited to sign the documents. Signers can be users from the system or persons outside of the system.",
"x-displayName": "Ezsignfoldersignerassociation"
},
{
"name": "Object_Ezsignfoldertype",
"description": "Ezsignfoldertype contains detail about the types of Ezsignfolders",
"x-displayName": "Ezsignfoldertype"
},
{
"name": "Object_Ezsignformfieldgroup",
"description": "Ezsignformfieldgroup contains detail about a specific group of form blocks on a page of a Ezsigndocument",
"x-displayName": "Ezsignformfieldgroup"
},
{
"name": "Object_Ezsignpage",
"description": "Ezsignpage contains details about Ezsignpages",
"x-displayName": "Ezsignpage"
},
{
"name": "Object_Ezsignsignature",
"description": "Ezsignsignature contains detail about a specific signature block on a page of a Ezsigndocument",
"x-displayName": "Ezsignsignature"
},
{
"name": "Object_Ezsignsignergroup",
"description": "Ezsignsignergroup contains details about Ezsignsignergroups",
"x-displayName": "Ezsignsignergroup"
},
{
"name": "Object_Ezsignsignergroupmembership",
"description": "Ezsignsignergroupmembership contains details about Ezsignsignergroupmemberships",
"x-displayName": "Ezsignsignergroupmembership"
},
{
"name": "Object_Ezsigntemplate",
"description": "Ezsigntemplate contains detail about Document types and block templates",
"x-displayName": "Ezsigntemplate"
},
{
"name": "Object_Ezsigntemplatedocument",
"description": "Ezsigntemplatedocument contains detail about a document in an Ezsigntemplate",
"x-displayName": "Ezsigntemplatedocument"
},
{
"name": "Object_Ezsigntemplateformfieldgroup",
"description": "Ezsigntemplateformfieldgroup contains detail about a specific group of form blocks on a page of a Ezsigntemplatedocument",
"x-displayName": "Ezsigntemplateformfieldgroup"
},
{
"name": "Object_Ezsigntemplatepackage",
"description": "Ezsigntemplatepackage contains detail about a package of ezsign templates that can be used as a whole",
"x-displayName": "Ezsigntemplatepackage"
},
{
"name": "Object_Ezsigntemplatepackagemembership",
"description": "Ezsigntemplatepackagemembership contains detail about a relation between the Ezsigntemplatepackage and the Ezsigntemplate",
"x-displayName": "Ezsigntemplatepackagemembership"
},
{
"name": "Object_Ezsigntemplatepackagesigner",
"description": "Ezsigntemplatepackagesigner contains detail about a signer role in an Ezsigntemplatepackage",
"x-displayName": "Ezsigntemplatepackagesigner"
},
{
"name": "Object_Ezsigntemplatepackagesignermembership",
"description": "Ezsigntemplatepackagesignermembership contains detail about the mapping of Ezsigntemplatepackagesigner to Ezsigntemplatesigner in a Ezsigntemplatepackagemembership",
"x-displayName": "Ezsigntemplatepackagesignermembership"
},
{
"name": "Object_Ezsigntemplatesignature",
"description": "Ezsigntemplatesignature contains detail about a specific signature block on a page of a Ezsigntemplatedocument",
"x-displayName": "Ezsigntemplatesignature"
},
{
"name": "Object_Ezsigntemplatesigner",
"description": "Ezsigntemplatesigner contains detail about a signer (or role) in a Ezsigntemplate",
"x-displayName": "Ezsigntemplatesigner"
},
{
"name": "Object_Ezsigntsarequirement",
"description": "Ezsigntsarequirement contains detail about a Time stamping requirement",
"x-displayName": "Ezsigntsarequirement"
},
{
"name": "Object_Font",
"description": "Font contains detail about a CHANGEME",
"x-displayName": "Font"
},
{
"name": "Object_Franchisebroker",
"description": "Franchisebroker contains detail about a brokerage in the franchise administration module",
"x-displayName": "Franchisebroker"
},
{
"name": "Object_Franchiseoffice",
"description": "Franchiseoffice contains detail about a brokerage's office in the franchise administration module",
"x-displayName": "Franchiseoffice"
},
{
"name": "Object_Franchisereferalincome",
"description": "Franchisereferalincome contains detail about a referal income in the franchise administration module",
"x-displayName": "Franchisereferalincome"
},
{
"name": "Object_Modulegroup",
"description": "Modulegroup contains details about Modulegroups",
"x-displayName": "Modulegroup"
},
{
"name": "Object_Notificationsection",
"description": "Notificationsection contains detail about the count of elements for configured notification tests",
"x-displayName": "Notificationsection"
},
{
"name": "Object_Notificationtest",
"description": "Notificationtest contains detail about the notified tests to the users about things to take action on",
"x-displayName": "Notificationtest"
},
{
"name": "Object_Paymentterm",
"description": "Paymentterm contains detail about a payment term",
"x-displayName": "Paymentterm"
},
{
"name": "Object_Period",
"description": "Period contains detail about accounting periods",
"x-displayName": "Period"
},
{
"name": "Object_Permission",
"description": "Permission contains details about Permissions",
"x-displayName": "Permission"
},
{
"name": "Object_Phonetype",
"description": "Phonetype contains details about Phonetypes",
"x-displayName": "Phonetype"
},
{
"name": "Object_Secretquestion",
"description": "Secretquestion contains detail about questions that can be asked to user for 2FA",
"x-displayName": "Secretquestion"
},
{
"name": "Object_Sessionhistory",
"description": "Sessionhistory contains detail about the sessions history",
"x-displayName": "Sessionhistory"
},
{
"name": "Object_Signature",
"description": "Signature contains details about Signatures",
"x-displayName": "Signature"
},
{
"name": "Object_Subnet",
"description": "Subnet contains details about Subnets",
"x-displayName": "Subnet"
},
{
"name": "Object_Systemconfiguration",
"description": "Systemconfiguration contains details about Systemconfigurations",
"x-displayName": "Systemconfiguration"
},
{
"name": "Object_Taxassignment",
"description": "Taxassignment contains detail about a tax assignment",
"x-displayName": "Taxassignment"
},
{
"name": "Object_Timezone",
"description": "Timezone contains detail about a time zone",
"x-displayName": "Timezone"
},
{
"name": "Object_User",
"description": "User contains detail about the users in the system",
"x-displayName": "User"
},
{
"name": "Object_Usergroup",
"description": "Usergroup contains detail about a group of users",
"x-displayName": "Usergroup"
},
{
"name": "Object_Usergroupdelegation",
"description": "Usergroupdelegation contains details about Usergroupdelegations",
"x-displayName": "Usergroupdelegation"
},
{
"name": "Object_Usergroupmembership",
"description": "Usergroupmembership contains details about Usergroupmemberships",
"x-displayName": "Usergroupmembership"
},
{
"name": "Object_Userstaged",
"description": "Userstaged contains details about Userstageds",
"x-displayName": "Userstaged"
},
{
"name": "Object_Variableexpense",
"description": "Variableexpense contains detail about a CHANGEME",
"x-displayName": "Variableexpense"
},
{
"name": "Object_Versionhistory",
"description": "Versionhistory contains detail about changes in the system and important messages",
"x-displayName": "Versionhistory"
},
{
"name": "Object_Webhook",
"description": "Webhook contains detail about a webhook",
"x-displayName": "Webhook"
},
{
"name": "Scim_Groups",
"description": "Scim",
"x-displayName": "Groups"
},
{
"name": "Scim_ServiceProviderConfig",
"description": "Scim",
"x-displayName": "Service Provider Config"
},
{
"name": "Scim_Users",
"description": "Scim",
"x-displayName": "Users"
},
{
"name": "Websocket_RequestServer",
"description": "Websocket Request Server contains detail about commands that can be sent to the Websocket Server by clients",
"x-displayName": "Request (Server)"
},
{
"name": "Websocket_Response",
"description": "Websocket Reponse contains detail about the responses that are transmitted over the websocket connection",
"x-displayName": "Response"
}
],
"x-webhooks": {
"Webhook-Ezsign-DocumentCompleted": {
"post": {
"summary": "Webhook Document Completed",
"description": "This Webhook will be called when the last signature on an Ezsigndocument is made.",
"security": [
{}
],
"operationId": "Webhook_Ezsign_DocumentCompleted",
"tags": [
"Object_Ezsigndocument"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook-Ezsign-DocumentCompleted"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/Response-Webhook-202"
},
"204": {
"$ref": "#/components/responses/Response-Webhook-204"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Webhook-Ezsign-EzsignsignerAcceptclause": {
"post": {
"summary": "Webhook Ezsignsigner Accept Clause",
"description": "This Webhook will be called when an ezsignsigner accept the clauses.",
"security": [
{}
],
"operationId": "Webhook_Ezsign_EzsignsignerAcceptclause",
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook-Ezsign-EzsignsignerAcceptclause"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/Response-Webhook-202"
},
"204": {
"$ref": "#/components/responses/Response-Webhook-204"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Webhook-Ezsign-EzsignsignerConnect": {
"post": {
"summary": "Webhook Ezsignsigner Connect",
"description": "This Webhook will be called when an ezsignsigner log in.",
"security": [
{}
],
"operationId": "Webhook_Ezsign_EzsignsignerConnect",
"tags": [
"Object_Ezsignfoldersignerassociation"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook-Ezsign-EzsignsignerConnect"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/Response-Webhook-202"
},
"204": {
"$ref": "#/components/responses/Response-Webhook-204"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Webhook-Ezsign-FolderCompleted": {
"post": {
"summary": "Webhook Folder Completed",
"description": "This Webhook will be called when the last signature on the last Ezsigndocument from the folder is made.",
"security": [
{}
],
"operationId": "Webhook_Ezsign_FolderCompleted",
"tags": [
"Object_Ezsignfolder"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook-Ezsign-FolderCompleted"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/Response-Webhook-202"
},
"204": {
"$ref": "#/components/responses/Response-Webhook-204"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Webhook-User-UserCreated": {
"post": {
"summary": "Webhook User Created",
"description": "This Webhook will be called when a user is created in the system.",
"security": [
{}
],
"operationId": "Webhook_User_UserCreated",
"tags": [
"Object_User"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook-User-UserCreated"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/Response-Webhook-202"
},
"204": {
"$ref": "#/components/responses/Response-Webhook-204"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Webhook-Userstaged-UserstagedCreated": {
"post": {
"summary": "Webhook Userstaged Created",
"description": "This Webhook will be called when a Userstaged is created in the system.",
"security": [
{}
],
"operationId": "Webhook_Userstaged_UserstagedCreated",
"tags": [
"Object_Userstaged"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Webhook-Userstaged-UserstagedCreated"
}
}
}
},
"responses": {
"202": {
"$ref": "#/components/responses/Response-Webhook-202"
},
"204": {
"$ref": "#/components/responses/Response-Webhook-204"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Websocket-RequestServer-GetWebsocketID-V1": {
"post": {
"summary": "Retrieve Websocket ID",
"description": "Request the Websocket ID of the current connection",
"security": [
{}
],
"operationId": "Websocket_RequestServer_GetWebsocketID_V1",
"tags": [
"Websocket_RequestServer"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Websocket-RequestServer-GetWebsocketID-V1"
}
}
}
},
"responses": {
"101": {
"$ref": "#/components/responses/Response-Websocket"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Websocket-Response-Error-V1": {
"post": {
"summary": "Error message",
"description": "A websocket error message",
"security": [
{}
],
"operationId": "Websocket_Response_Error_V1",
"tags": [
"Websocket_Response"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Websocket-Response-Error-V1"
}
}
}
},
"responses": {
"101": {
"$ref": "#/components/responses/Response-Websocket"
}
},
"x-presentations": []
}
},
"Websocket-Response-GetWebsocketID-V1": {
"post": {
"summary": "Websocket ID",
"description": "The Websocket ID of the current connection",
"security": [
{}
],
"operationId": "Websocket_Response_GetWebsocketID_V1",
"tags": [
"Websocket_Response"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Websocket-Response-GetWebsocketID-V1"
}
}
}
},
"responses": {
"101": {
"$ref": "#/components/responses/Response-Websocket"
}
},
"x-presentations": [
"Ezsign"
]
}
},
"Websocket-Response-Information-V1": {
"post": {
"summary": "Information message",
"description": "A websocket information message",
"security": [
{}
],
"operationId": "Websocket_Response_Information_V1",
"tags": [
"Websocket_Response"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Websocket-Response-Information-V1"
}
}
}
},
"responses": {
"101": {
"$ref": "#/components/responses/Response-Websocket"
}
},
"x-presentations": [
"Ezsign"
]
}
}
},
"x-tagGroups": [
{
"name": "General",
"tags": [
"General_Introduction",
"General_Servers",
"General_Security",
"General_Conventions",
"General_StatusCodes",
"General_WarningCodes",
"General_ErrorCodes",
"General_Webhooks",
"General_Changelog"
]
},
{
"name": "Global",
"tags": [
"Global_Customer",
"Global_Ezmaxcustomer",
"Global_Ezmaxclient"
]
},
{
"name": "Module",
"tags": [
"Module_Ezsign",
"Module_Report",
"Module_User"
]
},
{
"name": "Object",
"tags": [
"Object_Activesession",
"Object_Apikey",
"Object_Billingentityexternal",
"Object_Billingentityinternal",
"Object_Branding",
"Object_Clonehistory",
"Object_Communication",
"Object_Company",
"Object_Cors",
"Object_Department",
"Object_Emailtype",
"Object_Ezmaxinvoicing",
"Object_Ezmaxproduct",
"Object_Ezsignbulksend",
"Object_Ezsignbulksenddocumentmapping",
"Object_Ezsignbulksendsignermapping",
"Object_Ezsignbulksendtransmission",
"Object_Ezsigndocument",
"Object_Ezsignfolder",
"Object_Ezsignfoldersignerassociation",
"Object_Ezsignfoldertype",
"Object_Ezsignformfieldgroup",
"Object_Ezsignpage",
"Object_Ezsignsignature",
"Object_Ezsignsignergroup",
"Object_Ezsignsignergroupmembership",
"Object_Ezsigntemplate",
"Object_Ezsigntemplatedocument",
"Object_Ezsigntemplateformfieldgroup",
"Object_Ezsigntemplatepackage",
"Object_Ezsigntemplatepackagemembership",
"Object_Ezsigntemplatepackagesigner",
"Object_Ezsigntemplatepackagesignermembership",
"Object_Ezsigntemplatesignature",
"Object_Ezsigntemplatesigner",
"Object_Ezsigntsarequirement",
"Object_Font",
"Object_Franchisebroker",
"Object_Franchiseoffice",
"Object_Franchisereferalincome",
"Object_Modulegroup",
"Object_Notificationsection",
"Object_Notificationtest",
"Object_Paymentterm",
"Object_Period",
"Object_Permission",
"Object_Phonetype",
"Object_Secretquestion",
"Object_Sessionhistory",
"Object_Signature",
"Object_Subnet",
"Object_Systemconfiguration",
"Object_Taxassignment",
"Object_Timezone",
"Object_User",
"Object_Usergroup",
"Object_Usergroupdelegation",
"Object_Usergroupmembership",
"Object_Userstaged",
"Object_Variableexpense",
"Object_Versionhistory",
"Object_Webhook"
]
},
{
"name": "Scim",
"tags": [
"Scim_Groups",
"Scim_ServiceProviderConfig",
"Scim_Users"
]
},
{
"name": "Websocket",
"tags": [
"Websocket_RequestServer",
"Websocket_Response"
]
}
],
"x-presentations": [
"Ezsign",
"RemaxQC"
]
}