SWS GetOrgSMSStatus Method
This method is used to get the current SMS Messaging Status for the organization.
Parameters
Name | DataType | Is Required |
---|---|---|
None | ||
Description | This is based on your credentials in LookUpUser_Request, so does not require any additional parameters. |
Returned Parameters
Name | DataType |
---|---|
Response | String |
Description | “SUCCESS” indicates that the query was successful, or “FAILURE” if not. |
ID | String |
Description | The organization’s ID number. This echoes the ID of the organization for which the credentials apply. |
STATUS | String |
Description | Indicates the current SMS messaging status. Available values:
|
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 a GetUpdateSMS response 2 object.
// Create the request and response objects SWS.WSSoapClient service = new SWS.WSSoapClient(); SWS.GetUpdateSMS_Response2 response = new SWS.GetUpdateSMS_Response2 ();
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.GetOrgSMSStatus (user_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
Comments (0)
Trackbacks (0)
Leave a comment
Trackback