{"id":8484,"date":"2020-09-24T11:10:38","date_gmt":"2020-09-24T18:10:38","guid":{"rendered":"https:\/\/minisoft.com\/support\/?p=8484"},"modified":"2020-09-24T11:10:39","modified_gmt":"2020-09-24T18:10:39","slug":"output-endpoint-with-serviceconfiguration-api-web-service-call","status":"publish","type":"post","link":"https:\/\/c002.minisoft.com\/support\/output-endpoint-with-serviceconfiguration-api-web-service-call\/","title":{"rendered":"Output Endpoint with ServiceConfiguration (API\/Web Service Call)"},"content":{"rendered":"\n

Please refer to the following post for more details: eFORMz API Management (Developer Resources)<\/a><\/p>\n\n\n\n

There are two primary endpoints available to eFORMz customers. These are the \u2018director\u2019 and \u2018output\u2019 endpoints. For more on the ‘director’ endpoint, consult the following post: Director Endpoint with ServiceConfiguration (API\/Web Service Call)<\/a><\/p>\n\n\n\n

An \u201cendpoint\u201d is one end of a communication channel. When an API interacts with another system<\/a>, the touchpoints of this communication are considered endpoints. For APIs, an endpoint can include a URL of a server or service. The place that APIs send requests and where the resource lives is called an endpoint.<\/p>\n\n\n\n

The \u2018director\u2019 endpoint returns success or failure only. It processes data in the background. The \u2018output\u2019 endpoint processes data during the call and returns the results as part of the web service call. Both of these endpoints can take parameters either through the URL or in the data.<\/p>\n\n\n\n

While the portion of the URL with authentication is encrypted for transmission, many people have policies restricting this practice. Passing the parameters in the data, including authentication, is possible using either XML or JSON. The order or sequence of elements in either format is not relevant to the processing.<\/p>\n\n\n\n

URL<\/h3>\n\n\n\n
http:\/\/localhost:8001\/servlet\/com.minisoft.AppServer.AppServer?APP=com.minisoft.eformz.eFORMzApp&config=projects\/OutputGuideServer\/configOutputUsePostData.xml<\/pre>\n\n\n\n
XML<\/h3>\n\n\n\n
<?xml version=\"1.0\" encoding=\"utf-8\"?> \n<ServiceConfiguration ServiceType=\"output\" project=\"projects\/OutputGuideServer\/MapPackSlipData0.efz\" format=\".xml\"> \n  <InputData format=\"XML\"> \n    <Root> \n      <abc>test<\/abc> \n    <\/Root> \n  <\/InputData> \n<\/ServiceConfiguration> <\/code><\/pre>\n\n\n\n
The root node must be named\u00a0ServiceConfiguration<\/code>\u00a0and the parameters are specified as attributes of that node. The\u00a0output<\/code>\u00a0parameter directs the eFORMz web service to return the output of an eFORMz project specified by the\u00a0project<\/code>\u00a0parameter. The calling application can pass in input data for the project in a variety of ways. The\u00a0InputData<\/code>\u00a0node with the attribute\u00a0format<\/code>\u00a0specifies the format of the embedded data. The data passed to the project is the\u00a0Root<\/code>\u00a0node and all of its descendant nodes (abc<\/code>\u00a0in this example).<\/p>\n\n\n\n
References<\/h2>\n\n\n\n
For more details on the eFORMz API, consult the following posts:<\/p>\n\n\n\n
eFORMz API .NET Web Service Call<\/a>
eFORMz API URL Parameters<\/a>
Web Service POST call to \u201cWake Up\u201d a \u201cSleeping\u201d Queue: Part 1<\/a>
Web Service POST call to \u201cWake Up\u201d a \u201cSleeping\u201d Queue: Part 2<\/a>
Web Service POST call to \u201cWake Up\u201d a \u201cSleeping\u201d Queue: Part 3<\/a>
Web Service POST Call Output Advantages<\/a>
Web Service POST Call Output<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
Please refer to the following post for more details: eFORMz API Management (Developer Resources) There are two primary endpoints available to eFORMz customers. These are the \u2018director\u2019 and \u2018output\u2019 endpoints. For more on the ‘director’ endpoint, consult the following post: Director Endpoint with ServiceConfiguration (API\/Web Service Call) An \u201cendpoint\u201d is one end of a communication channel. […]<\/p>\n","protected":false},"author":75,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[454],"tags":[584,583,633,346,342],"_links":{"self":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/8484"}],"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=8484"}],"version-history":[{"count":1,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/8484\/revisions"}],"predecessor-version":[{"id":8486,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/posts\/8484\/revisions\/8486"}],"wp:attachment":[{"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/media?parent=8484"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/categories?post=8484"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c002.minisoft.com\/support\/wp-json\/wp\/v2\/tags?post=8484"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}