Home > API General > SWS GetChannelList Method

SWS GetChannelList Method


Retrieves a list of available access channels for a specified organization. Channels are created by the organization’s admin in the application.

Parameters

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

Returned Parameters

Name DataType
ACTIVE Boolean
Description Indicates if the channel is active (“True”) or not (“False”).
CHANNEL Integer
Description The channel number that was designated by the organization’s admin.
CHANNEL_DESC String
Description The access channel description designated by the organization’s admin.
CREATED_BY Long
Description The Store user’s ID that created the channel.
ORG_ID Long
Description The organization’s ID number.
UPDATED_BY Long
Description The Store user’s ID that last updated the channel.

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 GetChannelList request object and a GetChannelList response object. We can define and create those like this:

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

Here’s my sample code of the Request object.

// GetChannelList Request
request.OrgId = 123456;

Finally we can call the method and pass across the login object and the request object to get our channel list. 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.GetChannelList(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.

Categories: API General
  1. No comments yet.
  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: