SWS RemoveFromWaitList Method
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.