BeginSession - POST

Overview

This is the primary service call to start a DocViewer session. With the provided transaction data, it utilizes the repository specified in the appSettings.config to autoselect documents within packages or load specific list of documents.

Method

Method URL Description
POST /api/Sessions/V2/BeginSession The POST method submits the id and transaction data as part of the call to begin the DocViewer session.

Parameters

Name Type Constraints Description
accountId integer required An element indicating the Administration account to associate the request.
transactionData string required Transaction file to use with the new DocViewer session
CallbackPath string The request path within the application's base path where the user-agent will be returned

Sample Request

{
    "Account" : {
        "Id":1
    },
    "CallbackPath" : "https://localhost/TestWebApp/DocViewer/EndSession?SessionId=<SESSION_ID>",
    "TransactionData" : "PFR..."
    "packages": [
        {
            "id": "BaseLibrary.PKG.DepositAccountOpening"
        }
    ],
    "options": {
        "supportRequiredData": true,
        "filterOptionalDocuments" : true,
        "filterRequiredDocuments" : false
    },
  "changedDataPoints": [
    {
      "xPath": "/Txn/PrivacyNoticeInd[1]",
      "changeType": 1,
      "newValue": "1"
    },
        {
      "xPath": "/Txn/Deposit[1]/Accounts[1]/Account[1]/Holders[1]/Holder[1]/FormAutomaticDepositToMultipleAccountsAccount1CreditTypeSpecifiedDesc[1]",
      "changeType": "Edit",
      "newValue": "1234"
    }
  ]
 
}

Sample Response

{
    "error": null,
    "errorId": null,
    "sessionId": "33b42a64-cd22-4f6e-86f2-8bc0c0cb7eb1",
    "redirectUrl": "https://expere-dev-x.wkmnlab.net/DocViewerInterfaceHtml/",
    "swt": "<BinarySecurityToken ValueType=\"http://schemas.xmlsoap.org/ws/2009/11/swt-token-profile-1.0\" EncodingType=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary\" xmlns=\"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd\">U2Vzc2lvbklkPTMzYjQyYTY0LWNkMjItNGY2ZS04NmYyLThiYzBjMGNiN2ViMSU3YzEwNjI2NjkwMzgmaHR0cCUzYSUyZiUyZnNjaGVtYXMueG1sc29hcC5vcmclMmZ3cyUyZjIwMDUlMmYwNSUyZmlkZW50aXR5JTJmY2xhaW1zJTJmbmFtZT1hZG1pbjEmSXNzdWVyPWRvY3ZpZXdlci53b2x0ZXJza2x1d2VyZnMuY29tJkF1ZGllbmNlPSZFeHBpcmVzT249MTYzNTI2MDMwMyZITUFDU0hBMjU2PSUyZjdvaE9TTmxGRTUlMmJtQXR5cklqTU9BdyUyYmxkR0h1eU1iM2pDY1h1aE5XSzAlM2Q=</BinarySecurityToken>"
}