Other Web Services

User Web Service Methods

Kevin Lenahan — 2009-06-27T02:40:56Z

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

URL: https://gateway.clearstar.net/CSGWUser/User.asmx

Sample Code: controls/AuthControl.aspx

AddCustomerAccess

Adds access to customer for user.

AuthorizeUser

This method is used to verify that the User is authorized to access the given Customer account. It returns an indicator that specifies whether sLoginName is authorized for the sCustID being passed in. The bAuthorized node will be set to true if LoginName is authorized for customer or false if LoginName is not authorized.

CreateUser

Creates a User with the given information and returns information about the newly created User. If the bUserCreated element is ‘true’, the User was successfully created.

EditUser

Edits a User with the given information. If the bUpdated element is ‘true’, the User was successfully updated.

GetUserDetail

Returns detailed information for the given sLoginName.

GetUsers

Returns a list of the users associated with the sCustID passed in. The Xml Response may contain multiple User nodes.

GetUsersByType (*)

Returns a list of the users associated with the sCustID passed in for the requested user type. The Xml Response may contain multiple User nodes.

RemoveCustomerAccess

Removes access to customer for user.

SuspendUser

Suspends the user.

UpdatePassword

This method will change the password of the given user. It returns an indicator that specifies whether the password has been updated. The bPasswordChanged node will be set to true if Password is changed for LoginName or false if Password is not changed.

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

Lookup Web Service Methods

Kevin Lenahan — 2009-06-27T02:28:58Z

The Lookup web service contains methods that provide access to data that is primarily used for field validation or to populate GUI elements (e.g., state dropdown list).

URL: https://gateway.clearstar.net/CSGWLookup/Lookup.asmx

Sample Code: lookups.aspx

GetLocationsForCity

Returns the locations that are valid for the given Country, State and City combination. There will be one County element returned for each related County and one ZipCode element for each related Zip Code.

GetLocationsForCountry

Returns the States, Counties, Cities and Zip Codes that are valid for the given Country. There will be one Location element returned for each related Location (State, County, City and Zip Code combination).

GetLocationsForCounty

Returns the locations that are valid for the given Country, State and County combination. There will be one City element returned for each related City and one ZipCode element for each related Zip Code.

GetLocationsForState

Returns the locations that are valid for the given Country and State combination. There will be one County element returned for each related County, one City element returned for each related City, and one ZipCode element for each related Zip Code.

GetLocationsForZipCode

Returns the locations that are valid for the given Country and Zip Code combination. There will be one State element returned for each related State, one County element returned for each related County, one City element returned for each related City, and one ZipCode element for each related Zip Code.

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

Order Web Service Methods

Kevin Lenahan — 2009-06-26T21:06:28Z

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

URL: https://gateway.clearstar.net/CSGWOrder/Order.asmx

GetOrderFields

Returns a list of the OrderFields with their values and the Supplier special instructions for the sProfNo and iOrderID passed in. The XML response may contain multiple OrderField nodes.

GetOrderResults

Returns the results for an Order.

GetOrderStatusDetail

Returns the status detail notes (Supplier to Business Owner and Business Owner to Customer) for an Order. The sSrcStatusDetail element contains the status detail notes from the Supplier for the Business Owner. The sBOStatusDetail element contains the status detail notes from the Business Owner for the Customer.

SearchOrders

Returns a list of Orders for BOID that match search criteria. The XML response may contain multiple Order nodes.

Additional information, including each methods response XML structure, is provided in the documentation.

Invoice Web Service Methods

Kevin Lenahan — 2009-06-26T20:53:44Z

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

URL: https://gateway.clearstar.net/CSGWInvoice/Invoice.asmx

Sample Code: invoices.aspx

GetInvoiceDetail

Returns the detailed Invoice information, including related transactions (i.e., payments or adjustments), for the iInvoiceNo passed in. There will be a Transaction element (could be 0, 1 or more) for each related Transaction.

GetInvoiceReport

Returns a byte array containing the Invoice Report for the iInvoiceNo passed in.

GetInvoices

Returns a list of Invoices for the sCustID passed in. The XML response may contain multiple Invoice 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.

Overview of the Additional Available Web Services

Kevin Lenahan — 2009-06-26T03:50:40Z

Although a few web services received a dedicated forum, the remaining web services are combined here in a single forum. The web services contained in the forum are not less valuable, but are typically received fewer calls. Below is the list of additional web services discussed within this forum. Additional information on the web services can be found in the documentation.

Invoice Web Service - The Invoice web service contains methods that provide access to Invoice data and related information

URL: https://gateway.clearstar.net/csgwinvoice/invoice.asmx

Lookup Web Service - The Lookup web service contains methods that provide access to data that is primarily used for field validation or to populate GUI elements (e.g., state dropdown list).

URL: https://gateway.clearstar.net/csgwlookup/lookup.asmx

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

URL: https://gateway.clearstar.net/csgworder/order.asmx

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

URL: https://gateway.clearstar.net/csgwuser/user.asmx

How do I retrieve all the users associated with a customer?

Kevin Lenahan — 2009-06-27T03:34:58Z

A list of users associated with a customer can be retrieved with the GetUsers method in the User web service.

Here is an example of how you could retrieve a list of users for a customer:

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

/* Get Users */
XmlNode nodeUser = gwUser.GetUsers("myUserName", "myPassword", myBOID, "myCustID”);

}

XML Response:

</ErrorStatus>

<User>

</User>

</SuspendUser>

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

Note: The sUserName passed in must be for a Customer Admin or BO Admin user.

How do I suspend a user?

Kevin Lenahan — 2009-06-27T03:20:07Z

A user can be suspended with the SuspendUser method in the User web service.

Here is an example of how you could suspend a user:

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

/* Suspend User */
XmlNode nodeUser = gwUser.SuspendUser("myUserName", "myPassword", myBOID, "myCustID”, iWebUserID);

}

Successful XML response would be:

</ErrorStatus>

<User>

</User>

</SuspendUser>

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

How can I tell if a user is authorized to access a customer?

Kevin Lenahan — 2009-06-26T02:43:08Z

Before accessing a customer’s information, you may want to check to see if a user is authorized to access the customer. All gateway methods check to ensure the supplied username has the necessary access with attempting to access data. Based on the business case a separate check before making a series of calls could be beneficial.

Here is an example of how you check a user’s authorization for a customer:

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

/* Check user authorization for a customer. */
XmlNode nodeUser = gwUser.AuthorizeUser("myUserName", "myPassword", myBOID, “LoginNameToCheck”, “LoginPassword”,"myCustID");

}

XML Response:

</ErrorStatus>

<User>

</User>

</AuthorizeUser>

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