 Information/Instructions |
*.xsd XML Style Definitions will be provide for each Message
A Standard Status return
URL: For all requests
https://dwayinstalls.hns.com/xml/Msg.jsp?msg=MSG_NAME&user=username&pass=password
OR https://dwayinstalls.hns.com/xml/Msg.jsp?msg=MSG_NAME with Basic Authentication (Available Sept 2019)
Messages:
Here's all the Current Message Names.
- MSG_FSO_SEARCH - Allows Distributors and Dealers to get FSO/SAN Combinations.
Input: MSG_FSO_SEARCH.xsd Example: MSG_FSO_SEARCH.xml Output: MSG_FSO_SEARCH_OUTPUT.xsd Example: MSG_FSO_SEARCH_OUTPUT.xml
Limit: 100,000 per Request !!
- MSG_FSO_INFO - Allows Distributors and Dealers to retrieve FSO related information along with Service order activities, Parameters, Attachment meta data, Inventory payment information and Oasis workflow and header.
Input: MSG_FSO_INFO.xsd Example: MSG_FSO_INFO.xml Output: MSG_FSO_INFO_OUTPUT.xsd Example: MSG_FSO_INFO_OUTPUT.xml
Limit: 1000 per Request !!
- MSG_DEAL_ASSIGN - Allows for Multiple Dealer Assignments
Input: MSG_DEAL_ASSIGN.xsd Example: MSG_DEAL_ASSIGN.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1000 per Request !!
- MSG_SCHEDULE - Allows for Multiple Schedule Dates, Tentative and Confirm (Including Changing Schedules), and Next Day Confirmation
Input: MSG_SCHEDULE.xsd Example: MSG_SCHEDULE.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1000 per Request !!
- MSG_INSTALLER_ASSIGN - Allows for Multiple Installer Assignments
Input: MSG_INSTALLER_ASSIGN.xsd Example: MSG_INSTALLER_ASSIGN.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1000 per Request !!
- MSG_FSO_ADJUST - Allows for Distributors to Request ADJUST, Total Limit $500.00(ABS), Consumer Only, Special Skill required
Input: MSG_FSO_ADJUST.xsd Example: MSG_FSO_ADJUST.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1 per Request !!
- MSG_DIST_TICKET - Allows for Distributors to assign Tickets to Service Orders.
(Apr 2019)
Input: MSG_DIST_TICKET.xsd Example: MSG_DIST_TICKET.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1 per Request !!
- MSG_SOA_SEARCH - Allows Distributors and Dealers to get Activity/SAN Combinations. (Apr 2019)
Input: MSG_SOA_SEARCH.xsd Example: MSG_SOA_SEARCH.xml Output: MSG_SOA_SEARCH_OUTPUT.xsd Example: MSG_SOA_SEARCH_OUTPUT.xml
Limit: 100,000 per Request !!
- MSG_SOA_CREATE - Allows for Multiple Service Order Activities (SOA)
Input: MSG_SOA_CREATE.xsd Example: MSG_SOA_CREATE.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1000 per Request !!
- MSG_MASTER_FSO_SEARCH - Allows to Search Master FSO based on Loc Id.
Input: MSG_MASTER_FSO_SEARCH.xsd Example: MSG_MASTER_FSO_SEARCH.xml Output: MSG_MASTER_FSO_SEARCH_OUTPUT.xsd Example: MSG_MASTER_FSO_SEARCH_OUTPUT.xml
Limit: 1000 per Request !!
- MSG_MASTER_INFO - Allows to retrieve Master FSO related information like LOC information, Site Only Records, Child FSO information.
Input: MSG_MASTER_INFO.xsd Example: MSG_MASTER_INFO.xml Output: MSG_MASTER_INFO_OUTPUT.xsd Example: MSG_MASTER_INFO_OUTPUT.xml
Limit: 1000 per Request !!
- MSG_ATTACHMENT_INFO - Allows Distributors and Dealers to download attachment for an FSO.
Input: MSG_ATTACHMENT_INFO.xsd Example: MSG_ATTACHMENT_INFO.xml Output: MSG_ATTACHMENT_INFO_OUTPUT.xsd Example: MSG_ATTACHMENT_INFO_OUTPUT.xml
Limit: 1 per Request !!
- MSG_ATTACHMENT - Allows for Single Attachment for Service Order/Site
Input: MSG_ATTACHMENT.xsd Example: MSG_ATTACHMENT.xml Output: MSG_STD_OUTPUT.xsd
Limit: 1 per Request !!
- MSG_CONNECTIVITY_TEST - Allows for Testing of Connectivity with your Username/Password. (Causes No Updates)
Input: MSG_CONNECTIVITY_TEST.xsd Example: MSG_CONNECTIVITY_TEST.xml Output: MSG_STD_OUTPUT.xsd
UserName:
Same Vantive UserName, can be used, needs to be setup for WebServices (XML Msg). Distributors can contact Hughes through normal channels.
Dealers Contact your Distributor for new Log-In request (Recommend a separate login for AutoProcessing. Ex: abc-autoprocess)
A Successful Manual Login into Installer Portal needs to occur after that, so we can store you password for WebServices (Non-Vantive).
Each change password/Successful Login after that will resynchronize the password for WebServices.
If password is ReSet, a new Successful Manual Login is required. The Temporary ReSet login will not work with WebServices.
Password:
The Same Vantive Password, setup by a Manual Login after March 15, 2009.
Headers:
I've tested with these Headers.
Content-type: text/xml; charset=UTF8
Example:
Dealer Assignment: msg=MSG_DEAL_ASSIGN Post to this URL
https://dwayinstalls.hns.com/xml/Msg.jsp?msg=MSG_DEAL_ASSIGN&user=username&pass=password
OR https://dwayinstalls.hns.com/xml/Msg.jsp?msg=MSG_NAME with Basic Authentication (Available Sept 2019)
Header: authorization=Basic dXNlcm5hbWU6cGFzc3dvcmQ= "Basic " + {Base64 username:password} (Note: Msg.jsp doesn't Prompt for Basic Authentication, must privide in Header with Request)
XML contents: Notice: You can usually send more than 1 request at a time.
<?xml version="1.0"?>
<HNS_Input xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://dwayinstalls.hns.com/xml/MSG_DEAL_ASSIGN.xsd">
<SO>
<SO_ID>123456</SO_ID>
<DEAL_ID>789</DEAL_ID>
</SO>
<SO>
<SO_ID>123457</SO_ID>
<DEAL_ID>456</DEAL_ID>
</SO>
<SO>
<SO_ID>123458</SO_ID>
<DEAL_UNASSIGN>true</DEAL_UNASSIGN>
</SO>
</HNS_Input>
Results: MSG_STD_OUTPUT.xsd Notice: key Attribute contains the <SO_ID>123456</SO_ID> value, and Message/Error information is in the tags Value.
<?xml version="1.0"?>
<HNS_Output xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://dwayinstalls.hns.com/xml/MSG_STD_OUTPUT.xsd">
<SUCCESS key="123456">Dealer (Un)Assigned New:789 Previous:</SUCCESS>
<ERROR key="123457">NO Assignment Allowed, Service Order is Locked:Locked</ERROR>
<SUCCESS key="123458">Dealer (Un)Assigned New:null Previous:789</SUCCESS>
</HNS_Output>