Latest News

the latest news from our team

eFORMz API Management (Developer Resources)

Schemas

Dropship Standardized XML Schema: DropShipSchema

Endpoints: Director/Output

There are two primary endpoints available to eFORMz customers. These are the ‘director’ and ‘output’ endpoints.

An “endpoint” is one end of a communication channel. When an API interacts with another system, 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.

The ‘director’ endpoint returns success or failure only. It processes data in the background. The ‘output’ 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.

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.

URL Formats

eFORMz API: URL Formats

Parameters

eFORMz API URL Parameters

Director Sample

URL

http://localhost:8001/servlet/com.minisoft.AppServer.AppServer?APP=com.minisoft.eformz.eFORMzApp

XML

<?xml version="1.0" encoding="UTF-8"?>
<ServiceConfiguration ServiceType="director" Host="localhost" Port="9996" ConfigurationName="accessible.cfg" QueueName="Accessible" NameTemplate="data_.xml" ProcessData="true" UseParmsAsData="false">
  <InputData usepostdata="false" format="XML" encoding="none">
    <Data>
      <AdditionalInfo>
                <misc>info</misc>
      </AdditionalInfo>
    </Data>
  </InputData>
</ServiceConfiguration>

JSON

{
    "ServiceConfiguration":
          {
             "ServiceType":"director",
             "Port":9996,
             "NameTemplate":"data_.json",
             "Host":"localhost",
             "UseParmsAsData":false,
             "ConfigurationName":"accessible.cfg",
             "InputData":
             {
                    "usepostdata":false,
                    "format":"JSON",
                    "Data":
                    {
                          "AdditionalInfo":
                               {
                               “misc”:”info”
                               },
                    },
                    "encoding":"none"
             },
             "QueueName":"Accessible",
             "ProcessData":true
          }
}

Output Sample

URL

http://localhost:8001/servlet/com.minisoft.AppServer.AppServer?APP=com.minisoft.eformz.eFORMzApp&config=projects/OutputGuideServer/configOutputUsePostData.xml

XML

<?xml version="1.0" encoding="utf-8"?> 
<ServiceConfiguration ServiceType="output" project="projects/OutputGuideServer/MapPackSlipData0.efz" format=".xml"> 
  <InputData format="XML"> 
    <Root> 
      <abc>test</abc> 
    </Root> 
  </InputData> 
</ServiceConfiguration> 

The root node must be named ServiceConfiguration and the parameters are specified as attributes of that node. The output parameter directs the eFORMz web service to return the output of an eFORMz project specified by the project parameter. The calling application can pass in input data for the project in a variety of ways. The InputData node with the attribute format specifies the format of the embedded data. The data passed to the project is the Root node and all of its descendant nodes (abc in this example).

Leave a Reply

Your email address will not be published. Required fields are marked *

*

code