EDEN Web Services Delivery Protocol

therapistarmyΛογισμικό & κατασκευή λογ/κού

14 Δεκ 2013 (πριν από 3 χρόνια και 7 μήνες)

178 εμφανίσεις




EDEN Web Services Delivery Protocol


UPC Confidential Page 1 Last modified on: 7/29/2013
Modified By: Isaac Weathers
Preface:
EDEN offers two delivery methods, Email and Web Service (i.e. XML).
This document will describe the web service method and protocol for Utility Members
to build and host a web service to receive GA811 locate request notifications (i.e.
Tickets).
Definitions:
 Web Service (WS) - A web service is an application programming interfaces (API) or web
APIs that are accessed via Hypertext Transfer Protocol (HTTP or HTTPS) and executed on a
remote system hosting the requested services.
 WSDL - A WSDL is a machine-readable description of the operations offered by the web
service written in the Web Services Description Language (WSDL).
 XML - EDEN Web Services use Extensible Markup Language (XML) messages that follow
the Simple Object Access Protocol (SOAP) standard.
Delivery Flow:
When EDEN generates a locate request for a Member configured to receive via a
WS, it generates the appropriate XML message and then makes an HTTP (or HTTPS) request to the
Member's WS, which has been exposed to GA811. The Member WS receives the XML document with
the locate request information, processes it, and then returns a success or failed response, depending on
whether the Member successfully received the XML document or not. Once GA811 receives a
successful response it will no longer attempt to deliver the locate request.

WS Methods:
The WS hosted by the Member must expose the following three methods to GA811
for delivery. Each method has a single input parameter - an XML document that contains information
about the message (i.e. the elements of the locate request being sent). The receiving WS must then
determine which fields in the XML document that it wishes to use.

Note: All XML documents are sent as standard HTTP posts and not via the SOAP protocol.


 SendTicket - This method has one parameter, xmlTicket, in the XML document that adheres to
the schema defined in TicketDataSet.xsd. The method should return the string “successful” if
the ticket was successfully received, or an error message if it was not.

The contents of the XML document in xmlTicket will vary as GA811 makes changes to include
more fields as needed. A Member must be capable of receiving any and all fields specified in
TicketDataSet.xsd, in addition to any future fields that are added - new fields may be skipped
or ignored as desired by the Member.



EDEN Web Services Delivery Protocol


UPC Confidential Page 2 Last modified on: 7/29/2013
Modified By: Isaac Weathers

 SendMessage - In order to accept broadcast messages, a Member's WS must expose the
SendMessage method. This method has one parameter, xmlMessage, in the XML document
that adheres to the schema defined in OneCallMessageDataSet.xsd. The method should return
the string “successful” if the message was received successfully, or an error message if it was
not.

 SendAudit - In order to accept End of Day audit messages, a Member's WS must expose
SendAudit method. This method has one parameter, xmlAudit, in the XML document that
adheres to the schema defined in AuditDataSet.xsd. The method should return the string
“successful” if the message was received successfully, or an error message if it was not.


WSDL:
A WSDL (Web Service Description File) must be generated and made available to GA811.
A WSDL file is an XML-based language that provides a model for describing Web Services. The URL
where the WSDL resides must be sent to Member Services when setting up the WS Destination.