SWS RemoveFromWaitList Method

January 18, 2018 Leave a comment

Removes an item from a site’s wait list.

Parameters

Name DataType Is Required
SITE_ID Long  Required
Description  The site’s ID number. This can be found using the GetSiteList method.
WAIT_LIST_ID Long  Required
Description  The ID number of the wait list item to be removed. This can be found using the GetWaitList method.

Returned Parameters

Name DataType
RESPONSE String
Description Will return the string “Successfully removed wait list item.” if the item has been removed from the wait list.

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

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

Now we set up the parameters for our request.

// RemoveFromWaitList Request
request.SITE_ID = 123456;
request.WAIT_LIST_ID = 123456;

Finally we can call the method and pass across the login object and the request object to remove the account from the wait 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.RemoveFromWaitList(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.

Categories: Uncategorized

SWS GetWaitList Method

January 18, 2018 Leave a comment

Retrieves the list of active accounts that are on the wait list for the given SiteID.

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
WAITLIST_ID Long
Description The item’s wait list ID.
SITE_ID Long
Description The site’s ID number.
ACCT_ID Long
Description The account’s ID number.
ACCT_NAME String
Description The name on the account. This may differ from the primary contact’s name in some instances, such as a business account or a guardianship account.
PHONE_ID Long
Description The ID number of the phone.
ADDR_ID Long
Description The ID number of the address.
CONTACT_ID Long
Description The ID number of the contact.
ACCT_EMAIL String
Description The email address entered for the item on the wait list.
UNIT_ID Long
Description The unit’s ID number.
UNIT_NUM String
Description The unit’s number as assigned by the organization. This is not the Unit_ID.
UNIT_SIZE String
Description A description  of the unit’s size and type.(Example: 12X12 Storage.)
RENT_RATE Decimal
Description The current rate the unit costs per rental cycle.
TRIGGER_TYPE String
Description The description of the TRIGGER_TYPE used when added to the wait list if any.
TRIGGER_VALUE String
Description The description of the TRIGGER_VALUE used when added to the wait list if any.
TRIGGERED String
Description Indicates if wait list item has been triggered by unit becoming available.
NOTES String
Description Notes entered when adding item to the wait list.
TOP_PRIORITY Boolean
Description Indicates if the wait list item is a priority on the wait list.
TASK_NOTIFY Boolean
Description Indicates if a task is to be generated when wait list item has been triggered.
NOTE_NOTIFY Boolean
Description Indicates if a note is to be generated when wait list item has been triggered.
PHONE_NOTIFY Boolean
Description Indicates if the contact is to be notified by phone when wait list item has been triggered.
EMAIL_NOTIFY Boolean
Description Indicates if the contact is to be notified by email when wait list item has been triggered.

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

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

Now we set up the parameters for our request.

// GetWaitList Request
request.SITE_ID = 123456;

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

Categories: Uncategorized

SWS GetSiteSMSFromAddr Method

January 18, 2018 Leave a comment

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

SWS GetOrgSMSStatus Method

January 18, 2018 Leave a comment

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:

  • Do not send SMS
  • Require permission
  • Send SMS

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