Home > API General, Letters, SMS > SWS GetSiteSMSFromAddr Method

SWS GetSiteSMSFromAddr Method


This method is used to get the current “SMS From Address” being used for the specified site.

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
Response String
Description “SUCCESS” indicates that the query was successful, or “FAILURE” if not.
ID String
Description The site’s ID number. This echoes the requested site ID.
STATUS String
Description The current SMS From Address.

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 only need to create our SiteID request object and a GetUpdateSMS response 2 object. We can define and create those objects like this:

// Create the request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SiteID_Request siteID_rqst = new SWS.SiteID_Request();
SWS.GetUpdateSMS_Response2 response = new SWS.GetUpdateSMS_Response2 ();

Now we set up the parameters for our request.

// SiteID Request- this is a required parameter
siteID_rqst.SiteID = 123456;

We can then call the method and pass across the login object and the request objects to get our resultant dataset. 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.GetSiteSMSFromAddr (user_rqst, siteID_rqst);}
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.

Categories: API General, Letters, SMS
  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: