H-Sphere Developer Guide

H-Sphere XML API: Support Services

 

Related Docs:  

H-Sphere XML API Reference

Actions:

 

Action: searchTickets

Description: searches trouble tickets

Parameters:

AuthToken:at - authentication information
String:id - ticket id
String:title - ticket title
String:email - email
String:contains - body contains
String:assignedTo - assigned to
String:createdFrom - created from
String:createdTo - created to
String:matchCase - the "match case" flag
String:answeredFrom - answered from
String:answeredTo - answered to
String:notAnswered - the "not answered" flag
String:modifiedFrom - modified from
String:modifiedTo - modified to
String:closedFrom - closed from
String:closedTo - closed to
String:notClosed - the "not closed" flag
String:type - ticket type

Response: TicketInfo[] - array of ticket info objects

Example:

 <soapenv:Body>
  <ns1:searchTickets soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <id xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string" xsi:nil="true"/>
   <email xsi:type="xsd:string" xsi:nil="true"/>
   <contains xsi:type="xsd:string" xsi:nil="true"/>
   <assignedTo xsi:type="xsd:string" xsi:nil="true"/>
   <createdFrom xsi:type="xsd:string" xsi:nil="true"/>
   <createdTo xsi:type="xsd:string" xsi:nil="true"/>
   <matchCase xsi:type="xsd:string" xsi:nil="true"/>
   <answeredFrom xsi:type="xsd:string" xsi:nil="true"/>
   <answeredTo xsi:type="xsd:string" xsi:nil="true"/>
   <notAnswered xsi:type="xsd:string" xsi:nil="true"/>
   <modifiedFrom xsi:type="xsd:string" xsi:nil="true"/>
   <modifiedTo xsi:type="xsd:string" xsi:nil="true"/>
   <closedFrom xsi:type="xsd:string" xsi:nil="true"/>
   <closedTo xsi:type="xsd:string" xsi:nil="true"/>
   <notClosed xsi:type="xsd:string" xsi:nil="true"/>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </ns1:searchTickets>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchTicketsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchTicketsReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:TicketInfo[6]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
    <item href="#id1"/>
    <item href="#id2"/>
    <item href="#id3"/>
    <item href="#id4"/>
    <item href="#id5"/>
   </searchTicketsReturn>
  </ns1:searchTicketsResponse>
  <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:TicketInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:SupportServices">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string">2003-06-17 17:44:47.0</closed>
   <created xsi:type="xsd:string">2003-06-17 16:37:55.0</created>
   <id xsi:type="xsd:string">1458</id>
   <modified xsi:type="xsd:string">2003-06-17 17:44:16.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">No title</title>
   <type xsi:type="xsd:string">1</type>
  </multiRef>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:TicketInfo" xmlns:ns5="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string">2003-06-17 17:44:47.0</closed>
   <created xsi:type="xsd:string">2003-06-13 20:05:23.0</created>
   <id xsi:type="xsd:string">1457</id>
   <modified xsi:type="xsd:string">2003-06-17 17:44:16.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">Msg 207, Lvl 16, State 3, Invalid column name 'ser_num'., Server SERG, Procedure , Line 1</title>
   <type xsi:type="xsd:string">1</type>
  </multiRef>
  <multiRef id="id4" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:TicketInfo" xmlns:ns6="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string">2003-06-17 20:45:42.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:44:14.0</created>
   <id xsi:type="xsd:string">1461</id>
   <modified xsi:type="xsd:string">2003-06-17 20:45:23.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">on hold</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
  <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:TicketInfo" xmlns:ns7="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:02:20.0</created>
   <id xsi:type="xsd:string">1459</id>
   <modified xsi:type="xsd:string">2003-06-17 20:03:00.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">uhuoiio</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
  <multiRef id="id3" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns8:TicketInfo" xmlns:ns8="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string">2003-06-17 20:04:45.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:04:16.0</created>
   <id xsi:type="xsd:string">1460</id>
   <modified xsi:type="xsd:string">2003-06-17 20:04:34.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">frfr</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
  <multiRef id="id5" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns9:TicketInfo" xmlns:ns9="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string" xsi:nil="true"/>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:46:23.0</created>
   <id xsi:type="xsd:string">1462</id>
   <modified xsi:type="xsd:string">2003-06-17 20:46:23.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">zvuchaynuy</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
 </soapenv:Body>

 

Action: searchInResellers

Description: searches ticket in resellers

Parameters:

AuthToken:at - authentication information
String:id - ticket id
String:title - ticket title
String:email - email
String:contains - body contains
String:assignedTo - assigned to
String:createdFrom - created from
String:createdTo - created to
String:matchCase - the "match case" flag
String:answeredFrom - answered from
String:answeredTo - answered to
String:notAnswered - the "not answered" flag
String:modifiedFrom - modified from
String:modifiedTo - modified to
String:closedFrom - closed from
String:closedTo - closed to
String:notClosed - the "not closed" flag
String:type - ticket type
String:reseller - reseller

Response: TicketInfo[] - array of ticket info objects

Example:

 <soapenv:Body>
  <ns1:searchInResellers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <id xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string" xsi:nil="true"/>
   <email xsi:type="xsd:string" xsi:nil="true"/>
   <contains xsi:type="xsd:string" xsi:nil="true"/>
   <assignedTo xsi:type="xsd:string" xsi:nil="true"/>
   <createdFrom xsi:type="xsd:string" xsi:nil="true"/>
   <createdTo xsi:type="xsd:string" xsi:nil="true"/>
   <matchCase xsi:type="xsd:string" xsi:nil="true"/>
   <answeredFrom xsi:type="xsd:string" xsi:nil="true"/>
   <answeredTo xsi:type="xsd:string" xsi:nil="true"/>
   <notAnswered xsi:type="xsd:string" xsi:nil="true"/>
   <modifiedFrom xsi:type="xsd:string" xsi:nil="true"/>
   <modifiedTo xsi:type="xsd:string" xsi:nil="true"/>
   <closedFrom xsi:type="xsd:string" xsi:nil="true"/>
   <closedTo xsi:type="xsd:string" xsi:nil="true"/>
   <notClosed xsi:type="xsd:string" xsi:nil="true"/>
   <type xsi:type="xsd:string" xsi:nil="true"/>
   <reseller xsi:type="xsd:string" xsi:nil="true"/>
  </ns1:searchInResellers>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchInResellersResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchInResellersReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:TicketInfo[6]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
    <item href="#id1"/>
    <item href="#id2"/>
    <item href="#id3"/>
    <item href="#id4"/>
    <item href="#id5"/>
   </searchInResellersReturn>
  </ns1:searchInResellersResponse>
  <multiRef id="id4" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:TicketInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:SupportServices">
   <answered xsi:type="xsd:string">2003-06-17 20:45:42.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:44:14.0</created>
   <id xsi:type="xsd:string">1461</id>
   <modified xsi:type="xsd:string">2003-06-17 20:45:23.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">on hold</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
  <multiRef id="id5" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:TicketInfo" xmlns:ns5="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string" xsi:nil="true"/>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:46:23.0</created>
   <id xsi:type="xsd:string">1462</id>
   <modified xsi:type="xsd:string">2003-06-17 20:46:23.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">zvuchaynuy</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:TicketInfo" xmlns:ns6="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string">2003-06-17 17:44:47.0</closed>
   <created xsi:type="xsd:string">2003-06-13 20:05:23.0</created>
   <id xsi:type="xsd:string">1457</id>
   <modified xsi:type="xsd:string">2003-06-17 17:44:16.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">Msg 207, Lvl 16, State 3, Invalid column name 'ser_num'., Server SERG, Procedure , Line 1</title>
   <type xsi:type="xsd:string">1</type>
  </multiRef>
  <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:TicketInfo" xmlns:ns7="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string">2003-06-17 17:44:47.0</closed>
   <created xsi:type="xsd:string">2003-06-17 16:37:55.0</created>
   <id xsi:type="xsd:string">1458</id>
   <modified xsi:type="xsd:string">2003-06-17 17:44:16.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">No title</title>
   <type xsi:type="xsd:string">1</type>
  </multiRef>
  <multiRef id="id3" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns8:TicketInfo" xmlns:ns8="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string">2003-06-17 20:04:45.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:04:16.0</created>
   <id xsi:type="xsd:string">1460</id>
   <modified xsi:type="xsd:string">2003-06-17 20:04:34.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">frfr</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
  <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns9:TicketInfo" xmlns:ns9="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:02:20.0</created>
   <id xsi:type="xsd:string">1459</id>
   <modified xsi:type="xsd:string">2003-06-17 20:03:00.0</modified>
   <priority xsi:type="xsd:string" xsi:nil="true"/>
   <title xsi:type="xsd:string">uhuoiio</title>
   <type xsi:type="xsd:string">0</type>
  </multiRef>
 </soapenv:Body>

 

Action: searchOnHoldTickets

Description: searches tickets on hold

Parameters:

AuthToken:at - authentication information

Response: TicketInfo[] - array with ticket info

Example:

 <soapenv:Body>
  <ns1:searchOnHoldTickets soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
  </ns1:searchOnHoldTickets>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchOnHoldTicketsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchOnHoldTicketsReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:TicketInfo[1]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
   </searchOnHoldTicketsReturn>
  </ns1:searchOnHoldTicketsResponse>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:TicketInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:SupportServices">
   <answered xsi:type="xsd:string">2003-06-17 20:45:42.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:44:14.0</created>
   <id xsi:type="xsd:string">1461</id>
   <modified xsi:type="xsd:string">2003-06-17 20:45:23.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">on hold</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

 

Action: searchAnsweredTickets

Description: searches answered tickets

Parameters:

AuthToken:at - authentication information

Response: TicketInfo[] - array with ticket info

Example:

 <soapenv:Body>
  <ns1:searchAnsweredTickets soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
  </ns1:searchAnsweredTickets>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchAnsweredTicketsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchAnsweredTicketsReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:TicketInfo[1]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
   </searchAnsweredTicketsReturn>
  </ns1:searchAnsweredTicketsResponse>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:TicketInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:SupportServices">
   <answered xsi:type="xsd:string">2003-06-17 20:04:45.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:04:16.0</created>
   <id xsi:type="xsd:string">1460</id>
   <modified xsi:type="xsd:string">2003-06-17 20:04:34.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">frfr</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

 

Action: searchNewTickets

Description: searches new tickets

Parameters:

AuthToken:at - authentication information

Response: TicketInfo[] - array with ticket info

Example:

 <soapenv:Body>
  <ns1:searchNewTickets soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
  </ns1:searchNewTickets>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchNewTicketsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchNewTicketsReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:TicketInfo[1]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
   </searchNewTicketsReturn>
  </ns1:searchNewTicketsResponse>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:TicketInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:SupportServices">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string" xsi:nil="true"/>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:46:23.0</created>
   <id xsi:type="xsd:string">1462</id>
   <modified xsi:type="xsd:string">2003-06-17 20:46:23.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">zvuchaynuy</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

 

Action: searchOpenedTickets

Description: searches opened tickets

Parameters:

AuthToken:at - authentication information

Response: TicketInfo[] - array with ticket info

Example:

 <soapenv:Body>
  <ns1:searchOpenedTickets soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
  </ns1:searchOpenedTickets>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchOpenedTicketsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchOpenedTicketsReturn xsi:type="ns2:Array" xsi:nil="true" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding"/>
  </ns1:searchOpenedTicketsResponse>
 </soapenv:Body>

 

Action: searchTroubleTickets

Description: searches trouble tickets

Parameters:

AuthToken:at - authentication information

Response: TicketInfo[] - array with ticket info

Example:

 <soapenv:Body>
  <ns1:searchTroubleTickets soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
  </ns1:searchTroubleTickets>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:searchTroubleTicketsResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <searchTroubleTicketsReturn xsi:type="soapenc:Array" soapenc:arrayType="ns3:TicketInfo[4]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:ns3="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item href="#id0"/>
    <item href="#id1"/>
    <item href="#id2"/>
    <item href="#id3"/>
   </searchTroubleTicketsReturn>
  </ns1:searchTroubleTicketsResponse>
  <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:TicketInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns4="urn:SupportServices">
   <answered xsi:type="xsd:string">2003-06-17 20:04:45.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:04:16.0</created>
   <id xsi:type="xsd:string">1460</id>
   <modified xsi:type="xsd:string">2003-06-17 20:04:34.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">frfr</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
  <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:TicketInfo" xmlns:ns5="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string">2003-06-17 20:45:42.0</answered>
   <assigned xsi:type="xsd:string">testadmin</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:44:14.0</created>
   <id xsi:type="xsd:string">1461</id>
   <modified xsi:type="xsd:string">2003-06-17 20:45:23.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">on hold</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
  <multiRef id="id3" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:TicketInfo" xmlns:ns6="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string" xsi:nil="true"/>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:46:23.0</created>
   <id xsi:type="xsd:string">1462</id>
   <modified xsi:type="xsd:string">2003-06-17 20:46:23.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">zvuchaynuy</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:TicketInfo" xmlns:ns7="urn:SupportServices" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <answered xsi:type="xsd:string" xsi:nil="true"/>
   <assigned xsi:type="xsd:string">sss</assigned>
   <closed xsi:type="xsd:string" xsi:nil="true"/>
   <created xsi:type="xsd:string">2003-06-17 20:02:20.0</created>
   <id xsi:type="xsd:string">1459</id>
   <modified xsi:type="xsd:string">2003-06-17 20:03:00.0</modified>
   <priority xsi:type="xsd:string">0</priority>
   <title xsi:type="xsd:string">uhuoiio</title>
   <type xsi:type="xsd:string" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

 

Action: setAdminInfo

Description: sets admin info

Parameters:

AuthToken:at - authentication information
String name - admin name
String description - description
String email - admin email
String signature - signature

Response: empty

Example:

 <soapenv:Body>
  <ns1:setAdminInfo soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <name xsi:type="xsd:string">testadmin</name>
   <description xsi:type="xsd:string">my test admin account</description>
   <email xsi:type="xsd:string">1@1.1</email>
   <signature xsi:type="xsd:string">nema</signature>
  </ns1:setAdminInfo>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>

Response:

 <soapenv:Body>
  <ns1:setAdminInfoResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices"/>
 </soapenv:Body>

 

Action: closeTicket

Description: closes ticket

Parameters:

AuthToken:at - authentication information
long:ticketId - ticket id

Response: empty

Example:

 <soapenv:Body>
  <ns1:closeTicket soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <ticketId xsi:type="xsd:long">1464</ticketId>
  </ns1:closeTicket>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:closeTicketResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices"/>
 </soapenv:Body>

 

Action: assignTicket

Description: assigns ticket

Parameters:

AuthToken:at - authentication information
long:ticketId - ticket id
long:ttadminId - ttadmin id

Response: empty

Example:

 <soapenv:Body>
  <ns1:assignTicket soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <ticketId xsi:type="xsd:long">1465</ticketId>
   <ttadminId xsi:type="xsd:long">1327</ttadminId>
   </ns1:assignTicket>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:assignTicketResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices"/>
 </soapenv:Body>

 

Action: uploadFile

Description: uploads a file to the server and returns file key (called before makeTicket)

Parameters:

AuthToken:at - authentication information
String:fileName - file name
byte[]:out - file as bytes array

Response: file key

Example:

 <soapenv:Body>
  <ns1:uploadFile soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <fileName xsi:type="xsd:string">autostart</fileName>
   <out xsi:type="soapenc:Array" soapenc:arrayType="xsd:byte[133]" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
    <item>35</item>
    <item>101</item>
    <item>120</item>
................
    <item>99</item>
   </out>
  </ns1:uploadFile>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:uploadFileResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <uploadFileReturn xsi:type="xsd:string">autostart|E9,JRY9A4ZNPEn6yGY5T</uploadFileReturn>
  </ns1:uploadFileResponse>
 </soapenv:Body>

 

Action: makeTicket

Description: creates new ticket with attachments (called after uploadFile)

Parameters:

AuthToken:at - authentication information
String:title - ticket title
int:priority - ticket priority
String:message - message
String:email - email
String:atts - file keys delimited with semicolon (;).

Response: empty

Example:

 <soapenv:Body>
  <ns1:makeTicket soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices">
   <at href="#id0"/>
   <title xsi:type="xsd:string">my title</title>
   <priority xsi:type="xsd:int">0</priority>
   <message xsi:type="xsd:string">my message</message>
   <email xsi:type="xsd:string">vovan@psoft.lviv.ua</email>
   <atts xsi:type="xsd:string">tmp.txt|8Vib6AWk6HGXryEjqa7N;autostart|E9,JRY9A4ZNPEn6yGY5T</atts>
  </ns1:makeTicket>
  <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:SupportServices">
   <accountId xsi:type="xsd:int">0</accountId>
   <login xsi:type="xsd:string">admin</login>
   <password xsi:type="xsd:string">admin</password>
   <role xsi:type="ns2:Role" xsi:nil="true"/>
  </multiRef>
 </soapenv:Body>
...
 <soapenv:Body>
  <ns1:makeTicketResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="SupportServices"/>
 </soapenv:Body>

 


Related Docs:  

H-Sphere XML API Reference



© Copyright 1998-2006. Positive Software Corporation.
All rights reserved.