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

SWS PhoneSMSBlacklistStatus Method


This call may be used to GET or SET the SMS blacklist status for a PhoneID record for specified SiteID. PhoneID must be supplied in the call. Only records having RENTAL_STATUS of “CURRENT_OCCUPIED”, “DELINQUENT”, “IN_PROCESS”, “RESERVED” or “SOFT_RESERVED” will be reported or affected.

Parameters

Name DataType Is Required
SiteID Long Required
Description The site’s ID number. This can be found using the GetSiteList method.
Get_Set String Optional
Description Accepted values are “GET” or “SET”, with “GET” being the default value.
RentalID Long Required*
Description The rental item’s ID number. This is returned when using the MakeReservation method or can be searched for using the SearchBy method.
* Either the RentalID or PhoneID is required.
PhoneID Long Required*
Description The ID number of the phone. This can be found using the GetContacts method.
* Either the RentalID or PhoneID is required.
Status String Required*
Description Indicates if you are enabling SMS on an account (“SET”) or just getting the current status (“GET”).
* This value is required only for “SET”, otherwise it is ignored.

Returned Parameters

Name DataType
Response String
Description “SUCCESS” indicates that the query was successful, or “FAILURE” if not.
PHONE_ID Long
Description The ID number of the rental.
STATUS String
Description The current SMS enabled status of the Rental/Phone combination. If using “GET”, this is the current status. If using “SET”, returns the status you just added.

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 create our objects. We’ll need the standard service object, a SiteID request object, an GetUpdatePhoneID 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.GetUpdatePhoneID_Request SMSphone_rqst = new SWS.GetUpdatePhoneID_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;
// Get_Set Request
// this is an optional parameter, “GET” is the default value
SMSphone.Get_Set = “GET”
// PhoneID Request 
// this is a required parameter
SMSphone_rqst.PhoneIDs(0).PhoneID = 345678;

Finally we can 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.PhoneSMSBlacklistStatus(user_rqst, siteID_rqst, SMSphone_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: