{ "swagger": "2.0", "info": { "version": "v1", "title": "emSignerAPI", "description": "This page lists out all APIs available for eMsigner application available at in.emsigner.com. Please contact support@emsigner.com to understand how to use these APIs. \r\nFor every request you have to pass an Auth token in header as basic authentication which is generated using either validatelogin API or AuthorizeApp API. If you are using AuthorizeApp API to generate the Authtoken an additional UserName header is required where UserName is the emailid of the user consuming the api. For validatelogin you need to pass AppName and SecretKey in request header and in request body for AuthorizeApp.\r\n\r\nAppName and SecretKey will be provided by Emudhra or it can generated using below steps:\r\n\r\nStep 1: Login to using your User Name and Password.\r\n\r\nStep 2: On top right corner, your profile image will be present. On clicking the same, “Settings” menu will be displayed.\r\n\r\nStep 3: Click “Settings” menu. You will find “Manage Apps” option under “API Settings”.\r\n\r\nStep 4: Click “Manage Apps” option. You will be navigated to Apps page.\r\n\r\nStep 5: Click “Create App” button and enter necessary details and click save button." }, "host": "api.emsigner.com", "schemes": [ "https" ], "paths": { "/api/AccountProfile": { "get": { "tags": [ "Accounts" ], "summary": "Get your account details.", "operationId": "AccountProfile_AccountProfile", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.UserProfile]" } } } } }, "/api/AddAttachments": { "post": { "tags": [ "Workflows" ], "summary": "Add supporting attachments to a Workflow.", "operationId": "AddAttachments_Attachdocument", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "AttachDocInput", "in": "body", "description": "Attachment data", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.AttachDocumentInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.String]" } } } } }, "/api/AddComments": { "post": { "tags": [ "Workflows" ], "summary": "Add comment to a Workflow document.", "operationId": "AddComments_SaveUserComments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "comment", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SaveComment" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/AuthorizeApp": { "post": { "tags": [ "Accounts" ], "summary": "Fetch session token for API request.", "operationId": "AuthorizeApp_AuthorizeApp", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.AuthorizeAppRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.ValidateAPPViewModel.AuthorizeAppResp]" } } } } }, "/api/ChangePassword": { "post": { "tags": [ "Accounts" ], "summary": "Change your account password.", "operationId": "ChangePassword_ChangeMyPassword", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.PasswordRequestInput" } }, { "name": "AppName", "in": "header", "description": "App Name", "required": false, "type": "string" }, { "name": "SecretKey", "in": "header", "description": "Secret Key for the App", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Basic Authtoken", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/CreateAdhocUser": { "post": { "tags": [ "Accounts" ], "summary": "Create Ad-hoc user account(user outside your organization).", "operationId": "CreateAdhocUser_AdhocUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "AdhocUserData", "in": "body", "description": " The user data to create Ad-hoc user account.", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.AdhocUser" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/CreateBasicAccount": { "post": { "tags": [ "Accounts" ], "summary": "Create a free trial account", "operationId": "CreateBasicAccount_BasicAccount", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json" ], "parameters": [ { "name": "accountData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.BasicAccountViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/CreateDepartment": { "post": { "tags": [ "Accounts" ], "summary": "Create a new Department.", "operationId": "CreateDepartment_CreateDepartment", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "DepartmentData", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DepartmentViewModel" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/CreateUser": { "post": { "tags": [ "Accounts" ], "summary": "Create a new User.", "operationId": "CreateUser_CreateUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "UserData", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserViewModel" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/DelegateWorkflowbyAdmin": { "post": { "tags": [ "Workflows" ], "summary": "Delegate Workflow signing from existing user to another user by admin.", "operationId": "DelegateWorkflowbyAdmin_DelegateWorkflow", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "delegateWorkflow", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DelegateWorkflow" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/DeleteAdhocUser": { "post": { "tags": [ "Accounts" ], "summary": "Delete an existing Ad-hoc user.", "operationId": "DeleteAdhocUser_DeleteAdhocUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "AdhocUserData", "in": "body", "description": "User data to delete", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.AdhocUserDelete" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/DeleteAttachment": { "post": { "tags": [ "Workflows" ], "summary": "Delete a Workflow attachment.", "operationId": "DeleteAttachment_DeleteAttachment", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "deleteAttachmentInput", "in": "body", "description": "Pass one of the input to delete an attachment.", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DeleteAttachmentInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/DeleteComment": { "post": { "tags": [ "Workflows" ], "summary": "Delete a Workflow comment.", "operationId": "DeleteComment_DeleteComment", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "comment", "in": "body", "description": "Pass any of the iput parameter to delete a comment.", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.Comment" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int32]" } } } } }, "/api/DeleteUser": { "post": { "tags": [ "Accounts" ], "summary": "Delete an existing internal user.", "operationId": "DeleteUser_DeleteUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "UserData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.UserDelete" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/Documentupload": { "post": { "tags": [ "Docstore" ], "summary": "Upload document(s) for a particular template.", "operationId": "Documentupload_UploadDocumnet", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "DocumentUploadInput", "in": "body", "description": "Information about the document(s) to be uploaded.", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentViewModel" } } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentReponse]]" } } } } }, "/api/DownloadCertificate": { "get": { "tags": [ "DownloadCertificate" ], "operationId": "DownloadCertificate_DownloadCertificate", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "documentId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.String]" } } } } }, "/api/enc/DownloadWorkflowDocuments": { "post": { "tags": [ "DownloadWorkflowDocuments" ], "operationId": "DownloadWorkflowDocuments_DownloadDocumentsEncrypted", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.EmbeddedSigningViewModel.EncryptedRequestDto" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.EncReturnObject[System.Object]" } } } } }, "/api/DownloadWorkflowDocuments": { "get": { "tags": [ "Workflows" ], "operationId": "DownloadWorkflowDocuments_DownloadWorkFlowDocumentsByWorkflowId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkFlowId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "DocumentId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ReferenceNo", "in": "query", "required": false, "type": "string" }, { "name": "IsMerged", "in": "query", "required": false, "type": "boolean" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.FileDownloadResponseV1]]" } } } }, "post": { "tags": [ "Workflows" ], "summary": "Download the Workflow Document(s).", "operationId": "DownloadWorkflowDocuments_DownloadWorkFlowDocumentsByWorkflowId", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "DownLoadInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentDownloadInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.FileDownloadResponse]" } } } } }, "/api/EditAdhocUser": { "post": { "tags": [ "Accounts" ], "summary": "Create a new User.", "operationId": "EditAdhocUser_EditAdhocUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "UserData", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.AdhocUserUpdate" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/EditUser": { "post": { "tags": [ "Accounts" ], "summary": "Create a new User.", "operationId": "EditUser_EditUser", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "UserData", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserViewModel" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/FetcheStampFile": { "post": { "tags": [ "eStamping" ], "operationId": "FetcheStampFile_FetcheStampFile", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.eStampRequestData" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.CustomReturnObject" } } } } }, "/api/ForgotPassword": { "get": { "tags": [ "Accounts" ], "summary": "Get a link to create a new password on your registered email id.", "operationId": "ForgotPassword_GetMyPassword", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "emailId", "in": "query", "description": "Pass email id of the user.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/FreeTrial": { "post": { "tags": [ "Workflows" ], "summary": "Create a free trial account", "operationId": "FreeTrial_FreeTrial", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "freeTrailData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.FreeTrailViewModel" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/GenerateOtp": { "get": { "tags": [ "Accounts" ], "summary": "Generate OTP for login", "operationId": "GenerateOtp_GenerateCustomerOtp", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "EmailId", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int32]" } } } } }, "/api/GetAccessToken": { "post": { "tags": [ "Accounts" ], "summary": "Fetch session token for API request.", "operationId": "GetAccessToken_GetAccessToken", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "loginData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SubscriberLogin" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EmsignerAPI.Controllers.GetAccessTokenController.TokenResponse" } } } } }, "/api/GetAllDocuments": { "post": { "tags": [ "Docstore" ], "operationId": "GetAllDocuments_GetAllDocumentsFromStore", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowSearchDTO", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.WorkflowSearchViewModel" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[Emsigner.BusinessObject.FilesView]]" } } } } }, "/api/GetArticleCodes": { "post": { "tags": [ "eStamping" ], "operationId": "GetArticleCodes_GetArticleCodes", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.Controllers.GetArticleCodesController.GetArticleCodesInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" }, { "name": "AppName", "in": "header", "description": "App Name", "required": true, "type": "string" }, { "name": "SecretKey", "in": "header", "description": "Secret Key for the App", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.eStampArticalcodedetailsDTO]]" } } } } }, "/api/GetDashboardSummary": { "get": { "tags": [ "Dashboard" ], "operationId": "GetDashboardSummary_GetDashboardStatusCount", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "status", "in": "query", "required": true, "type": "string" }, { "name": "SelectedYear", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/GetDeclinedRemarks": { "get": { "tags": [ "Workflows" ], "summary": "Get the Workflow declined remarks.", "operationId": "GetDeclinedRemarks_GetDeclinedRemarks", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkFlowId", "in": "query", "description": "Pass WorkFlowId(fetched using GetworkflowInfo api)", "required": false, "type": "integer", "format": "int32" }, { "name": "ReferenceNo", "in": "query", "description": "or pass ReferenceNo(fetched using GetworkflowInfo api)", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.DeclinedRemarksInfo]" } } } } }, "/api/GetDocumentLog": { "get": { "tags": [ "Workflows" ], "operationId": "GetDocumentLog_GetDocumentLog", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "documentId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ReferenceNo", "in": "query", "required": false, "type": "string" }, { "name": "SelectedYear", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentLogView]]" } } } } }, "/api/GetDocumentsByStatus": { "get": { "tags": [ "Dashboard" ], "summary": "Get Documents summary by status.", "operationId": "GetDocumentsByStatus_GetTrackerPendingData", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "statusId", "in": "query", "description": "Pass statusId=pending for pending records retrieval,\r\n statusId=drafts for drafts/not_yet_started records retrieval ,\r\n statusId=declined for Declined records retrieval ,\r\n statusId=recalled for Recalled records retrieval ,\r\n statusId=completed for Completed records retrieval ,\r\n statusId=deleted for Inactive records retrieval ,\r\n statusId=cosign for Waiting for others records retrieval", "required": true, "type": "string" }, { "name": "PageNumber", "in": "query", "description": "Specify number as PageSize=1 returns 1-10 records in document store PageSize=2 returns 11-20 records in document store and so on...", "required": true, "type": "string" }, { "name": "Year", "in": "query", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentInformation]]" } } } }, "post": { "tags": [ "Dashboard" ], "operationId": "GetDocumentsByStatus_GetDocumentsByStatusV2", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowSearchDTO", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.WorkflowSearchDTO" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DashBoardViewModel]]" } } } } }, "/api/GetEstampingFinalAmount": { "post": { "tags": [ "eStamping" ], "operationId": "GetEstampingFinalAmount_GetEstampingFinalamount", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "PaymentInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.EtampingPaymentInfo" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" }, { "name": "AppName", "in": "header", "description": "App Name", "required": true, "type": "string" }, { "name": "SecretKey", "in": "header", "description": "Secret Key for the App", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.EtampingPaymentResponse]" } } } } }, "/api/GeteStampingSummary": { "post": { "tags": [ "eStamping" ], "summary": "Use to fetch estamp file using State and Denomination", "operationId": "GeteStampingSummary_GeteStampingSummary", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.Controllers.GeteStampingSummaryController.eStampSummeryData" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.OfflineeStampViewmodel]]" } } } } }, "/api/GeteStampStates": { "get": { "tags": [ "eStamping" ], "operationId": "GeteStampStates_FetcheStampStates", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" }, { "name": "AppName", "in": "header", "description": "App Name", "required": true, "type": "string" }, { "name": "SecretKey", "in": "header", "description": "Secret Key for the App", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.OnlineEstampStates]]" } } } } }, "/api/GetFileData": { "get": { "tags": [ "Dashboard" ], "summary": "Get the summary of a document.", "operationId": "GetFileData_GetFileData", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "DocumentId", "in": "query", "description": "Pass DocumentId(fetched using GetDocumentsByStatus/GetWorkflowInfo)", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentDetailsResponse]]" } } } } }, "/api/GetFlexiformData": { "get": { "tags": [ "Workflows" ], "summary": "Get Documents summary by status.", "operationId": "GetFlexiformData_GetFlexiformData", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowId", "in": "query", "description": "WorkflowId", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.FlexiFormData]]" } } } } }, "/api/GetParallelSigningURL": { "post": { "tags": [ "Workflows" ], "operationId": "GetParallelSigningURL_GetSigningURL", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.WorkflowInfoInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.ParallelSigningURL]]" } } } } }, "/api/GetRecalledRemarks": { "get": { "tags": [ "Workflows" ], "summary": "Get the Recalled remarks of a workflow.", "operationId": "GetRecalledRemarks_GetRecalledRemarks", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkFlowId", "in": "query", "description": "Pass WorkFlowId(fetched using GetAllDocuments api)", "required": false, "type": "integer", "format": "int32" }, { "name": "ReferenceNo", "in": "query", "description": "or pass ReferenceNo(fetched using GetAllDocuments api)", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.RecalledRemarksInfo]" } } } } }, "/api/GetRoles": { "get": { "tags": [ "Workflows" ], "summary": "List all existing internal users.", "operationId": "GetRoles_GetRoles", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "roleId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.UserRole]]" } } } } }, "/api/GetSignatureTypes": { "get": { "tags": [ "Accounts" ], "summary": "Returns the available Signature Types", "operationId": "GetSignatureTypes_GetSignatureTypes", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.SignatureTypes]]" } } } } }, "/api/GetSigningURL": { "post": { "tags": [ "Workflows" ], "operationId": "GetSigningURL_GetSigningURL", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.WorkflowInfoInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.String]" } } } } }, "/api/GetTimeZones": { "get": { "tags": [ "Accounts" ], "summary": "List all existing internal users.", "operationId": "GetTimeZones_GetTimeZones", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.TimeZoneDTO]]" } } } } }, "/api/GetWorkflowAttachments": { "get": { "tags": [ "Workflows" ], "summary": "Get all attachments of a workflow.", "operationId": "GetWorkflowAttachments_GetAttachment", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkflowID", "in": "query", "description": "Pass WorkflowID(fetched using GetAllDocuments api)", "required": false, "type": "integer", "format": "int32" }, { "name": "ParentDocumentID", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ReferenceNo", "in": "query", "description": "or pass ReferenceNo(fetched using GetAllDocuments api)", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.AttachmentList]]" } } } } }, "/api/GetWorkflowComments": { "get": { "tags": [ "Workflows" ], "summary": "Get comments of a workflow.", "operationId": "GetWorkflowComments_GetUserCommentsByWorkFlowId", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "workflowId", "in": "query", "description": "Pass workflowId(fetched using GetAllDocuments api)", "required": false, "type": "integer", "format": "int32" }, { "name": "documentId", "in": "query", "description": "or pass specific documentId of the workflow(fetched using GetWorkflowInfo api)", "required": false, "type": "integer", "format": "int32" }, { "name": "ReferenceNo", "in": "query", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.UserComment]]" } } } } }, "/api/GetWorkflowInfo": { "get": { "tags": [ "Workflows" ], "operationId": "GetWorkflowInfo_GetWorkflowInfo", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkFlowId", "in": "query", "required": false, "type": "string" }, { "name": "ReferenceNo", "in": "query", "required": false, "type": "string" }, { "name": "ParentDocumentId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentInfo]]" } } } }, "post": { "tags": [ "Workflows" ], "summary": "Get all Signatories, documents and signed dates results of a workflow.", "operationId": "GetWorkflowInfo_GetWorkflowInfo", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.WorkflowInfoInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.WorkflowInfo]" } } } } }, "/api/InitiateAndSign": { "post": { "tags": [ "Workflows" ], "summary": "Initiate a Workflow with or witout predefined template by uploading document that has to be signed by adding the signatory details.", "operationId": "InitiateAndSign_InitiateAndSignWorkFlow", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "inputconfiguration", "in": "body", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.InitiateAndSignWorkflowConfig" } } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.InitiateAndSignWorkFlowResponse]" } } } } }, "/api/InitiateAndSignFlexiForm": { "post": { "tags": [ "Workflows" ], "summary": "Initiate a Workflow with flexi form data ( single/bulk) by adding the signatory details.", "operationId": "InitiateAndSignFlexiForm_InitiateAndSignWorkFlow", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "inputConfiguration", "in": "body", "description": "", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.WorkflowConfigFlexiform" } } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.InitiateAndSignWorkFlowResponse]" } } } } }, "/api/enc/InitiateEmbeddedSigning": { "post": { "tags": [ "InitiateEmbeddedSigning" ], "operationId": "InitiateEmbeddedSigning_InitiateEmbeddedSigningEncrypted", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.EmbeddedSigningViewModel.EncryptedRequestDto" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.EncReturnObject[System.Object]" } } } } }, "/api/InitiateEmbeddedSigning": { "post": { "tags": [ "Workflows" ], "summary": "Authenticate user based on secretkey and appname", "operationId": "InitiateEmbeddedSigning_InitiateEmbeddedSigning", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.EmbeddedSigningViewModel.EmbeddedSigningRequest" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.InitiateAndSignWorkFlowResponse]" } } } } }, "/api/ListAdhocUsers": { "post": { "tags": [ "Accounts" ], "summary": "List all existing Ad-hoc users.", "operationId": "ListAdhocUsers_ListAdhocUsers", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "AdhocSearchData", "in": "body", "description": "Used to filter data with given values", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserSearchView" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.AdhocUserGet]]" } } } } }, "/api/ListCountries": { "get": { "tags": [ "Accounts" ], "operationId": "ListCountries_GetCountryList", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[eMDMS.Helper.Utility.CountryList]]" } } } } }, "/api/ListDepartments": { "get": { "tags": [ "Accounts" ], "summary": "List all existing Departments.", "operationId": "ListDepartments_ListDepartments", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DepartmentDetails]]" } } } } }, "/api/ListTemplates": { "get": { "tags": [ "Workflows" ], "summary": "Get a list of all the created templates.", "operationId": "ListTemplates_GetWorkflowDetails", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.GetWorkflow]]" } } } }, "post": { "tags": [ "Workflows" ], "operationId": "ListTemplates_GetWorkflowDetails", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.Controllers.ListTemplatesController.TemplateFilter" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.GetWorkflow]]" } } } } }, "/api/ListUsers": { "get": { "tags": [ "Accounts" ], "summary": "List all existing internal users.", "operationId": "ListUsers_ListUsers", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.UserViewModelGet]]" } } } } }, "/api/MapDepartments": { "post": { "tags": [ "Accounts" ], "summary": "Map a created template to a department(s).", "operationId": "MapDepartments_MapDepartments", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "DepartmentMapData", "in": "body", "description": "DepartmentIds(fetched using ListDepartments):Comma separeted value for departments to mapp(pass empty if want to remove access for all departments)\r\n TemplateId(fetched using ListTemplates):Id of the template created.", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.MapWorkflowToDepartments" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/MapUsers": { "post": { "tags": [ "Accounts" ], "summary": "Map user(s) to a department.", "operationId": "MapUsers_MapUsers", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "MapUsersToDepartmentData", "in": "body", "description": "", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.MapUsersToDepartment" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/MarkAsInactive": { "get": { "tags": [ "Docstore" ], "summary": "Mark a workflow as inactive.", "operationId": "MarkAsInactive_MarkAsInactive", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkflowId", "in": "query", "description": "Pass DocumentId(fetched using GetDocumentsByStatus) if status is \"drafts\" else Pass WorkflowId(fetched using GetDocumentsByStatus)", "required": true, "type": "integer", "format": "int32" }, { "name": "Status", "in": "query", "description": "Pass status of the document or workflow which you want to mark as inactive.Status=”draft”, if you want to make documents from drafts as inactive.\r\n Status=”pending”, if you want to make pending workflow as inactive.", "required": true, "type": "string" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/RecallWorkflow": { "post": { "tags": [ "Workflows" ], "summary": "Recall back a Workflow initiated by you.", "operationId": "RecallWorkflow_Decline", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "description": "Pass workflowid or referenceno along with remarks to recall a workflow", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.RecallInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/RemoteSign": { "post": { "tags": [ "Workflows" ], "operationId": "RemoteSign_RemoteSign", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.RemoteSigningRequest" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.RemoteSignResponse]" } } } } }, "/api/SaveWebhookSettings": { "post": { "tags": [ "Workflows" ], "operationId": "SaveWebhookSettings_SaveWebhookSettings", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/BusinessObject.BusinessObject.WebhookModel" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int32]" } } } } }, "/api/SendMailToSignatories": { "post": { "tags": [ "Workflows" ], "summary": "Send final completion mail to signatories", "operationId": "SendMailToSignatories_SendMailToSignatories", "consumes": [], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkFlowId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/SendReminder": { "post": { "tags": [ "Workflows" ], "operationId": "SendReminder_SendReminderMail", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "WorkflowId", "in": "body", "required": true, "schema": { "format": "int32", "type": "integer" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int32]" } } } } }, "/api/ShareDocuments": { "post": { "tags": [ "Workflows" ], "summary": "Share all the Workflow related documents with or without attachmemts with anyone through email.", "operationId": "ShareDocuments_ShareFileStatus", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "input", "in": "body", "description": "Pass workflowid or referenceno along with other parameters.", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ShareInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Boolean]" } } } } }, "/api/UpdateComment": { "post": { "tags": [ "Workflows" ], "summary": "Update a comment.", "operationId": "UpdateComment_UpdateComment", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "CommentInput", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UpdateCommentInput" } }, { "name": "Authorization", "in": "header", "description": "My header field", "required": true, "type": "string" }, { "name": "UserName", "in": "header", "description": "User EmailId", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.Int64]" } } } } }, "/api/ValidateApps": { "post": { "tags": [ "Accounts" ], "summary": "Fetch session token for API request.", "operationId": "ValidateApps_ValidateApp", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.ValidateAppRequest" } }, { "name": "AppName", "in": "header", "description": "App Name", "required": true, "type": "string" }, { "name": "SecretKey", "in": "header", "description": "Secret Key for the App", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[System.String]" } } } } }, "/api/ValidateLogin": { "post": { "tags": [ "Accounts" ], "summary": "Fetch session token for API request.", "operationId": "ValidateLogin_ValidateLogin", "consumes": [ "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "application/xml", "text/xml" ], "parameters": [ { "name": "loginData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SubscriberLogin" } }, { "name": "AppName", "in": "header", "description": "App Name", "required": false, "type": "string" }, { "name": "SecretKey", "in": "header", "description": "Secret Key for the App", "required": false, "type": "string" }, { "name": "Authorization", "in": "header", "description": "Basic Authtoken", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.subscriberLogingResp]" } } } } } }, "definitions": { "eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.UserProfile]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserProfile" } } }, "EmsignerAPI.BusinessObject.UserProfile": { "type": "object", "properties": { "SubscriberId": { "format": "int32", "type": "integer" }, "Contact_Number": { "type": "string" }, "Department": { "type": "string" }, "Designation": { "type": "string" }, "Email_Id": { "type": "string" }, "EndDate": { "type": "string" }, "FullName": { "type": "string" }, "State": { "type": "string" }, "Organization": { "type": "string" }, "Zip_Code": { "type": "string" }, "NoofUsers": { "format": "int32", "type": "integer" }, "IsAdmin": { "type": "boolean" }, "ParentId": { "format": "int32", "type": "integer" }, "UserType": { "format": "int32", "type": "integer" }, "IsHSMEnabled": { "type": "boolean" }, "AzureKeyVaultEnabled": { "type": "boolean" }, "TimeZoneId": { "type": "string" }, "IncludeOrgNameinSig": { "type": "boolean" }, "ParentName": { "type": "string" }, "ParentEmail": { "type": "string" }, "IsPINRequired": { "type": "boolean" }, "IseSignaturePINSet": { "type": "boolean" }, "IsPeruriSignEnabled": { "type": "boolean" }, "Country": { "type": "string" }, "IsAKVEnrolled": { "type": "boolean" }, "AkvCertificateCount": { "format": "int32", "type": "integer" }, "PlanId": { "format": "int32", "type": "integer" }, "IsStampOnlyFlow": { "type": "boolean" } } }, "EmsignerAPI.BusinessObject.AttachDocumentInput": { "description": "Name of the attachment", "required": [ "AttachmentName", "Base64FileData" ], "type": "object", "properties": { "AttachmentName": { "description": "Name of the attachment", "type": "string" }, "Description": { "description": "Description", "type": "string" }, "Base64FileData": { "description": "base64 string format of the document file", "type": "string" }, "ParentDocumentID": { "format": "int32", "description": "first document in a multi document workflow (fetched using GetWorkflowInfo)", "type": "integer" }, "Password": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.String]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "string" } } }, "EmsignerAPI.BusinessObject.SaveComment": { "description": "DocumentID - (fetched using GetWorkflowInfo)", "required": [ "DocumentID", "Comment" ], "type": "object", "properties": { "DocumentID": { "format": "int32", "description": "DocumentID - (fetched using GetWorkflowInfo)", "type": "integer" }, "Comment": { "description": "Comment", "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Boolean]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "boolean" } } }, "EmsignerAPI.BusinessObject.ValidateAPPViewModel.AuthorizeAppRequest": { "required": [ "AppName", "SecretKey" ], "type": "object", "properties": { "AppName": { "type": "string" }, "SecretKey": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.ValidateAPPViewModel.AuthorizeAppResp]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.AuthorizeAppResp" } } }, "EmsignerAPI.BusinessObject.ValidateAPPViewModel.AuthorizeAppResp": { "type": "object", "properties": { "AuthToken": { "type": "string" } } }, "BusinessObject.PasswordRequestInput": { "description": "Input - Current Password and New Password to change password for a user", "required": [ "CurrentPassword", "NewPassword", "EmailId" ], "type": "object", "properties": { "CurrentPassword": { "description": "Current Password", "type": "string" }, "NewPassword": { "description": "New Password", "type": "string" }, "EmailId": { "description": "New Password", "type": "string" } } }, "BusinessObject.BusinessObject.AdhocUser": { "description": "Adhoc user data", "required": [ "Name", "Email", "IdentificationNumber" ], "type": "object", "properties": { "Name": { "description": "Name of the adhoc-user", "type": "string" }, "Email": { "description": "Email of the adhoc-user", "type": "string" }, "ContactNumber": { "description": "ContactNumber of the adhoc-user", "type": "string" }, "DOB": { "description": "Date of birth in yyyy-mm-dd format", "type": "string" }, "GenderId": { "format": "int32", "description": "1-for male ,2-for female", "type": "integer" }, "PAN": { "description": "PAN NO", "type": "string" }, "Organization": { "type": "string" }, "IdentificationNumber": { "type": "string" }, "AlternativeEmail": { "type": "string" }, "CountryCode": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Int64]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "format": "int64", "type": "integer" } } }, "BusinessObject.BusinessObject.BasicAccountViewModel": { "required": [ "EmailId", "CompanyName", "CountryName" ], "type": "object", "properties": { "Name": { "type": "string" }, "EmailId": { "type": "string" }, "CompanyName": { "type": "string" }, "CountryName": { "type": "string" }, "Frequency": { "format": "int32", "type": "integer" }, "MobileNo": { "type": "string" } } }, "EmsignerAPI.BusinessObject.DepartmentViewModel": { "required": [ "DepartmentName" ], "type": "object", "properties": { "DepartmentName": { "type": "string" } } }, "EmsignerAPI.BusinessObject.UserViewModel": { "description": "Name of the User", "required": [ "Name", "EmailID", "DepartmentID", "InternalUser2FA", "SignatureType", "UserRoleId", "CompanyName", "Country", "SignatureOption", "LoginAuthentication" ], "type": "object", "properties": { "Name": { "description": "Name of the User", "type": "string" }, "MobileNumber": { "description": "MobileNo of the User", "type": "string" }, "CountryCode": { "description": "CountryCode", "type": "string" }, "EmailID": { "description": "EmailId of the User(Required only while creating new user)", "type": "string" }, "DepartmentID": { "format": "int32", "description": "DeapartmentId of the User(Fetched using ListDepartments api)", "type": "integer" }, "Designation": { "description": "Designation of the User", "type": "string" }, "InternalUser2FA": { "description": "True if login needs to be enabled with Username, Password and OTP", "type": "boolean" }, "SignatureType": { "description": "1-dsign (Token or Smart Card),2-esign V3 (India) 3-eSignature, 5-UAE Pass,8- esignv2 verasys,12 esign v2,13 emudhra digital signature,14 esignV2 cdsl (comma separated values)", "type": "string" }, "UserRoleId": { "format": "int32", "description": "UserRoleId: Fetched using GetRoles", "type": "integer" }, "Address": { "description": "Address of the User", "type": "string" }, "State": { "description": "State of the User", "type": "string" }, "City": { "description": "City of the User", "type": "string" }, "ZipCode": { "description": "Pin number of the User", "type": "string" }, "IsAdmin": { "description": "true if user will be having admin access", "type": "boolean" }, "CompanyName": { "description": "Comapany name of the User", "type": "string" }, "Country": { "description": "Country name of the User", "type": "string" }, "SignatureOption": { "format": "int32", "description": "1-Enable LTV, 2-TimeStamp,3-None", "type": "integer" }, "AlternativeEmailId": { "description": "Alternative EmailId of the user(Required only while creating new user)", "type": "string" }, "HSMCertificateID": { "description": "Comma separated HSMCertifiacteIds", "type": "string" }, "AllowAccessToUser": { "description": "Allow user to interact with Dashboard, Doc Store, etc", "type": "boolean" }, "SubscriberId": { "format": "int32", "description": "SubscriberId of the existing user(Required only while updation)", "type": "integer" }, "LoginAuthentication": { "description": "Type of authentication used for user login;1-Username and Password,2-Office 365,3-UAE Pass,4-Google\r\n(comma separated values)", "type": "string" }, "NationalId": { "type": "string" }, "TimeZone": { "type": "string" }, "ProfileImageData": { "type": "string" }, "ProfileImageName": { "type": "string" } } }, "EmsignerAPI.BusinessObject.DelegateWorkflow": { "required": [ "EmailId", "Name", "Reason" ], "type": "object", "properties": { "ReferenceNo": { "description": "ReferenceNo of the document which you want to delegate(fetched using GetAllDocuments)", "type": "string" }, "WorkflowId": { "format": "int32", "description": "WorkflowId of the document which you want to delegate-(fetched using GetAllDocuments)", "type": "integer" }, "EmailId": { "description": "EmailId of the user delegated user", "type": "string" }, "Name": { "description": "Name of the user", "type": "string" }, "Reason": { "description": "Delegation reason", "type": "string" } } }, "BusinessObject.BusinessObject.AdhocUserDelete": { "required": [ "SubscriberId" ], "type": "object", "properties": { "SubscriberId": { "format": "int32", "type": "integer" } } }, "EmsignerAPI.BusinessObject.DeleteAttachmentInput": { "description": "To remove attachment pass of the parameter.", "type": "object", "properties": { "DocumentID": { "format": "int32", "description": "ID of the attachment(fetched using GetWorkflowAttachments).", "type": "integer" }, "WorkflowID": { "format": "int32", "description": " WorkflowID of the attachment(fetched using GetAllDocuments.\r\n
It will delete all the attachments linked with the workflow.", "type": "integer" }, "ReferenceNo": { "description": "ReferenceNo of the workflow attachment(fetched using GetAllDocuments).\r\n
It will delete all the attachments linked with the workflow.", "type": "string" } } }, "EmsignerAPI.BusinessObject.Comment": { "type": "object", "properties": { "WorkflowID": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "CommentID": { "format": "int32", "type": "integer" } } }, "eMDMS.Helper.ReturnObject[System.Int32]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.UserDelete": { "required": [ "SubscriberId" ], "type": "object", "properties": { "SubscriberId": { "format": "int32", "type": "integer" } } }, "EmsignerAPI.BusinessObject.DocumentViewModel": { "description": "DocumentViewModel", "required": [ "TemplateId", "Base64FileData", "DocumentName" ], "type": "object", "properties": { "TemplateId": { "format": "int32", "description": "TemplateId(fetched using GetTemplates) of the activity created through Manage Workflows", "type": "integer" }, "Base64FileData": { "description": "base64 string format of the documentfile", "type": "string" }, "DocumentName": { "description": "Name of the document with extension", "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentReponse]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentReponse" } } } }, "EmsignerAPI.BusinessObject.DocumentReponse": { "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "DocumentName": { "type": "string" }, "DocumentNumber": { "type": "string" } } }, "EmsignerAPI.BusinessObject.EmbeddedSigningViewModel.EncryptedRequestDto": { "type": "object", "properties": { "kid": { "type": "string" }, "key": { "type": "string" }, "data": { "type": "string" } } }, "eMDMS.Helper.EncReturnObject[System.Object]": { "type": "object", "properties": { "Data": { "type": "object" } } }, "EmsignerAPI.BusinessObject.DocumentDownloadInput": { "type": "object", "properties": { "WorkFlowId": { "format": "int32", "type": "integer" }, "DocumentId": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "IsMerged": { "type": "boolean" } } }, "eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.FileDownloadResponse]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.FileDownloadResponse" } } }, "EmsignerAPI.BusinessObject.FileDownloadResponse": { "type": "object", "properties": { "ReferenceNo": { "type": "string" }, "WorkflowId": { "format": "int32", "type": "integer" }, "FileList": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.Files" } }, "CertificateData": { "type": "string" } } }, "EmsignerAPI.BusinessObject.Files": { "type": "object", "properties": { "DocumentName": { "type": "string" }, "Base64FileData": { "type": "string" }, "DocumentId": { "format": "int32", "type": "integer" }, "IsAttachment": { "type": "boolean" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.FileDownloadResponseV1]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.FileDownloadResponseV1" } } } }, "EmsignerAPI.BusinessObject.FileDownloadResponseV1": { "type": "object", "properties": { "DocumentName": { "type": "string" }, "Base64FileData": { "type": "string" }, "DocumentId": { "format": "int32", "type": "integer" }, "IsAttachment": { "type": "boolean" } } }, "BusinessObject.BusinessObject.AdhocUserUpdate": { "required": [ "SubscriberId", "Name", "Email", "IdentificationNumber" ], "type": "object", "properties": { "SubscriberId": { "format": "int32", "description": "SubscriberId of the adhoc-user to be edited\r\nCan be fetched useing ListAdhoc user API", "type": "integer" }, "Name": { "description": "Name of the adhoc-user", "type": "string" }, "Email": { "description": "Email of the adhoc-user", "type": "string" }, "ContactNumber": { "description": "ContactNumber of the adhoc-user", "type": "string" }, "DOB": { "description": "Date of birth in yyyy-mm-dd format", "type": "string" }, "GenderId": { "format": "int32", "description": "1-for male ,2-for female", "type": "integer" }, "PAN": { "description": "PAN NO", "type": "string" }, "Organization": { "type": "string" }, "IdentificationNumber": { "type": "string" }, "AlternativeEmail": { "type": "string" }, "CountryCode": { "type": "string" } } }, "BusinessObject.BusinessObject.eStampRequestData": { "required": [ "State" ], "type": "object", "properties": { "State": { "type": "string" }, "Denomination": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "ClientID": { "type": "string" }, "ClientName": { "type": "string" }, "FirstParty": { "type": "string" }, "SecondParty": { "type": "string" }, "StampType": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.CustomReturnObject": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "string" }, "eStampFileId": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "FirstParty": { "type": "string" }, "SecondParty": { "type": "string" } } }, "BusinessObject.BusinessObject.FreeTrailViewModel": { "required": [ "Name", "EmailId", "Password" ], "type": "object", "properties": { "Name": { "type": "string" }, "EmailId": { "type": "string" }, "Password": { "type": "string" }, "MicrosoftAccessKey": { "type": "string" }, "GoogleAccessKey": { "type": "string" } } }, "EmsignerAPI.BusinessObject.SubscriberLogin": { "description": "SubscriberLogin", "type": "object", "properties": { "UserName": { "description": "UserName", "type": "string" }, "Password": { "description": "Password", "type": "string" } } }, "EmsignerAPI.Controllers.GetAccessTokenController.TokenResponse": { "type": "object", "properties": { "AccessToken": { "type": "string" }, "TokenType": { "type": "string" } } }, "EmsignerAPI.BusinessObject.WorkflowSearchViewModel": { "type": "object", "properties": { "TabStatusType": { "type": "string" }, "Status": { "type": "string" }, "pagenumber": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "DocName": { "type": "string" }, "DocOwner": { "type": "string" }, "StartDate": { "type": "string" }, "EndDate": { "type": "string" }, "ExpiryFromDate": { "type": "string" }, "ExpiryToDate": { "type": "string" }, "TemplateName": { "type": "string" }, "DocumentNumber": { "type": "string" }, "Referenceno": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[Emsigner.BusinessObject.FilesView]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/Emsigner.BusinessObject.FilesView" } } } }, "Emsigner.BusinessObject.FilesView": { "type": "object", "properties": { "WorkFlowId": { "format": "int32", "type": "integer" }, "CategoryName": { "type": "string" }, "DisplayName": { "type": "string" }, "UploadTime": { "type": "string" }, "Name": { "type": "string" }, "Status": { "type": "string" }, "DocumentNumber": { "type": "string" }, "OriginatorId": { "format": "int32", "type": "integer" }, "Referenceno": { "type": "string" }, "WorkflowType": { "format": "int32", "type": "integer" }, "CustomStatus": { "type": "string" }, "totalRecords": { "format": "int32", "type": "integer" }, "IsAttachment": { "type": "boolean" }, "NoOfDocsCount": { "format": "int32", "type": "integer" }, "SignedBy": { "type": "string" }, "SignedDate": { "type": "string" } } }, "EmsignerAPI.Controllers.GetArticleCodesController.GetArticleCodesInput": { "type": "object", "properties": { "StateCode": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.eStampArticalcodedetailsDTO]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.eStampArticalcodedetailsDTO" } } } }, "BusinessObject.BusinessObject.eStampArticalcodedetailsDTO": { "type": "object", "properties": { "ArticalCode": { "type": "string" }, "ArticalName": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.DeclinedRemarksInfo]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DeclinedRemarksInfo" } } }, "EmsignerAPI.BusinessObject.DeclinedRemarksInfo": { "type": "object", "properties": { "DeclinedBy": { "format": "int32", "type": "integer" }, "DeclinedTime": { "format": "date-time", "type": "string" }, "Remarks": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentLogView]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentLogView" } } } }, "EmsignerAPI.BusinessObject.DocumentLogView": { "type": "object", "properties": { "DocumentName": { "type": "string" }, "DocumentLogs": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentLog" } } } }, "EmsignerAPI.BusinessObject.DocumentLog": { "type": "object", "properties": { "DateTime": { "format": "date-time", "type": "string" }, "UserEmail": { "type": "string" }, "Action": { "type": "string" }, "IPAddress": { "type": "string" }, "OSandBrowser": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentInformation]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentInformation" } } } }, "EmsignerAPI.BusinessObject.DocumentInformation": { "type": "object", "properties": { "totalRecords": { "format": "int32", "type": "integer" }, "WorkFlowId": { "format": "int32", "type": "integer" }, "Name": { "type": "string" }, "UploadTime": { "type": "string" }, "DisplayName": { "type": "string" }, "OriginatorId": { "format": "int32", "type": "integer" }, "CategoryName": { "type": "string" }, "DocumentNumber": { "type": "string" }, "ReferenceNo": { "type": "string" }, "Status": { "type": "string" }, "DocumentId": { "format": "int32", "type": "integer" }, "WorkflowType": { "format": "int32", "type": "integer" }, "NoofAttachment": { "type": "boolean" }, "SignatureType": { "format": "int32", "type": "integer" }, "Department": { "type": "string" }, "Comments": { "type": "string" }, "LotId": { "format": "int32", "type": "integer" }, "MenuID": { "format": "int32", "type": "integer" }, "PfOrder": { "format": "int32", "type": "integer" }, "AddExceptionalUser": { "type": "boolean" }, "Delegatedto": { "format": "int32", "type": "integer" }, "DelegatedBy": { "type": "string" }, "NoOfDocsCount": { "format": "int32", "type": "integer" }, "IsSigner": { "type": "boolean" }, "DeclinedDate": { "type": "string" }, "RecalledDate": { "type": "string" }, "ThumbnailBase64": { "type": "string" }, "InitiateBy": { "type": "string" } } }, "EmsignerAPI.BusinessObject.WorkflowSearchDTO": { "type": "object", "properties": { "TabStatusType": { "type": "string" }, "Status": { "description": "Status of the workflow(eg. Pending ,Completed)", "type": "string" }, "pagenumber": { "format": "int32", "description": "Used for pagination", "type": "integer" }, "PageSize": { "format": "int32", "description": "Used for pagination", "type": "integer" }, "SelectedYear": { "type": "string" }, "DocName": { "description": "DocumentName", "type": "string" }, "DocOwner": { "description": "Originator of the workflow", "type": "string" }, "StartDate": { "description": "Start Date( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "EndDate": { "description": "End Date ( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "LastSignedBy": { "type": "string" }, "CompletedDate": { "type": "string" }, "CompletedEndDate": { "type": "string" }, "DeclinedBy": { "type": "string" }, "DeclinedDate": { "description": "DeclinedDate ( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "DeclineEnddDate": { "type": "string" }, "RecalledDate": { "description": "RecalledDate ( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "RecalledEndDate": { "type": "string" }, "InactiveDate": { "type": "string" }, "InactiveEndDate": { "type": "string" }, "ExpiryFromDate": { "description": "Document expiry start date ( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "ExpiryToDate": { "description": "Document expiry end date ( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "PurgedDate": { "type": "string" }, "VoidedDate": { "type": "string" }, "TemplateName": { "description": "TemplateName of the workflow", "type": "string" }, "SendImageUrl": { "type": "boolean" }, "CategoryName": { "description": "CategoryName", "type": "string" }, "DocumentNumber": { "description": "DocumentNumber", "type": "string" }, "Referenceno": { "description": "Referenceno", "type": "string" }, "SignedDate": { "description": "SignedDate ( in yyyy-mm-dd format(2020-06-04))", "type": "string" }, "Customstatus": { "description": "Customstatus", "type": "string" }, "IsSearch": { "type": "boolean" }, "DonotRequireFlexiform": { "type": "boolean" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DashBoardViewModel]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DashBoardViewModel" } } } }, "EmsignerAPI.BusinessObject.DashBoardViewModel": { "type": "object", "properties": { "WorkFlowId": { "format": "int32", "type": "integer" }, "InitaitedBy": { "type": "string" }, "UploadTime": { "type": "string" }, "DisplayName": { "type": "string" }, "DocumentId": { "format": "int32", "type": "integer" }, "LastSignedOn": { "type": "string" }, "LastSignedBy": { "type": "string" }, "DeclinedOn": { "type": "string" }, "DeclinedBy": { "type": "string" }, "Remarks": { "type": "string" }, "RecalledOn": { "type": "string" }, "VoidedOn": { "type": "string" }, "PurgedOn": { "type": "string" }, "InactivedOn": { "type": "string" }, "Status": { "type": "string" }, "ThumbnailBase64": { "type": "string" }, "ReferenceNo": { "type": "string" }, "EnvelopNo": { "type": "string" }, "Category": { "type": "string" }, "Noofdocuments": { "format": "int32", "type": "integer" }, "NoofAttachments": { "format": "int32", "type": "integer" }, "Documents": { "type": "string" }, "NoOfComments": { "format": "int32", "type": "integer" }, "OriginatorId": { "format": "int32", "type": "integer" }, "TemplateId": { "format": "int32", "type": "integer" }, "WorkflowType": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.EtampingPaymentInfo": { "type": "object", "properties": { "ConsiderationPirce": { "type": "string" }, "ArticleCode": { "type": "string" }, "StateCode": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.EtampingPaymentResponse]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/BusinessObject.BusinessObject.EtampingPaymentResponse" } } }, "BusinessObject.BusinessObject.EtampingPaymentResponse": { "type": "object", "properties": { "StampdutyAmount": { "type": "string" }, "FinalAmount": { "type": "string" } } }, "EmsignerAPI.Controllers.GeteStampingSummaryController.eStampSummeryData": { "required": [ "State" ], "type": "object", "properties": { "State": { "description": "State off the estamp", "type": "string" }, "Denomination": { "description": "Denomination off the estamp", "type": "string" }, "PageNo": { "format": "int32", "type": "integer" }, "PageSize": { "format": "int32", "type": "integer" }, "ClientId": { "type": "string" }, "ClientName": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.OfflineeStampViewmodel]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.OfflineeStampViewmodel" } } } }, "BusinessObject.BusinessObject.OfflineeStampViewmodel": { "type": "object", "properties": { "Denomination": { "type": "string" }, "State": { "type": "string" }, "Allocated": { "format": "int32", "type": "integer" }, "Consumed": { "format": "int32", "type": "integer" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.OnlineEstampStates]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.OnlineEstampStates" } } } }, "BusinessObject.BusinessObject.OnlineEstampStates": { "type": "object", "properties": { "StateName": { "type": "string" }, "StateCode": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentDetailsResponse]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentDetailsResponse" } } } }, "EmsignerAPI.BusinessObject.DocumentDetailsResponse": { "type": "object", "properties": { "Base64FileData": { "type": "string" }, "DocumentName": { "type": "string" }, "IsPasswordProtected": { "type": "boolean" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.FlexiFormData]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.FlexiFormData" } } } }, "BusinessObject.BusinessObject.FlexiFormData": { "type": "object", "properties": { "DocumentId": { "format": "int32", "type": "integer" }, "DocumentName": { "type": "string" }, "FormData": { "type": "string" } } }, "BusinessObject.BusinessObject.WorkflowInfoInput": { "type": "object", "properties": { "WorkflowId": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "ParentDocumentId": { "format": "int32", "type": "integer" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.ParallelSigningURL]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ParallelSigningURL" } } } }, "EmsignerAPI.BusinessObject.ParallelSigningURL": { "type": "object", "properties": { "SequenceNumber": { "format": "int32", "type": "integer" }, "IdentificationNumber": { "type": "string" }, "Name": { "type": "string" }, "EmailId": { "type": "string" }, "MobileNo": { "type": "string" }, "URL": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.RecalledRemarksInfo]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.RecalledRemarksInfo" } } }, "EmsignerAPI.BusinessObject.RecalledRemarksInfo": { "type": "object", "properties": { "RecalledBy": { "format": "int32", "type": "integer" }, "RecalledTime": { "format": "date-time", "type": "string" }, "Remarks": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.UserRole]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserRole" } } } }, "EmsignerAPI.BusinessObject.UserRole": { "type": "object", "properties": { "RoleId": { "format": "int32", "type": "integer" }, "RoleName": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.SignatureTypes]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SignatureTypes" } } } }, "EmsignerAPI.BusinessObject.SignatureTypes": { "type": "object", "properties": { "SignatureId": { "format": "int32", "type": "integer" }, "SignatureType": { "type": "string" }, "SignatureOrder": { "format": "int32", "type": "integer" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.TimeZoneDTO]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.TimeZoneDTO" } } } }, "EmsignerAPI.BusinessObject.TimeZoneDTO": { "type": "object", "properties": { "TimeZone": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.AttachmentList]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.AttachmentList" } } } }, "EmsignerAPI.BusinessObject.AttachmentList": { "type": "object", "properties": { "DocumentID": { "format": "int32", "type": "integer" }, "AttachmentName": { "type": "string" }, "Base64FileData": { "type": "string" }, "NoOfPages": { "format": "int32", "type": "integer" }, "FileSize": { "format": "double", "type": "number" }, "Description": { "type": "string" }, "UploadedBy": { "format": "int32", "type": "integer" }, "UploaderName": { "type": "string" }, "UploadedDate": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.UserComment]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserComment" } } } }, "EmsignerAPI.BusinessObject.UserComment": { "type": "object", "properties": { "DocumentName": { "type": "string" }, "DocumentId": { "type": "string" }, "Comments": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.Comments" } } } }, "EmsignerAPI.BusinessObject.Comments": { "type": "object", "properties": { "Comment": { "type": "string" }, "UserName": { "type": "string" }, "Emaild": { "type": "string" }, "SubscriberId": { "type": "string" }, "CommentTime": { "type": "string" }, "CommentId": { "type": "string" }, "IsReviewerComment": { "type": "boolean" } } }, "eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.WorkflowInfo]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/BusinessObject.BusinessObject.WorkflowInfo" } } }, "BusinessObject.BusinessObject.WorkflowInfo": { "type": "object", "properties": { "WorkflowId": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "WorkflowStatus": { "type": "string" }, "NoOfDocuments": { "format": "int32", "type": "integer" }, "NoOfAttachment": { "format": "int32", "type": "integer" }, "WorkflowType": { "type": "string" }, "DocumentOwner": { "type": "string" }, "LastModifiedBy": { "type": "string" }, "DeclinedDate": { "type": "string" }, "Signatories": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.Signatories" } }, "DocumentInfo": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.DocumentInfo" } } } }, "EmsignerAPI.BusinessObject.Signatories": { "type": "object", "properties": { "EmailID": { "type": "string" }, "Name": { "type": "string" }, "Status": { "type": "string" }, "Remarks": { "type": "string" }, "SignerType": { "format": "int32", "type": "integer" }, "SignedDate": { "type": "string" }, "ModeOfSignature": { "type": "string" }, "WorkId": { "format": "int32", "type": "integer" }, "CurrentSignatoryName": { "type": "string" }, "PercentageNameMatch": { "type": "string" } } }, "BusinessObject.BusinessObject.DocumentInfo": { "type": "object", "properties": { "TemplateId": { "format": "int32", "type": "integer" }, "DocumentName": { "type": "string" }, "DocumentId": { "format": "int32", "type": "integer" }, "UploadDateTime": { "type": "string" }, "DocumentSize": { "type": "string" }, "Modifieddate": { "type": "string" }, "LastModifiedBy": { "type": "string" }, "DeclinedDate": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DocumentInfo]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DocumentInfo" } } } }, "EmsignerAPI.BusinessObject.DocumentInfo": { "type": "object", "properties": { "Signatories": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.Signatories" } }, "DocumentName": { "type": "string" }, "WorkflowName": { "type": "string" }, "DocumentNumber": { "type": "string" }, "DocumentId": { "format": "int32", "type": "integer" }, "UploadDateTime": { "type": "string" }, "DocumentSize": { "type": "string" }, "NoOfAttachment": { "format": "int32", "type": "integer" }, "NoOfDocuments": { "format": "int32", "type": "integer" }, "SubscriberId": { "format": "int32", "type": "integer" }, "Modifieddate": { "type": "string" }, "DocumentOwner": { "type": "string" }, "ReferenceNo": { "type": "string" }, "CurrentSigner": { "format": "int32", "type": "integer" }, "StatusId": { "format": "int32", "type": "integer" }, "WorkflowType": { "type": "string" }, "LastModifiedBy": { "type": "string" }, "CurrentSignatoryName": { "type": "string" }, "PercentageNameMatch": { "type": "string" } } }, "BusinessObject.BusinessObject.InitiateAndSignWorkflowConfig": { "required": [ "DocumentName", "FileData", "Signatories", "QRCodeCordinats" ], "type": "object", "properties": { "TemplateId": { "format": "int32", "type": "integer" }, "DocumentName": { "description": "Name of the document", "type": "string" }, "FileData": { "description": "Base64fileData of the PDF document", "type": "string" }, "Signatories": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.OnlineFlexiformSignersView" } }, "ReferenceNo": { "description": "ReferenceNo", "type": "string" }, "QRCodeCordinats": { "description": "QR code Information", "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.OnlineFlexiQRCoordinate" } }, "DonotSendCompletionMailToParticipants": { "description": "set true if you don't want to Send CompletionMail To Participants", "type": "boolean" }, "Reminder": { "format": "int32", "type": "integer" }, "eStampPayload": { "$ref": "#/definitions/BusinessObject.BusinessObject.EstampPayload" }, "FetchEstampDeatilsUsingRefNo": { "type": "boolean" }, "WorkflowType": { "format": "int32", "description": "1 for Serial 2 for parallel,Default 1", "type": "integer" }, "listAttachmentDetails": { "description": "Attachment Information", "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.AttachmentDetails" } }, "WaterMark": { "description": "base64 string format of watermark", "type": "string" }, "DocumentProtection": { "description": "for Disable printing ,2 for Disable content copying and 3 for Disable content copying for accessibility", "type": "string" }, "eStampType": { "description": "Offline, Online", "type": "string" }, "State": { "type": "string" }, "Denomination": { "format": "int32", "type": "integer" }, "ClientID": { "type": "string" }, "ClientName": { "type": "string" } } }, "BusinessObject.BusinessObject.OnlineFlexiformSignersView": { "type": "object", "properties": { "SignerType": { "format": "int32", "description": "1 for Signer and 2 for Reviewer (works only for Adhoc Signing)", "type": "integer" }, "Coordinates": { "description": "Co-ordinates for Adhoc Signing", "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.OnlineFlexiformCoordinate" } }, "SignatureImage": { "type": "string" }, "ReviewerComment": { "type": "string" }, "SearchText": { "type": "string" }, "Anchor": { "type": "string" }, "NotificationEmail": { "type": "string" }, "SigningFlowType": { "format": "int32", "type": "integer" }, "EmailId": { "description": "EmailId of the signer", "type": "string" }, "Name": { "description": "Name of the signer", "type": "string" }, "ContactNo": { "description": "ContactNo with country code", "type": "string" }, "ModeOfSignature": { "description": "Mode of Signature", "type": "string" }, "MailSendingOptions": { "format": "int32", "description": "1 for Primary , 2 for Alternative and 3 for both", "type": "integer" }, "ModeofAuthentication": { "format": "int32", "description": "EmailId of the signer", "type": "integer" } } }, "BusinessObject.BusinessObject.OnlineFlexiQRCoordinate": { "type": "object", "properties": { "Left": { "format": "int32", "type": "integer" }, "Height": { "format": "int32", "type": "integer" }, "PageNumber": { "type": "string" }, "SelectedPage": { "type": "string" }, "Top": { "format": "int32", "type": "integer" }, "Width": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.EstampPayload": { "type": "object", "properties": { "loan": { "$ref": "#/definitions/BusinessObject.BusinessObject.Loan" } } }, "BusinessObject.BusinessObject.AttachmentDetails": { "description": "Attachment Information", "required": [ "DocumentName", "Base64fileData" ], "type": "object", "properties": { "DocumentName": { "description": "Name of the attachment", "type": "string" }, "Base64fileData": { "description": "Base64fileData of the PDF document", "type": "string" }, "Description": { "description": "Comments", "type": "string" }, "DocumentPassword": { "description": "DocumentPassword", "type": "string" } } }, "BusinessObject.BusinessObject.OnlineFlexiformCoordinate": { "type": "object", "properties": { "ControlType": { "format": "int32", "description": "4-for Signature placeholder,8-for Initials", "type": "integer" }, "ControlValue": { "type": "string" }, "Placeholder": { "type": "string" }, "ValidationType": { "type": "string" }, "IsMandatory": { "format": "int32", "type": "integer" }, "IncludeInQRCode": { "type": "boolean" }, "MultiLine": { "type": "boolean" }, "GroupName": { "type": "string" }, "FontType": { "type": "string" }, "FontColor": { "type": "string" }, "FontStyle": { "type": "string" }, "FontSize": { "format": "int32", "type": "integer" }, "TextAlign": { "type": "string" }, "Left": { "format": "int32", "type": "integer" }, "Height": { "format": "int32", "type": "integer" }, "Top": { "format": "int32", "type": "integer" }, "Width": { "format": "int32", "type": "integer" }, "PageNumber": { "type": "string" }, "Page": { "type": "string" }, "Mandatory": { "type": "boolean" }, "MaxLength": { "format": "int32", "type": "integer" }, "IsBold": { "format": "int32", "type": "integer" }, "IsItalic": { "format": "int32", "type": "integer" }, "signatureVisibility": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.Loan": { "type": "object", "properties": { "loanno": { "type": "string" }, "snctnno": { "type": "string" }, "regType": { "type": "string" }, "txnID": { "type": "string" }, "signFlag": { "type": "string" }, "estampFlag": { "type": "string" }, "f2f": { "type": "string" }, "state": { "type": "string" }, "brname": { "type": "string" }, "braddr": { "type": "string" }, "estampdtls": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.Estampdtl" } }, "prtcptentty": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.Prtcptentty" } }, "loandtls": { "$ref": "#/definitions/BusinessObject.BusinessObject.Loandtls" }, "documentdtls": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.Documentdtl" } }, "scrtydtls": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.Scrtydtl" } }, "entty_dtls": { "$ref": "#/definitions/BusinessObject.BusinessObject.Enttydtls" } } }, "BusinessObject.BusinessObject.Estampdtl": { "type": "object", "properties": { "firstparty": { "type": "string" }, "secondparty": { "type": "string" }, "stampDutyAmount": { "type": "string" }, "considerationPrice": { "type": "string" }, "descriptionofDocument": { "type": "string" }, "stampdutyPaidby": { "type": "string" }, "articleCode": { "type": "string" }, "documentID": { "type": "string" }, "firstPartyOVDType": { "type": "string" }, "firstPartyOVDValue": { "type": "string" }, "secondPartyOVDType": { "type": "string" }, "secondPartyOVDValue": { "type": "string" }, "firstPartyPin": { "format": "int32", "type": "integer" }, "secondPartyPin": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.Prtcptentty": { "type": "object", "properties": { "prtcptenttyId": { "type": "string" }, "fulnm": { "type": "string" }, "cntrprtycntnm": { "type": "string" }, "cntrprtyaddr": { "type": "string" }, "reltocntrct": { "type": "string" }, "emlid": { "type": "string" }, "cntrprtycntmobno": { "type": "string" }, "panno": { "type": "string" }, "ovdtype": { "type": "string" }, "ovdid": { "type": "string" }, "doi": { "type": "string" }, "lglcnstn": { "type": "string" }, "partytyp": { "type": "string" } } }, "BusinessObject.BusinessObject.Loandtls": { "type": "object", "properties": { "loanno": { "type": "string" }, "snctnno": { "type": "string" }, "dtofsnctn": { "type": "string" }, "emiamt": { "type": "string" }, "rtofint": { "type": "string" }, "snctnamt": { "type": "string" }, "tenure": { "type": "string" }, "ntrofcrdt": { "type": "string" }, "isacctclosed": { "type": "string" }, "fundtyp": { "type": "string" }, "currofsanc": { "type": "string" }, "crdtsubtyp": { "type": "string" }, "fcltynm": { "type": "string" }, "amtovrdue": { "type": "string" } } }, "BusinessObject.BusinessObject.Documentdtl": { "type": "object", "properties": { "documentID": { "type": "string" }, "docData": { "type": "string" }, "docRefNo": { "type": "string" } } }, "BusinessObject.BusinessObject.Scrtydtl": { "type": "object", "properties": { "dscofscrty": { "type": "string" }, "asstyp": { "type": "string" }, "typofchrg": { "type": "string" }, "assetid": { "type": "string" } } }, "BusinessObject.BusinessObject.Enttydtls": { "type": "object", "properties": { "entty_pan": { "type": "string" }, "entty_name": { "type": "string" }, "lgl_cnstn": { "type": "string" }, "doi": { "type": "string" }, "eml_id": { "type": "string" }, "reg_addr": { "type": "string" }, "reg_pin": { "type": "string" }, "comm_addr": { "type": "string" }, "cntct_no": { "type": "string" }, "comm_pin": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.InitiateAndSignWorkFlowResponse]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/BusinessObject.BusinessObject.InitiateAndSignWorkFlowResponse" } } }, "BusinessObject.BusinessObject.InitiateAndSignWorkFlowResponse": { "type": "object", "properties": { "ReferenceNo": { "type": "string" }, "DocumentNumberList": { "type": "array", "items": { "type": "string" } }, "DocumentIdList": { "type": "array", "items": { "format": "int64", "type": "integer" } }, "Status": { "type": "boolean" }, "WorkflowId": { "format": "int64", "type": "integer" }, "SignatoryDetails": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SignatoryInformation" } }, "URL": { "type": "string" }, "ParallelSigningURLs": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ParallelSigningURL" } }, "TransactionNumber": { "type": "string" }, "RedirectURL": { "type": "string" }, "ResponseCode": { "type": "string" }, "TemplateId": { "format": "int32", "type": "integer" } } }, "EmsignerAPI.BusinessObject.SignatoryInformation": { "type": "object", "properties": { "SequenceNumber": { "format": "int32", "type": "integer" }, "IdentificationNumber": { "type": "string" }, "Name": { "type": "string" }, "EmailId": { "type": "string" }, "MobileNo": { "type": "string" }, "URL": { "type": "string" } } }, "BusinessObject.BusinessObject.WorkflowConfigFlexiform": { "description": "Input config", "required": [ "Signatories", "TemplateId" ], "type": "object", "properties": { "FetchEstampDeatilsUsingRefNo": { "type": "boolean" }, "Data": { "description": "(as XML string) - data to be populated in flexiform fields as per the tagnames names mapped", "type": "string" }, "Signatories": { "description": "List of signers", "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.SignersFlexiForm" } }, "TemplateId": { "format": "int32", "description": "TemplateId -(fetched using GetTemplates) of the form created through Manage Workflows", "type": "integer" }, "DonotSendCompletionMailToParticipants": { "description": "set true if you don't want to Send CompletionMail To Participants", "type": "boolean" }, "Reminder": { "format": "int32", "type": "integer" }, "ReferenceNo": { "type": "string" }, "WorkflowType": { "format": "int32", "description": "1 for Serial 2 for parallel,Default 1", "type": "integer" }, "listAttachmentDetails": { "description": "Attachment Information", "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.AttachmentDetails" } }, "WaterMark": { "description": "base64 string format of watermark", "type": "string" }, "DocumentProtection": { "description": "for Disable printing ,2 for Disable content copying and 3 for Disable content copying for accessibility", "type": "string" }, "eStampType": { "description": "Offline, Online", "type": "string" }, "State": { "type": "string" }, "Denomination": { "format": "int32", "type": "integer" }, "ClientID": { "type": "string" }, "ClientName": { "type": "string" } } }, "BusinessObject.BusinessObject.SignersFlexiForm": { "description": "", "type": "object", "properties": { "EmailId": { "description": "EmailId of the signer", "type": "string" }, "Name": { "description": "Name of the signer", "type": "string" }, "ContactNo": { "description": "ContactNo with country code", "type": "string" }, "ModeOfSignature": { "description": "Mode of Signature", "type": "string" }, "MailSendingOptions": { "format": "int32", "description": "1 for Primary , 2 for Alternative and 3 for both", "type": "integer" }, "ModeofAuthentication": { "format": "int32", "description": "EmailId of the signer", "type": "integer" } } }, "EmsignerAPI.BusinessObject.EmbeddedSigningViewModel.EmbeddedSigningRequest": { "required": [ "RequestFrom", "WorkflowType", "Name", "EmailId", "lstDocumentDetails" ], "type": "object", "properties": { "ClientID": { "type": "string" }, "ClientName": { "type": "string" }, "RequestFrom": { "description": "Request of origination", "type": "string" }, "WorkflowType": { "format": "int32", "description": "2-Serial Flexiform,5-In person", "type": "integer" }, "ReferenceNo": { "description": "Referenceno-unique identification number from the source system", "type": "string" }, "Name": { "description": "Name of the originator", "type": "string" }, "EmailId": { "description": "Email Id of the originator", "type": "string" }, "State": { "type": "string" }, "Denomination": { "format": "int32", "type": "integer" }, "Reminder": { "type": "string" }, "RedirectURL": { "type": "string" }, "EnvelopeExpiry": { "format": "int32", "type": "integer" }, "DoNotNotifyCustomer": { "type": "boolean" }, "DonotSendCompletionMailToParticipants": { "type": "boolean" }, "EnableAutoClosePopup": { "type": "boolean" }, "AllowSignatoryCountOverride": { "type": "boolean" }, "CollectPaymentFromParticipant": { "type": "boolean" }, "InitiateNESLFlow": { "type": "boolean" }, "eStampType": { "type": "string" }, "EstampAmount": { "type": "string" }, "FetchEstampDeatilsUsingRefNo": { "type": "boolean" }, "SuppressEstampPage": { "type": "boolean" }, "SignatoryEmailIds": { "type": "array", "items": { "type": "string" } }, "FailoverProfileId": { "type": "string" }, "EmailMessage": { "type": "string" }, "SignatureSettings": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SignatureSettings" } }, "lstDocumentDetails": { "description": "List of document details", "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.DocumentDetails" } }, "TemplateList": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.TemplateDetails" } }, "listAttachmentDetails": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.AttachmentDetails" } }, "eStampPayload": { "$ref": "#/definitions/BusinessObject.BusinessObject.EstampPayload" }, "OfflineStamps": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.BulkeStamp" } } }, "EmsignerAPI.BusinessObject.SignatureSettings": { "type": "object", "properties": { "ModeOfSignature": { "type": "string" }, "ModeOfAuthentication": { "type": "string" }, "CaptureSelfie": { "type": "boolean" }, "VerifyDemographicData": { "type": "boolean" }, "Automatedsigningenabled": { "type": "boolean" }, "VerifyPhotoWithVideo": { "type": "boolean" }, "Name": { "type": "string" }, "MobileNo": { "type": "string" }, "CountryCode": { "type": "string" }, "DOB": { "type": "string" }, "Gender": { "type": "string" }, "NotificationEmail": { "type": "string" }, "IdentificationNumber": { "type": "string" }, "eSignAuthMode": { "format": "int32", "type": "integer" }, "Location": { "type": "string" }, "Reason": { "type": "string" } } }, "EmsignerAPI.BusinessObject.ValidateAPPViewModel.DocumentDetails": { "description": "This class is used push the document details", "required": [ "DocumentName", "FileData" ], "type": "object", "properties": { "DocumentName": { "description": "Name of the document", "type": "string" }, "PullFileDataFromURL": { "type": "boolean" }, "FileData": { "description": "FileData in base64 format", "type": "string" }, "TemplateId": { "format": "int32", "type": "integer" }, "ControlDetails": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.BulkPFConfigViewModel" } }, "QRCodeCordinats": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.OnlineFlexiQRCoordinate" } }, "MergeDocumentDetails": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.MergeDocumentmentDetails" } } } }, "BusinessObject.BusinessObject.TemplateDetails": { "type": "object", "properties": { "TemplateId": { "format": "int32", "type": "integer" }, "ControlDetails": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.FormData" } }, "MergeDocumentDetails": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.MergeDocumentmentDetails" } }, "FileData": { "type": "string" }, "DocumentName": { "type": "string" } } }, "EmsignerAPI.BusinessObject.BulkeStamp": { "type": "object", "properties": { "State": { "type": "string" }, "Denomination": { "type": "array", "items": { "format": "int32", "type": "integer" } } } }, "EmsignerAPI.BusinessObject.ValidateAPPViewModel.BulkPFConfigViewModel": { "type": "object", "properties": { "ControlID": { "format": "int32", "type": "integer" }, "AssignedTo": { "format": "int32", "type": "integer" }, "PageNo": { "type": "string" }, "Page": { "type": "string" }, "Left": { "format": "int32", "type": "integer" }, "Top": { "format": "int32", "type": "integer" }, "Height": { "format": "int32", "type": "integer" }, "Width": { "format": "int32", "type": "integer" }, "FontType": { "type": "string" }, "FontSize": { "format": "int32", "type": "integer" }, "PlaceHolder": { "type": "string" }, "ValidationType": { "type": "string" }, "SearchText": { "type": "string" }, "Anchor": { "type": "string" }, "InitialSearchText": { "type": "string" }, "InitialAnchor": { "type": "string" }, "EmateraiSearchtext": { "type": "string" }, "EmateraiaAnchor": { "type": "string" }, "SignerType": { "format": "int32", "type": "integer" }, "ControlValue": { "type": "string" } } }, "EmsignerAPI.BusinessObject.MergeDocumentmentDetails": { "type": "object", "properties": { "DocumentName": { "type": "string" }, "FileData": { "type": "string" }, "AddSignaturePlaceholder": { "type": "boolean" }, "ParentDocumentId": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.FormData": { "type": "object", "properties": { "TagName": { "type": "string" }, "Value": { "type": "string" } } }, "EmsignerAPI.BusinessObject.UserSearchView": { "required": [ "pagenumber" ], "type": "object", "properties": { "pagenumber": { "format": "int32", "description": "Used for pagination 1,gives 1-10 records , 2 gives 11-20 and so on", "type": "integer" }, "EmailId": { "description": "EmailId of the adhocuser", "type": "string" }, "Name": { "description": "Name of the adhocuser", "type": "string" }, "Organization": { "description": "Organization of the adhocuser", "type": "string" }, "Status": { "format": "int32", "description": "1-active,2-pending for approval,3-rejected,default 1", "type": "integer" }, "CreatedDate": { "description": "CreatedDate in yyyy-MM-dd format", "type": "string" }, "UpdatedOn": { "type": "string" }, "RejectedBy": { "type": "string" }, "Remarks": { "type": "string" }, "CreatedBy": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[BusinessObject.BusinessObject.AdhocUserGet]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/BusinessObject.BusinessObject.AdhocUserGet" } } } }, "BusinessObject.BusinessObject.AdhocUserGet": { "required": [ "Name", "Email" ], "type": "object", "properties": { "Name": { "description": "Name of the adhoc-user", "type": "string" }, "Email": { "description": "Email of the adhoc-user", "type": "string" }, "ContactNumber": { "description": "ContactNumber of the adhoc-user", "type": "string" }, "CountryCode": { "type": "string" }, "Organization": { "type": "string" }, "AlternativeEmail": { "type": "string" }, "SubscriberId": { "format": "int32", "type": "integer" }, "IsRejected": { "type": "boolean" }, "RejectedBy": { "type": "string" }, "IsActive": { "type": "boolean" }, "CreatedDateTime": { "format": "date-time", "type": "string" }, "NationalId": { "type": "string" }, "Createdby": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[eMDMS.Helper.Utility.CountryList]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/eMDMS.Helper.Utility.CountryList" } } } }, "eMDMS.Helper.Utility.CountryList": { "type": "object", "properties": { "CountryName": { "type": "string" }, "CountryCode": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.DepartmentDetails]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.DepartmentDetails" } } } }, "EmsignerAPI.BusinessObject.DepartmentDetails": { "type": "object", "properties": { "DepartmentID": { "format": "int32", "type": "integer" }, "DepartmentName": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.GetWorkflow]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.GetWorkflow" } } } }, "EmsignerAPI.BusinessObject.GetWorkflow": { "type": "object", "properties": { "TemplateId": { "format": "int32", "type": "integer" }, "TemplateName": { "type": "string" }, "ParentId": { "format": "int32", "type": "integer" }, "TemplateType": { "format": "int32", "type": "integer" }, "SubscriberId": { "format": "int32", "type": "integer" } } }, "EmsignerAPI.Controllers.ListTemplatesController.TemplateFilter": { "type": "object", "properties": { "IsWorkflowCreated": { "type": "boolean" } } }, "eMDMS.Helper.ReturnObject[System.Collections.Generic.List[EmsignerAPI.BusinessObject.UserViewModelGet]]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.UserViewModelGet" } } } }, "EmsignerAPI.BusinessObject.UserViewModelGet": { "required": [ "Name", "EmailID", "DepartmentID", "InternalUser2FA", "UserRoleId", "CompanyName", "Country", "SignatureOption" ], "type": "object", "properties": { "Name": { "description": "Name of the User", "type": "string" }, "MobileNumber": { "description": "MobileNo of the User", "type": "string" }, "EmailID": { "description": "EmailId of the User(Required only while creating new user)", "type": "string" }, "DepartmentID": { "format": "int32", "description": "DeapartmentId of the User(Fetched using ListDepartments api)", "type": "integer" }, "Designation": { "description": "Designation of the User", "type": "string" }, "InternalUser2FA": { "description": "True if login needs to be enabled with Username, Password and OTP", "type": "boolean" }, "UserRoleId": { "format": "int32", "description": "UserRoleId: Fetched using GetRoles", "type": "integer" }, "Address": { "description": "Address of the User", "type": "string" }, "State": { "description": "State of the User", "type": "string" }, "City": { "description": "City of the User", "type": "string" }, "ZipCode": { "description": "Pin number of the User", "type": "string" }, "IsAdmin": { "description": "true if user will be having admin access", "type": "boolean" }, "CompanyName": { "description": "Comapany name of the User", "type": "string" }, "Country": { "description": "Country name of the User", "type": "string" }, "SignatureOption": { "format": "int32", "description": "1-Enable LTV, 2-TimeStamp,3-None", "type": "integer" }, "AlternativeEmailId": { "description": "Alternative EmailId of the user(Required only while creating new user)", "type": "string" }, "SubscriberId": { "format": "int32", "description": "SubscriberId of the existing user(Required only while updation)", "type": "integer" }, "IsActive": { "type": "boolean" } } }, "EmsignerAPI.BusinessObject.MapWorkflowToDepartments": { "description": "Get OCR details by Document Id.", "required": [ "DepartmentIds", "TemplateId" ], "type": "object", "properties": { "DepartmentIds": { "description": "Department Ids(fetched using ListDepartments)- Comma separated values of departments to be mapped, \"\" if want to remove access for all departments", "type": "string" }, "TemplateId": { "format": "int32", "description": "TemplateId - Id of the Workflow for which access needs to be mapped (fetched using ListTemplates)", "type": "integer" } } }, "EmsignerAPI.BusinessObject.MapUsersToDepartment": { "description": "Get OCR details by Document Id.", "required": [ "SubscriberIds", "DepartmentID" ], "type": "object", "properties": { "SubscriberIds": { "description": "Subscriber Ids(fetched using ListUsers) - comma separeted values of Subscribers to be mapped", "type": "string" }, "DepartmentID": { "format": "int32", "description": "DepartmentID - Id of created department (fetched using ListDepartments)", "type": "integer" } } }, "EmsignerAPI.BusinessObject.RecallInput": { "required": [ "Remarks" ], "type": "object", "properties": { "WorkflowId": { "format": "int32", "description": "WorkflowId(fetched using GetAllDocuments)", "type": "integer" }, "Remarks": { "description": "Remarks to recall a workflow", "type": "string" }, "ReferenceNo": { "description": "ReferenceNo(fetched using GetAllDocuments)", "type": "string" } } }, "EmsignerAPI.BusinessObject.RemoteSigningRequest": { "required": [ "lstDocumentDetails" ], "type": "object", "properties": { "ReferenceNo": { "description": "Referenceno-unique identification number from the source system", "type": "string" }, "lstDocumentDetails": { "description": "List of document details", "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.DocumentDetails" } }, "SignatoryEmail": { "type": "string" }, "SignatureImage": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[BusinessObject.BusinessObject.RemoteSignResponse]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/BusinessObject.BusinessObject.RemoteSignResponse" } } }, "BusinessObject.BusinessObject.RemoteSignResponse": { "type": "object", "properties": { "SignedData": { "type": "array", "items": { "type": "string" } }, "ReferenceNo": { "type": "string" }, "DocumentNumberList": { "type": "array", "items": { "type": "string" } }, "DocumentIdList": { "type": "array", "items": { "format": "int64", "type": "integer" } }, "Status": { "type": "boolean" }, "WorkflowId": { "format": "int64", "type": "integer" }, "SignatoryDetails": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.SignatoryInformation" } }, "URL": { "type": "string" }, "ParallelSigningURLs": { "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ParallelSigningURL" } }, "TransactionNumber": { "type": "string" }, "RedirectURL": { "type": "string" }, "ResponseCode": { "type": "string" }, "TemplateId": { "format": "int32", "type": "integer" } } }, "BusinessObject.BusinessObject.WebhookModel": { "type": "object", "properties": { "department": { "type": "string" }, "requestFrom": { "type": "string" }, "event": { "$ref": "#/definitions/BusinessObject.BusinessObject.Event" }, "target": { "type": "string" }, "name": { "type": "string" }, "authentication": { "$ref": "#/definitions/BusinessObject.BusinessObject.Authentication" } } }, "BusinessObject.BusinessObject.Event": { "type": "object", "properties": { "recalled": { "type": "boolean" }, "declined": { "type": "boolean" }, "completion": { "type": "boolean" }, "signedReviewed": { "type": "boolean" }, "customStatus": { "type": "boolean" } } }, "BusinessObject.BusinessObject.Authentication": { "type": "object", "properties": { "type": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" } } }, "EmsignerAPI.BusinessObject.ShareInput": { "description": "Input shareInput", "required": [ "Email" ], "type": "object", "properties": { "Email": { "description": "Multiple emailids separated by semicolon to whom you want to share", "type": "string" }, "WorkflowId": { "format": "int32", "description": "WorkflowId (fetched using GetAllDocuments)", "type": "integer" }, "MessageContent": { "description": "Comments", "type": "string" }, "IsAttached": { "description": "Set true if need to share attachment as well", "type": "boolean" }, "ReferenceNo": { "description": "Reference No (fetched using GetAllDocuments)", "type": "string" } } }, "EmsignerAPI.BusinessObject.UpdateCommentInput": { "description": "UpdateCommentInput", "required": [ "Comment", "CommentID" ], "type": "object", "properties": { "Comment": { "description": "Comment", "type": "string" }, "CommentID": { "format": "int32", "description": "CommentID (fetched using GetWorkflowComments)", "type": "integer" } } }, "EmsignerAPI.BusinessObject.ValidateAPPViewModel.ValidateAppRequest": { "description": "This class is used to validate the Third party apps for embedded signing", "required": [ "RequestFrom", "Name", "EmailId", "lstDocumentDetails" ], "type": "object", "properties": { "RequestFrom": { "description": "Request of origination", "type": "string" }, "Name": { "description": "Name of the originator", "type": "string" }, "EmailId": { "description": "Email Id of the originator", "type": "string" }, "ReferenceNo": { "description": "Referenceno-unique identification number from the source system", "type": "string" }, "lstDocumentDetails": { "description": "List of document details", "type": "array", "items": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.ValidateAPPViewModel.DocumentDetails" } }, "ConfigJson": { "type": "string" } } }, "eMDMS.Helper.ReturnObject[EmsignerAPI.BusinessObject.subscriberLogingResp]": { "type": "object", "properties": { "IsSuccess": { "type": "boolean" }, "Messages": { "type": "array", "items": { "type": "string" } }, "ErrorCode": { "format": "int32", "type": "integer" }, "Response": { "$ref": "#/definitions/EmsignerAPI.BusinessObject.subscriberLogingResp" } } }, "EmsignerAPI.BusinessObject.subscriberLogingResp": { "type": "object", "properties": { "AuthToken": { "type": "string" }, "IsPasswordUpdated": { "type": "boolean" }, "IsPasswordCompliant": { "type": "boolean" }, "ErrorCode": { "format": "int32", "type": "integer" }, "RefreshToken": { "type": "string" }, "IsValid": { "type": "boolean" }, "IsExpired": { "type": "boolean" } } } } }