{"id":6097,"date":"2017-12-28T20:44:03","date_gmt":"2017-12-28T20:44:03","guid":{"rendered":"https:\/\/alt2.minisoft.com\/support\/?p=6097"},"modified":"2022-06-08T15:44:26","modified_gmt":"2022-06-08T22:44:26","slug":"eformz-api-url-parameters","status":"publish","type":"post","link":"https:\/\/c002.minisoft.com\/support\/eformz-api-url-parameters\/","title":{"rendered":"eFORMz API URL Parameters"},"content":{"rendered":"

eFORMz can be called as a web service. We loosely refer to eFORMz calling itself as the eFORMz API (Application Programming Interface). For more details, view the following posts:<\/p>\n

eFORMz API (Called as a Web Service)<\/a>
\neFORMz API .NET Web Service Call<\/a><\/p>\n

Below are all the options available for a web request call URL.<\/p>\n\n\n\n\n\n
base URL<\/td>\nhttps:\/\/localhost:8000\/servlet\/com.minisoft.AppServer.AppServer<\/td>\n<\/tr>\n
Parameter to AppServer<\/td>\n?APP=com.minisoft.eformz.eFORMzApp<\/td>\n<\/tr>\n
Decide how to process<\/td>\n\n\n\n\n\n\n\n
Service Type<\/td>\n&director<\/td>\n<\/tr>\n
Service Type<\/td>\n&output<\/td>\n<\/tr>\n
<\/td>\n&config=configuration file\u00a0 name<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Parameters for DirectorService<\/td>\n\n\n\n\n\n\n\n\n\n\n\n
Service Type<\/td>\n&director<\/td>\n<\/tr>\n
which host<\/td>\n&Host=localhost
\n&Port=9996<\/td>\n<\/tr>\n
Authentication for director<\/td>\n&User=minisoft
\n&Password=password<\/td>\n<\/tr>\n
Toolkit file *
\nMust be started with -ac parameter<\/td>\n		&ConfigurationName=accessible.cfg<\/td>\n<\/tr>\n
Queue name in toolkit file<\/td>\n&QueueName=Accessible<\/td>\n<\/tr>\n
File name for POSTed data<\/td>\n&NameTemplate=data_.xml<\/td>\n<\/tr>\n
Wake a sleeping queue<\/td>\n&ProcessData=true<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Parameters for OutputService<\/td>\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Service Type<\/td>\n&output<\/td>\n<\/tr>\n
Project Name<\/td>\n&project<\/td>\n<\/tr>\n
Project Key<\/td>\n&projectkey<\/td>\n<\/tr>\n
Output Format<\/td>\n&format<\/td>\n<\/tr>\n
Pages<\/td>\n&pages<\/td>\n<\/tr>\n
Start Page<\/td>\n&startpage<\/td>\n<\/tr>\n
End Page<\/td>\n&endpage<\/td>\n<\/tr>\n
Other parameters<\/td>\n*<\/td>\n<\/tr>\n
Data File Name<\/td>\n&datafile<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Service Type can be<\/td>\n\n\n\n\n\n\n
Director<\/td>\ndirector<\/td>\n<\/tr>\n
Output<\/td>\noutput<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
Parameters<\/td>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
&project<\/td>\nString<\/td>\n<\/tr>\n
&projectkey<\/td>\nString<\/td>\n<\/tr>\n
&format<\/td>\nString<\/td>\n<\/tr>\n
&datafile<\/td>\nString<\/td>\n<\/tr>\n
&pages<\/td>\nPageRangeSelection<\/td>\n<\/tr>\n
&startpage<\/td>\nInt (1)<\/td>\n<\/tr>\n
&endpage<\/td>\nInt (999999)<\/td>\n<\/tr>\n
&Host<\/td>\n<\/td>\n<\/tr>\n
&Port<\/td>\n<\/td>\n<\/tr>\n
&User<\/td>\n<\/td>\n<\/tr>\n
&Password<\/td>\n<\/td>\n<\/tr>\n
&ConfigurationName<\/td>\n<\/td>\n<\/tr>\n
&QueueName<\/td>\n<\/td>\n<\/tr>\n
&NameTemplate<\/td>\n<\/td>\n<\/tr>\n
&ProcessData<\/td>\nBoolean<\/td>\n<\/tr>\n
&Sync<\/td>\nBoolean<\/td>\n<\/tr>\n
&Source<\/td>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/td>\n<\/tr>\n
PageRangeSelection can be<\/td>\nall( “All pages” ),
\ncurrent( “Current pages” ),
\nrangeFromStart( “Page Range (from start)” ),
\nrangeFromEnd(“Page Range (from end)” ),
\nobsolete0( “Page Range (from end )” )<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

eFORMz can be called as a web service. We loosely refer to eFORMz calling itself as the eFORMz API (Application Programming Interface). For more details, view the following posts: eFORMz API (Called as a Web Service) eFORMz API .NET Web Service Call Below are all the options available for a web request call URL. base […]<\/p>\n","protected":false},"author":75,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[583,341,25],"_links":{"self":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/6097"}],"collection":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/users\/75"}],"replies":[{"embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/comments?post=6097"}],"version-history":[{"count":7,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/6097\/revisions"}],"predecessor-version":[{"id":10364,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/6097\/revisions\/10364"}],"wp:attachment":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/media?parent=6097"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/categories?post=6097"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/tags?post=6097"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}