The XpressDox API is a service you can use to harness the power of document automation within your application.
\nThis is a RESTful API and all response data is returned in XML format.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"4290572","collectionId":"6acc40af-4e3f-4a78-b8a1-6f3fd7a11190","publishedId":"RW1ekdDa","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-05-10T06:29:27.000Z"},"item":[{"name":"Shared Interviews","item":[{"name":"Get shared interviews","id":"365572fa-bc95-408d-a347-f504077334e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetSharedInterviews?authenticationTicket={{authenticationTicket}}&pageNumber=0","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetSharedInterviews"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"pageNumber","value":"0"}],"variable":[]}},"response":[],"_postman_id":"365572fa-bc95-408d-a347-f504077334e2"},{"name":"Share interview","id":"14e0e4ef-fa6b-4248-bfd3-6fbd0598f02e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\nThis GET request is used to authenticate your application with the XpressDox Server API service in order to run templates and receive documents in return.
Note: If you don't already have an XpressDox Server account, register here.
\nNormally your XpressDox Server Account Administrator will create a 'run-only' user account for running templates through this API.
\nIn this case the username and password parameters should be the credentials for this 'run-only' user.
Alternatively, any other registered user's credentials may be used here.
\nThis method returns an authenticationTicket string to be used in subsequent requests.
NB: GET requests such as this may expose your username and password via web server logs. If this is a concern for you, use Method 1b below.
This POST request is used to authenticate your application with the XpressDox Server API service in order to run templates and receive documents in return.
Note: If you don't already have an XpressDox Server account, register here.
\nNormally your XpressDox Server Account Administrator will create a 'run-only' user account for running templates through this API.
\nIn this case the username and password parameters should be the credentials for this 'run-only' user.
Alternatively, any other registered user's credentials may be used here.
\nThe data containing your preferred account credentials must be sent in XML format.
\nThis method returns an authenticationTicket string to be used in subsequent requests.
This method is used to retrieve the contents of a folder on the XpressDox Server.
\nNote: Send an empty string for {folderIdentifier} to retrieve the contents of the root folder.
This method returns a list of the ServerFile elements.
Response example:
2019-11-14T16:16:09.6250379+02:00
\n0
\nFolder
\nhQhEX7mlUttKm94koN9nqw==
FolderName
Folder
FolderTitle
\n2019-09-20T11:07:39.3129337+03:00
\n0
\nMyDocuments
\n7jCUb9fJwTFykbMWaGmrobJ6rfyeSeBqyakwpNfgasG4tmcKRBjH3g==
9e9f5690-b003-4a73-8a6b-b704aeafd62b
MyDocumentsFolder
9e9f5690-b003-4a73-8a6b-b704aeafd62b
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","ExploreFolder"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"folderIdentifier","value":""}],"variable":[]}},"response":[{"id":"6de286ab-1b4d-4795-9ce6-96d29ba50ccc","name":"2a. Explore folder (root folder)","originalRequest":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/ExploreFolder?authenticationTicket={{authenticationticket}}&folderIdentifier=","host":["{{serverurl}}"],"path":["IntegrationServices","ThirdPartyService.svc","ExploreFolder"],"query":[{"key":"authenticationTicket","value":"{{authenticationticket}}"},{"key":"folderIdentifier","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[],"responseTime":null,"body":"This method is used to retrieve the contents of a folder on the XpressDox Server.
\nThis method returns a list of the ServerFile elements.
This method is used to retrieve the contents of a folder on the XpressDox Server, including non-template files.
\nThis method returns a list of the ServerFile elements.
This method is used to create new folder.
\nThis method returns a ServerFile element.
This request is used to delete a folder from the server.
\nThe folder to be deleted is specified by the folderIidentifier parameter.
This request returns status code 200 if successful.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","DeleteFolder"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"folderIdentifier","value":"{{folderToDelete}}"}],"variable":[]}},"response":[],"_postman_id":"32d99090-9b40-4f2e-8b72-a7922b12092b"},{"name":"2f. Get Folder profile","id":"c97f2f19-4416-4df0-aeba-d239b64f8743","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetFolderProfile?authenticationTicket={{authenticationTicket}}&folderIdentifier={{folderIdentifier}}","description":"This method is used to retrieve folder profile.
\nThis method returns a ServerFile object.
This method is used to retrieve folder profile.
\nThis method returns a ServerFile object.
This method is used to retrieve template profile.
\nThis method returns a ServerFile object.
Use this GET request to retrieve the URL of the web interview.
The template is identified by the fileIdentifier.
NOTE: this identifier is dynamic and may change across sessions. However, the template URL returned is static and may be used over and over again.
\nThis request is ideal for use in a static web page where the user may assemble as many document as they wish.
\nA URL is returned by this request that can be used to display the given template's interview.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetTemplateURL"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"fileIdentifier","value":"{{fileIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}],"variable":[]}},"response":[],"_postman_id":"68bde434-de14-40ae-b7ec-549cbdd5a673"},{"name":"4. Get template URL using template identifier","event":[{"listen":"test","script":{"id":"092c7fbc-6eef-401f-bd51-b54e5a48e8a1","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"d9806b33-cac1-425d-8131-59fa8c59e7d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetTemplateURLByTemplateID?authenticationTicket={{authenticationTicket}}&templateIdentifier={{templateIdentifier}}&returnURL={{returnurl}}","description":"This request is used to retrieve the URL of the web interview. It is similar to Method 3 above. See Integration Information above for additional control over your integration.
The template is identified by the templateIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe template URL returned can only be used for a single assembly. This is ideal for your dynamic web application or ecommerce site where assembled documents are sold, for example.
\nA URL is returned by this request that can be used to display the given template's interview.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetTemplateURLByTemplateID"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"templateIdentifier","value":"{{templateIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}],"variable":[]}},"response":[],"_postman_id":"d9806b33-cac1-425d-8131-59fa8c59e7d0"},{"name":"4.1 Get template URL using template identifier with data","event":[{"listen":"test","script":{"id":"092c7fbc-6eef-401f-bd51-b54e5a48e8a1","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"0a448777-2fdf-4d7d-af86-5e65a4b96f92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"This request is used to retrieve the URL of the web interview. It is similar to Method 4 above but with injected data. Injected data must be posted in a body as valid XML.
The template is identified by the templateIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe template URL returned can only be used for a single assembly. This is ideal for your dynamic web application or ecommerce site where assembled documents are sold, for example.
\nA URL is returned by this request that can be used to display the given template's interview.
\n","urlObject":{"path":["ThirdPartyService.svc","GetTemplateURLByTemplateID"],"host":["{{serverurl}}IntegrationServices"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"templateIdentifier","value":"{{templateIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}],"variable":[]}},"response":[],"_postman_id":"0a448777-2fdf-4d7d-af86-5e65a4b96f92"},{"name":"5. Get single use template URL using file identifier","event":[{"listen":"test","script":{"id":"c943c50d-2a07-4878-9acb-c9e35bf8fd7b","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;"],"type":"text/javascript"}}],"id":"8b0e88db-e633-483f-8003-5666b8945708","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetSingleUsageTemplateURL?authenticationTicket={{authenticationTicket}}&fileIdentifier={{fileIdentifier}}&returnURL={{returnurl}}","description":"This request is used to retrieve the URL of a web interview. See Integration Information above for additional control over your integration.
\nThe template is identified by its fileIdentifier.
NOTE: this identifier is dynamic and may change across sessions.
\nIt is important to note that the template URL returned by this request can only be used for a single assembly. This is ideal for use in your dynamic web application where a user can browse a list of templates and select a particular interview to run.
\nA URL is returned by this request that can be used to display the given template's interview.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageTemplateURL"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"fileIdentifier","value":"{{fileIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}],"variable":[]}},"response":[{"id":"e23ffc5e-bd05-4cdd-87bd-934dff3c691b","name":"5. Get single use template URL using file identifier","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetSingleUsageTemplateURL?authenticationTicket={{authenticationticket}}&fileIdentifier={{fileIdentifier}}&returnURL={{returnurl}}","host":["{{serverurl}}"],"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageTemplateURL"],"query":[{"key":"authenticationTicket","value":"{{authenticationticket}}"},{"key":"fileIdentifier","value":"{{fileIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"P3P","value":"CP=\"HONK\""},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamVjdHNcQUpTXFJlcG9zaXRvcnlcUHJvamVjdHNcbzJTbWFydC5Eb2N1bWVudEFzc2VtYmx5LldlYlxJbnRlZ3JhdGlvblNlcnZpY2VzXFRoaXJkUGFydHlTZXJ2aWNlLnN2Y1xHZXRTaW5nbGVVc2FnZVRlbXBsYXRlVVJM?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 26 Nov 2019 09:51:21 GMT"},{"key":"Content-Length","value":"233"}],"cookie":[],"responseTime":null,"body":"This request is used to retrieve the token of a web interview. See Integration Information above for additional control over your integration.
\nThe template is identified by its fileIdentifier.
NOTE: this identifier is dynamic and may change across sessions.
\nIt is important to note that the token returned by this request can only be used for a single assembly. This is ideal for use in your dynamic web application where a user can browse a list of templates and select a particular interview to run.
\nA URL is returned by this request that can be used to display the given template's interview.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageByFileIndentifier"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"fileIdentifier","value":"{{fileIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}],"variable":[]}},"response":[{"id":"45245eaa-d5c5-4849-8436-135933b7e2d6","name":"5.1. Get single use template token using file identifier","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetSingleUsageByFileIndentifier?authenticationTicket={{authenticationticket}}&fileIdentifier={{fileIdentifier}}&returnURL={{returnurl}}","host":["{{serverurl}}"],"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageByFileIndentifier"],"query":[{"key":"authenticationTicket","value":"{{authenticationticket}}"},{"key":"fileIdentifier","value":"{{fileIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"P3P","value":"CP=\"HONK\""},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamVjdHNcQUpTXFJlcG9zaXRvcnlcUHJvamVjdHNcbzJTbWFydC5Eb2N1bWVudEFzc2VtYmx5LldlYlxJbnRlZ3JhdGlvblNlcnZpY2VzXFRoaXJkUGFydHlTZXJ2aWNlLnN2Y1xHZXRTaW5nbGVVc2FnZUJ5RmlsZUluZGVudGlmaWVy?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 26 Nov 2019 09:57:32 GMT"},{"key":"Content-Length","value":"113"}],"cookie":[],"responseTime":null,"body":"This request is used to retrieve the URL of the web interview. It is similar to Method 5 above. See Integration Information above for additional control over your integration.
The template is identified by the templateIdentifier.
The 'Run As User' is identified by optional parameter runAsUserIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe template URL returned can only be used for a single assembly. This is ideal for your dynamic web application or ecommerce site where assembled documents are sold, for example.
\nA URL is returned by this request that can be used to display the given template's interview.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageTemplateURLByTemplateID"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"templateIdentifier","value":"{{templateIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"},{"key":"runAsUserIdentifier","value":"{{runAsUserIdentifier}}"}],"variable":[]}},"response":[{"id":"66336aa5-07be-4342-b8d2-34adcf33a126","name":"6. Get single use template URL using template identifier","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetSingleUsageTemplateURLByTemplateID?authenticationTicket={{authenticationticket}}&templateIdentifier={{templateidentifier}}&returnURL={{returnurl}}","host":["{{serverurl}}"],"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageTemplateURLByTemplateID"],"query":[{"key":"authenticationTicket","value":"{{authenticationticket}}"},{"key":"templateIdentifier","value":"{{templateidentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"P3P","value":"CP=\"HONK\""},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamVjdHNcQUpTXFJlcG9zaXRvcnlcUHJvamVjdHNcbzJTbWFydC5Eb2N1bWVudEFzc2VtYmx5LldlYlxJbnRlZ3JhdGlvblNlcnZpY2VzXFRoaXJkUGFydHlTZXJ2aWNlLnN2Y1xHZXRTaW5nbGVVc2FnZVRlbXBsYXRlVVJMQnlUZW1wbGF0ZUlE?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 26 Nov 2019 09:57:49 GMT"},{"key":"Content-Length","value":"233"}],"cookie":[],"responseTime":null,"body":"This request is used to retrieve the token of the web interview. It is similar to Method 5 above. See Integration Information above for additional control over your integration.
The template is identified by the templateIdentifier.
The 'Run As User' is identified by optional parameter runAsUserIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe template token returned can only be used for a single assembly. This is ideal for your dynamic web application or ecommerce site where assembled documents are sold, for example.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageByTemplateIndentifier"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"templateIdentifier","value":"{{templateIdentifier}}"},{"key":"returnURL","value":"{{returnurl}}"},{"key":"runAsUserIdentifier","value":"{{runAsUserIdentifier}}"}],"variable":[]}},"response":[{"id":"0dcff002-3a9d-47c3-bd9d-5012f17c1d88","name":"6.1. Get single use template token using template identifier","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetSingleUsageByTemplateIndentifier?authenticationTicket={{authenticationticket}}&templateIdentifier={{templateidentifier}}&returnURL={{returnurl}}","host":["{{serverurl}}"],"path":["IntegrationServices","ThirdPartyService.svc","GetSingleUsageByTemplateIndentifier"],"query":[{"key":"authenticationTicket","value":"{{authenticationticket}}"},{"key":"templateIdentifier","value":"{{templateidentifier}}"},{"key":"returnURL","value":"{{returnurl}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Cache-Control","value":"no-cache, no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/xml; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"P3P","value":"CP=\"HONK\""},{"key":"X-UA-Compatible","value":"IE=Edge"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RDpcUHJvamVjdHNcQUpTXFJlcG9zaXRvcnlcUHJvamVjdHNcbzJTbWFydC5Eb2N1bWVudEFzc2VtYmx5LldlYlxJbnRlZ3JhdGlvblNlcnZpY2VzXFRoaXJkUGFydHlTZXJ2aWNlLnN2Y1xHZXRTaW5nbGVVc2FnZUJ5VGVtcGxhdGVJbmRlbnRpZmllcg==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 26 Nov 2019 09:58:17 GMT"},{"key":"Content-Length","value":"113"}],"cookie":[],"responseTime":null,"body":"This request is used to assemble a specific template on the server.
\nThe template is identified by the fileIdentifier.
NOTE: this identifier is dynamic and may change across sessions.
\nThe data you would like to use to fill the document must be sent in XML format.
\nA template may be coded in such a way that it returns more than one document. Therefore this request returns an array of AssembledFiles, including a download link for each document assembled.
This request is used to assemble a specific template on the server.
\nThe template is identified by the fileIdentifier.
NOTE: this identifier is dynamic and may change across sessions.
\nThe data you would like to use to fill the document must be sent in XML format.
\nA template may be coded in such a way that it returns more than one document. Therefore this request returns an array of AssembledFiles, including a download link for each document assembled.
This request is used to assemble a specific template on the server. It is similar to Method 7 above.
The template is identified by the templateIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe data you would like to use to fill the document must be sent in XML format.
\nA template may be coded in such a way that it returns more than one document. Therefore this request returns an array of AssembledFiles, including a download link for each document assembled.
This request is used to assemble a specific template on the server. It is similar to Method 7 above.
The template is identified by the templateIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe data you would like to use to fill the document must be sent in XML format.
\nA template may be coded in such a way that it returns more than one document. Therefore this request returns an array of AssembledFiles, including a download link for each document assembled.
This request is used to upload a file, usually a template, to your XpressDox Cloud or Server account.
\nThe destination folder for the uploaded file is specified using the folderIdentifier parameter.
The overwrite parameter must be set to true if existing file must be ovewritten.
The header X-File-Name must be set to the filename that the file should be saved as.
The content of the file must be passed in the body of the request as a binary stream. Please see code example below.
\nThis request returns a ServerFile element.
Here is some code which can serve as an example to upload a file to XpressDox Cloud:
\n /// <summary>\n /// Upload a file to the XpressDox cloud\n /// </summary>\n /// <param name=\"serverUrl\">The URL of the server, e.g. https://test.xpressdox.com.</param>\n /// <param name=\"authTicket\">The authentication ticket which has been obtained by a Login request.</param>\n /// <param name=\"fileContentsStream\">A System.IO.Stream which contains the contents of the file to be uploaded.</param>\n /// <param name=\"fileNameInCloud\">The file name that you would like the file to have in the Cloud after it has been uploaded.</param>\n /// <param name=\"folderIdentifier\">The identifier of the folder in the Cloud to which the file should be uploaded.</param>\n /// <returns>A ServerFile object is returned.</returns>\n public static ServerFile UploadFile(string serverUrl, string authTicket, Stream fileContentsStream,\n string fileNameInCloud, string folderIdentifier) {\n /* create the WebRequest */\n HttpWebRequest request = (HttpWebRequest)WebRequest.Create(\n $\"{serverUrl}/Integration/upload.ashx?authenticationTicket={authTicket}&folderIdentifier={folderIdentifier}\");\n request.Method = \"POST\";\n /* note that the request.ContentType and request.Accept do not need to be set */\n request.Headers[\"X-File-Name\"] = fileNameInCloud;\n using(Stream contentStream = request.GetRequestStream()) {\n fileContentsStream.Position = 0;\n fileContentsStream.CopyTo(contentStream);\n }\n /* get the response */\n HttpWebResponse response = (HttpWebResponse) request.GetResponse();\n string result = \"\";\n using(StreamReader reader = new StreamReader(response.GetResponseStream() ?? throw new InvalidOperationException())) {\n result = reader.ReadToEnd();\n }\n /* Deserialize the result */\n return XDocument.Parse(result).Root.ToString().RemoveAttributes().XmlToObject<ServerFile>();\n }\n\nThis request is used to download a file from the server.
\nThe file to be downloaded is specified by the fileIdentifier parameter.
This request returns the specified file as a download.
\nNOTE: On the right is an XML example with an Idetifier tag used to download the file that is highligted in the color Green. It is IMPORTANT to note that it is NOT A RESPONSE example from Download file by File Identifier.
This request is used to download a template file from the server.
\nThe template to be downloaded is specified by the templateIdentifier parameter.
This request returns the specified file as a download.
\nNOTE: On the right is an XML example with an Idetifier tag used to download the file that is highligted in the color Green. It is IMPORTANT to note that it is NOT A RESPONSE example from Download file by File Identifier.
This request is used to download a file from the server.
\nThe file to be downloaded is specified by the downloadIdentifier parameter.
This request returns the specified file as a download.
\nNOTE: On the right-hand side, there is an example of a xml response and highlighted in GREEN is the downloadIdentifier tag to use when downloading the file;
IMPORTANT to note that it is NOT A RESPONSE example from Download file by Download Identifier
This request is used to download a file from the server.
\nThe file to be downloaded is specified by the downloadIdentifier parameter.
This request returns the specified file as a download.
\nNOTE: On the right-hand side, there is an example of a xml response and highlighted in GREEN is the usageIdentifier tag to use when downloading the file;\nIt is IMPORTANT to note that it is NOT A RESPONSE example from Download file by Usage Identifier.
This request is used to delete a file from the server.
\nThe file to be deleted is specified by the fileidentifier parameter.
This request returns status code 200 if successful.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","DeleteFile"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"},{"key":"fileIdentifier","value":"{{fileToDelete}}"}],"variable":[]}},"response":[],"_postman_id":"2139d263-ac65-45e3-adca-d2423f589f32"},{"name":"14. Get Web Version","id":"18fbcbb5-6730-474d-b4d4-3b154847347b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetWebVersion?authenticationTicket={{authenticationTicket}}","description":"This API request is the Web version, which is the one published at the bottom of the browser explorer page.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetWebVersion"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"}],"variable":[]}},"response":[],"_postman_id":"18fbcbb5-6730-474d-b4d4-3b154847347b"},{"name":"15. Get Xpress Dox Version ","id":"0ee75862-4862-4e13-aad1-14c34439eef2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetXpressDoxVersion?authenticationTicket={{authenticationTicket}}","description":"This API request is to get the XpressDox Engine version.
\n","urlObject":{"path":["IntegrationServices","ThirdPartyService.svc","GetXpressDoxVersion"],"host":["{{serverurl}}"],"query":[{"key":"authenticationTicket","value":"{{authenticationTicket}}"}],"variable":[]}},"response":[],"_postman_id":"0ee75862-4862-4e13-aad1-14c34439eef2"},{"name":"16. Get Interview Schema","event":[{"listen":"test","script":{"id":"811220a1-f30e-491b-aa20-ca499646dafc","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonObject = xml2Json(responseBody);","var ticket = jsonObject.string._;","","postman.setEnvironmentVariable(\"authenticationticket\", ticket);"],"type":"text/javascript"}}],"id":"85acfce5-163d-410c-bab2-fbdf064e3f4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{serverurl}}/IntegrationServices/ThirdPartyService.svc/GetTemplateSchema?authenticationTicket={{authenticationTicket}}&templateIdentifier={{templateIdentifier}}","description":"This GET request is used to retrieve the interview scheme. It can be used to build a custom interview UI.
This GET request is used to retrieve the templates run for the specified {beginDate} and {endDate}.
This GET request is used to retrieve list of all users for the current account.
This GET request is used to retrieve all user groups defined for the current account.
This GET request is used to retrieve groups assigned for the specified user.
This POST request is used to assign groups to the user.
This POST request is used to assign groups to the user.
This POST request is used to assign groups to the user.
This POST request is used to create new user group.
This POST request is used to create new user.
Available options for RoleID value:
\nThis method is used for recursive search for files in a folder on the XpressDox Server.
\nNote: Set search pattern to {query} parameter.
Note: Send an empty string for {folderIdentifier} to retrieve the contents starting from the root folder.
This method returns a list of the ServerFile elements.
This method is used to get assembly result XML by usageIdentifier.
\nInput parameters: {usageIdentifier}, {authenticationTicket}
This request is used to generate template preview(s).
\nThe template is identified by the templateIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe data you would like to use to fill the document must be sent in XML format.
\nA template may be coded in such a way that it returns more than one document. Therefore this request returns an array of previews. Each element has two properties caption and content where content is Base64 string of pdf. Use the following C# code to get byte array of the preview: byte[] preview = Convert.FromBase64String(content);
This request is used to generate template preview(s).
\nThe template is identified by the templateIdentifier.
NOTE: this identifier is static. It is assigned the first time the template is uploaded to the server and remains the same even if the template is edited, renamed or moved.
\nThe data you would like to use to fill the document must be sent in XML format.
\nA template may be coded in such a way that it returns more than one document. Therefore this request returns an array of previews. Each element has two properties caption and content where content is Base64 string of pdf. Use the following C# code to get byte array of the preview: byte[] preview = Convert.FromBase64String(content);
Over and above the API (Server to Server Communication), XpressDox also offers Interview Integration. (3rd Party Server to Browser to XpressDox Server Communication)
\nThe XpressDox Server provides code snippets to make integration of interviews really easy for you. To access these snippets:
\nSign in to your XpressDox Cloud or Server account
\nClick to view any interview
\nClick the Include Interview in your Page link on the left hand side of the page
Set your preferences and click the Show Me How button
JavaScript and iFrame code snippets (including explanatory comments) you need to integrate the template interview with your page will be generated automatically for you
\nWe recommend you use the JavaScript integration so that you have more control over the interview in your page. We supply the following JavaScript methods once the interview is loaded:
\nxdInterview.mask(message); This adds the loading overlay to the interview with the custom message text.
xdInterview.unmask(); This removes the loading overlay.
xdInterview.getInterviewData(); This method returns the interview data in xml format.
xdInterview.getInterviewDataBase64(); This method returns the interview data in base64 format.
xdInterview.getCleanInterviewData(); This method returns the interview data in xml format but with specified elements removed. Command ExcludeFromDataSet is used to exclude data elements.
xdInterview.getCleanInterviewDataBase64(); This method returns the interview data in base64 format but with specified elements removed. Command ExcludeFromDataSet is used to exclude data elements.
xdInterview.navigatetoURL(navigateURL); This method redirects the page, without the \"leaving page message\", to the provided URL.
xdInterview.getButtonAssembleText(); This method returns the 'Assemble' button text. Useful for localization purposes.
xdInterview.validate(); This method validates the interview for any required fields or configured rules.
xdInterview.SetInterviewSize(size); This method sets the interview size. Available options:
\"small\", \"medium\", \"large\", \"xlarge\"
xdInterview.assemble(additionalParams, shouldOutputErrorMessage); This method triggers the assembly process. The interview will be validated before the assembly is performed.
xdInterview.moveToNextTab(); If the interview has tabs - this method will move to the next tab.
xdInterview.moveToPreviousTab(); If interview has tabs - this method will move to the previous tab.
xdInterview.previewDocument(); This method will preview the document, given the current data.
IntegrationManager.LoadData(); This method will re-load data set to hidden field xdInitialData. Data must be base64 encoded. If you have xml data - use the following JS transformation: var encodedData = btoa(unescape(encodeURIComponent(yourXmlString)))
IntegrationManager.LoadXDInterview(); This method will reload interview on the page.
We supply the following JavaScript event/hooks once the interview is loaded:
\nfunction xdox_OnCustomClick() { } XpressDox will call this method when the custom button is clicked. Used with this command: SetWebCustomButton
function xdox_OnTabShown(totalNumberOfTabs, currentTabIndex, currentTabTitle) { } XpressDox will call this method when a tab is clicked. Please note currentTabIndex is 1 based.
function xdox_OnInterviewLoaded(interviewTitle) { } XpressDox will call this method with interviewTitle once the interview is loaded and displayed on your page.
function xdox_OnAssembleClick() { } XpressDox will call this method when the 'Assemble' button is clicked. If your implementation returns false, the XpressDox code will no longer assemble the document nor redirect to another page.
function xdox_OnAssemblyComplete(AssemblyResultObject) { } This method will only run if there is no redirect URL configured. XpressDox will call this method when the Assembly Process is complete, just before the assembly result is displayed. If your implementation returns false, no further XpressDox code will execute. The AssemblyResult object will be passed to your method.
function xdox_OnControlEntered (dataElementName) { } XpressDox will call this method when the control receives focus.
function xdox_OnInterviewSetUp() { } XpressDox will call this method when interview is setting up.
function xdox_OnInterviewAssembleError(error) { } XpressDox will call this method when an error occurs during assembly process.
function xdox_OnSaveClick() { } XpressDox will call this method when the 'Save Data' button clicked.
function xdox_OnShowWizardSubForm() { } XpressDox will call this method when a sub-form shown.
function xdox_OnPreviewDocumentStarted() { } XpressDox will call this method on the click of the 'Preview' link.
function xdox_OnPreviewDocumentFinished() { } XpressDox will call this method when the document preview is complete.
An example of these methods being implemented is as follows: function xdox_OnCustomClick() {console.log(\"The user clicked the custom web button\"); }
In addition, the following commands can be used in the template for further customization:
\n