Service Web Service Methods

Kevin Lenahan — 2009-06-26T20:46:38Z

The Service web service contains methods that provide access to Service data and related information.

URL: https://gateway.clearstar.net/CSGWService/Service.asmx

Sample Code: services.aspx

GetServiceDetail

Returns detailed information for the given sServiceNo. The Xml Response may contain multiple ServiceField nodes. If the sDotConnectExample parameter is not ‘Y’, the Xml response will not contain the dotConnectExample node. If the sGWOrderFieldsExample parameter is not ‘Y’, the Xml response will not contain the GWOrderFieldsExample node.

GetServices

Returns a list of the services available to the sCustID passed in. The Xml Response may contain multiple Service nodes.

Additional information, including each methods response XML structure, is provided in the documentation and more example code is provided in the Gateway Sample application.

How do I get a list of a customer’s available services?

Kevin Lenahan — 2009-06-26T02:33:52Z

You may want to build a list of available services for the customer in order for the user to choose which services can be added to a profile.

Here is an example of how you would get a customer’s available services:

/* Get a reference to the web service */
using (GatewaySample.net.clearstar.gateway.service.Service gwService = new GatewaySample.net.clearstar.gateway.service.Service())
{

/* Get the list of available services for a customer. */
XmlNode nodeService = gwService.GetServices("myUserName", "myPassword", myBOID, "myCustID");

}

Successful XML response would be:

</ErrorStatus>

<sServiceNo> myCustID_00001</sServiceNo>

<sServiceName>1000: myCustID Criminal</sServiceName>

<sCustomServiceName> myCustID Federal Criminal</sCustomServiceName>

<bIsPackage>false</bIsPackage>

<bIsSelected>false</bIsSelected>

<bIsSuspended>false</bIsSuspended>

<sHelpNote>Federal criminal search includes every court house in the country of ABC. No Records are obtained in 48 hour turnaround, Searchs that are flagged can be up to 72 hours.</sHelpNote>

<bIsMultiLoc>false</bIsMultiLoc>

</Service>

<sServiceNo> myCustID_00002</sServiceNo>

<sServiceName>1000: myCustID Trace</sServiceName>

<sCustomServiceName> myCustID Trace</sCustomServiceName>

<bIsPackage>false</bIsPackage>

<bIsSuspended>false</bIsSuspended>

<bIsMultiLoc>false</bIsMultiLoc>

</Service>

</GetServices>

Additional information is provided in the documentation and more example code is provided in the Gateway Sample application.