Archive

Posts Tagged ‘Services’

SWS eUnitStatus Method

Retrieves a rental item’s ‘Status’ types. This refers to the overlock status of the unit, not the availability status.

Parameters

Name DataType Is Required
OrgID Long Required
Description The organization’s ID number.

Returned Parameters

Name DataType
CFG_LOOKUPS CFG_LOOKUPS
Description The object that contains all the information regarding available unit statuses.

Example

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object and an eUnitStatus response object. We can define and create those like this:

// Create a response object
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.CFG_LOOKUPS[] response;

Finally we can call the method and pass in the org ID to retrieve our requested information. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
 try
{
  response = service.eUnitStatus(123456);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General Tags: ,

SWS GetSiteAttributes Method

April 20, 2011 Leave a comment

Retrieves a collection of site attribute data. This pertains to the unique site attributes.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
ATT_NAME String
Description The site attribute’s name.
CREATED_BY Long
Description The Store user’s ID that created the field.
SITE_ID Long
Description The site’s ID number.
UPDATED_BY Long
Description The Store user’s ID number that last updated the field.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project.  At this point we need to our objects.  We’ll need the standard service object, a GetSiteAttributes request object and a GetSiteAttributes response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.GetSiteAttributes_Request request = new SWS.GetSiteAttributes_Request();
SWS.GetSiteAttributes_Response response;

 

Here’s my sample code of the Request object.

// GetSiteAttribute Request
request.SiteID = 123456;

Finally we can call the method and pass across the login object and the request object to get our site attributes. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.GetSiteAttributes(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.

For a full list of methods see SWS Methods.

SWS UpdateRefundStatus Method

March 17, 2011 Leave a comment

Provides the ability to approve or deny a list of refunds which are pending approval.

Parameters

Name DataType Is Required
Note String Optional
Description The notes regarding why a refund was denied or approved.
RefundID Long Required
Description The refund request’s ID number.
RefundStatus RefundStatus Required
Description The status to which you are changing the refund request.
Available values:

  • PendingApproval
  • Approved
  • Denied
  • Processed
  • ReSet
  • CreditFail
  • SystemRefund
  • Cancelled
SiteId Long Required
Description The site’s ID number. This can be found using the GetSiteList method.

Returned Parameters

Name DataType
RefundID Long
Description The refund request’s ID number that was updated.
Success Boolean
Description Indicates if the refund request was updated successfully (“True”) or if it failed (“False”).
Message String
Description The information describing what went wrong if the update failed.

Example

As with every method we need to pass in credentials. We do this with the LookupUser request object.

We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects.  We will need the standard service object, an UpdateRefundStatus request object, and an UpdateRefundStatus response object. We can define and create those like this:

// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.UpdateRefundStatus_Request request = new SWS.UpdateRefundStatus_Request();
SWS.UpdateRefundStatus_Response response;

Here is a sample code of the request object:

// UdpateRefundStatus Request
request.PhoneId = 123456;
request.Phone = "800-555-1212";

Finally we can call the method and pass across the login object and the request object to retrieve our requested information. It’s a good idea to do this in a Try Catch block.

// Call the method that will load the response object
try
{
  response = service.UpdateRefundStatus(user_request, request);
}
catch (Exception ex)
{
  MessageBox.Show(ex.Message);
}

Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.

For a full list of methods see SWS Methods.

Categories: API General, Refunds, Services Tags: