Documentation question

10 views
Skip to first unread message

LinenMaster

unread,
Apr 24, 2008, 4:58:36 PM4/24/08
to DataFusion
I have started reviewing the documentation posted, with the intent of
attempting to understand what services are available and how to call
them.

I find that Milnor's documentation has exactly what I am looking for,
when it comes to where a services is located, what is in the WSDL, how
to call it, and what to expect the result set to be.

There does not seem to be the same level of detail or information in
the other documentation.

My expectation was that if I opened up a company's documentation, in
this case Etech, there would be a listing of what services are
available. There is, however I am not seeing how to call the service.

What is the URI? \\<my site>\<service name>\<parameter><parameter>...

In the documentation I do not know if the call is *.asmx, *.php,
*.cgi, etc...

So, if I take Milnor as the best example for documentation, is there
something I am missing when it comes to looking at the other
documentation?








Larry

unread,
Jun 2, 2008, 12:44:19 PM6/2/08
to DataFusion
>The goal of Datafusion documentation is to provide the urls where a companies web service is located, the Restful methods used to call these urls, and examples of the xml messages responses you are expected to get back. A typical WSDL file is not required, but can be given if wanted. All of the documentation provided by Etech, Milnor, and Chicago contains the information you need. For example in Etechs DFetechTunnelCommunicationWebService.doc it explains that Etech provides a url \etech\dataFusion\tunnelcommunications which can be called with an HTTP GET request and returns xml. On a jobsite this currently would exist at http://railpro1/etech/datafusion/tunnelcommunications, but this could change as network configurations sometimes vary job to job. This url does not take any parameters. None of Etech web services currently take parameters, although they may in the future.
Milnor gives examples such as
GET http://mildata1/datafusion/service.asmx/DFcustomerList returns the
xml of its customers
Chicago gives examples such as
GET \vendorHomeDirectory\dataFusion\DFchicagoLineStatus\ which returns
xml of its line status

In the documentation I do not know if the call is *.asmx, *.php,
*.cgi, etc...

It is not required of Datafusion web services to have extensions
(programming language reference like .asmx or content type like .xml),
but you can have extensions if you you wish. Datafusion should not
care about how a particular vendor sets up there urls, as long has
they describe it, what REST methods can be called upon it, and what
the response looks like.

LinenMaster

unread,
Jun 2, 2008, 2:08:11 PM6/2/08
to DataFusion
Again,

Thank you for the clarification.

I now understand that in the examples given below, that some of the
services do nothing more than report data that does not require a
parameters - such as customer or product lists.

I would strongly recommend that a WSDL be provided for all
services.From a developer perspective, it would simplify what services
are available, what parameters, and what the output would be.
Generally code gets updated much quicker than documentation, so the
WSDL would always be in concert with the version of the services being
provided.

On Jun 2, 12:44 pm, Larry <Larry.Erick...@gmail.com> wrote:
> >The goal of Datafusion documentation is to provide the urls where a companies web service is located, the Restful methods used to call these urls,  and examples of the xml messages responses you are expected to get back.  A typical WSDL file is not required, but can be given if wanted.  All of the documentation provided by Etech, Milnor, and Chicago contains the information you need.  For example in Etechs DFetechTunnelCommunicationWebService.doc it explains that Etech provides a url \etech\dataFusion\tunnelcommunications which can be called with an HTTP GET request and returns xml.  On a jobsite this currently would exist athttp://railpro1/etech/datafusion/tunnelcommunications, but this could change as network configurations sometimes vary job to job.  This url does not take any parameters.  None of Etech web services currently take parameters, although they may in the future.
>
> Milnor gives examples such as
> GEThttp://mildata1/datafusion/service.asmx/DFcustomerListreturns the
> > documentation?- Hide quoted text -
>
> - Show quoted text -
Reply all
Reply to author
Forward
0 new messages