Archive
BulkData GetBulkSiteAddresses Method
Retrieves a list of sites and their addresses that were created in the last 96 hours.
Parameters
Name | Data Type | Is Required |
---|---|---|
OrgID | Long | Required |
Description | The organization’s ID number. | |
BeginDate | DateTime | Required |
Description | The start date of the date range for which you wish to retrieve the addresses. | |
EndDate | DateTime | Optional |
Description | The end date of the date range for which you wish to retrieve the addresses. This will default to today if left undefined. |
Returned Parameters
Name | Data Type |
---|---|
ADDRESS_ID | Long |
Description | The address record’s ID number. |
SITE_ID | Long |
Description | The site’s ID number. |
SITE_NAME | String |
Description | The name of the site as it appears in Store. |
ADDRESS_LABEL | String |
Description | Not used. |
LINE1 | String |
Description | The first line for the site’s address. |
LINE2 | String |
Description | The second line for the site’s address. |
LINE3 | String |
Description | Not used. |
CITY | String |
Description | The city for the site’s address. |
STATE | String |
Description | The state/province for the site’s address. |
POSTAL_CODE | String |
Description | The ZIP/postal code for the site’s address. |
COUNTRY | String |
Description | The country for the site’s address. |
CREATED_DATE | DateTime |
Description | The date that the site was created. |
CREATED_BY_ID | Long |
Description | The user’s ID that created the site. |
CREATED_BY_NAME | String |
Description | The first and last name of the user that created the site. |
UPDATED_DATE | DateTime |
Description | The date that the site was last updated. |
UPDATED_BY_ID | Long |
Description | The user’s ID that last updated the site information. |
UPDATED_BY_NAME | String |
Description | The first and last name of the user that last updated the site information. |
ORG_ID | Long |
Description | The organization’s ID number. |
Example
We’ll assume you’ve got a web reference, let’s name it BulkData, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a user request object and a data request object. We can define and create those like this:
// Create request objects
BulkData.LookupUser_Request user_request = new BulkData.LookupUser_Request();
BulkData.BulkDataSoapClient service = new BulkData.BulkDataSoapClient();
BulkData.BulkData_Request request = new BulkData.BulkData_Request();
Here’s my sample code of the Request and user objects.
// request
user_request.Username = "user";
user_request.Password = "pass";
user_request.Channel = 999;
request.OrgID = 123546;
request.BeginDate = DateTime.Today.AddDays(-1);
request.BeginDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to retrieve our data. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
BulkData.BulkSiteAddresses_Response response;
response = service.GetBulkSiteAddresses(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 BulkData Methods.
SWS UpdateUnitData Method
Update the unit information for a single unit. This will allow you to update all attributes, all dimensions, all rate types, notes on the unit, the unit number and the walk thru order number of the specified unit.
Parameters
Name | DataType | Is Required |
---|---|---|
AccessType | Integer | Optional |
Description | Updates the “AccessType” attribute to this new value. See eUnitAccessType for the available values. | |
Attribute01 | Integer | Optional |
Description | Updates the “Attribute01” attribute to this new value. See eUnitAttr01 for the available values. This value cannot be null. | |
Attribute02 | Integer | Optional |
Description | Updates the “Attribute02” attribute to this new value. See eUnitAttr02 for the available values. To set this to no value use -1. | |
Climate | Integer | Optional |
Description | Updates the “Climate” attribute to this new value. See eUnitClimate for the available values. To set this to no value use -1. | |
Depth | Decimal | Optional |
Description | Updates the depth of measurement of the unit. | |
Door | Integer | Optional |
Description | Updates the “Door” attribute to this new value. See eUnitDoor for the available values. To set this to no value use -1. | |
Features | Integer | Optional |
Description | Updates the “Features”attribute to this new value. See eUnitFeatures for the available values. To set this to no value use -1. | |
FutureEffectiveDate | DateTime | Optional |
Description | Sets the date the future rent rate will take effect. | |
FutureRate | Decimal | Optional |
Description | Updates the future rent rate for the rental item. For an explanation of rates see Terms and Accronyms. | |
Height | Decimal | Optional |
Description | Updates the height measurement of the rental item. | |
Notes | String | Optional |
Description | Updates the text that will be attached to the unit. This is displayed in the “Edit Rental Items” window in the notes box in Store. | |
ProformaRate | Decimal | Optional |
Description | Updates the proforma rate for the rental item. For an explanation of rates see Terms and Accronyms. | |
PushRate | Decimal | Optional |
Description | Updates the push rate for the rental item. For an explanation of rates see Terms and Accronyms. | |
RackRate | Decimal | Optional |
Description | Updates the rack rate for the rental item. For an explanation of rates see Terms and Accronyms. | |
SquareFeet | Decimal | Optional |
Description | Updates the total square foot measurement of the unit based on it’s width and depth. | |
Status | Integer | Optional |
Description | Updates the “Status” attribute to this new value. See eUnitStatus for the available values. | |
StreetRate | Decimal | Optional |
Description | Updates the street rate for the rental item. For an explanation of rates see Terms and Accronyms. | |
UnitID | Long | Required |
Description | This is returned when you use any of the GetSiteUnitData calls. This is maintained through rentals. |
|
UnitNumber | String | Optional |
Description | Updates the site assigned unit number of the rental item. | |
WalkThruOrder | Integer | Optional |
Description | Updates the walk thru order number. This is primarily used for a walkthru of the site by the manager. | |
Width | Decimal | Optional |
Description | Updates the width measurement of the rental item. |
Returned Parameters
Name | DataType |
---|---|
Succeeded | Boolean |
Description | Indicates if the unit data was updated successfully (“True”) or not (“False”). |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects. We will need the standard service object, a UpdateUnitData request object, and a UpdateUnitData response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.UpdateUnitData_Request request = new SWS.UpdateUnitData_Request();
SWS.UpdateUnitData_Response response;
Here is my sample requesting a change of the reserved unit.
// UpdateReservation request
request.UnitID = 123456;
request.Status = 5; //unavailable-damaged
Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.UpdateUnitData(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.
For a full list of methods see SWS Methods.
siteRuleData Reference
Reference for any method using the siteRuleData object.
Name | Data Type |
---|---|
ruleID | Long |
Description | The rule’s ID number |
ruleName | String |
Description | The name of the rule. |
desc | String |
Description | The description of the rule. |
currSiteValue | String |
Description | The numeric value of the current rule setting. |
siteValueMeaning | String |
Description | The textual value of the current rule setting. |
SWS SearchBy Method
Allows you to search for a customer name, unit number, phone number, or rental ID. The search can be performed for the entire organization or for just a specific site. This will return a record for each contact and each rental on an account.
Parameters
Name | DataType | Is Required |
---|---|---|
OrgID | Long | Optional* |
Description | The organization’s ID number. *Either an OrgID or SiteID is required. |
|
SearchTerm | String | Required |
Description | The parameter to search for. | |
SearchType | SearchTypes | Required |
Description | Tells the system what fields to look at in the search. Available values:
|
|
SiteID | Long | Optional* |
Description | The site’s ID number. This can be found using the GetSiteList method. *Either an OrgID or SiteID is required. |
Returned Parameters
Name | DataType |
---|---|
ACCT_CONTACT_NAME_SEARCH | String |
Description | The field in Store used when an “Account/Contact” search is performed. |
ACCT_ID | Long |
Description | The account’s ID number. This is returned when you use the CreateNewAccount method or can be retrieved with the SearchBy method. |
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. |
AFFILIATE_ID | Long |
Description | The affiliated organization’s ID number. |
BASIC_NAME_SEARCH | String |
Description | The field in Store used when an “Account Name” search is performed. |
CONTACT_FULL_NAME | String |
Description | The full name of the contact in the format of “First Last”. |
CONTACT_ID | Long |
Description | The rental contact’s ID number. |
DISPLAY_RENTAL_STR | String |
Description | The display name of the rental as it appears in Store. |
FIRST_NAME | String |
Description | The first name of the contact. |
LAST_NAME | String |
Description | The family or last name of the contact. |
NETWORK_NAME_SEARCH | String |
Description | The organization’s search field which includes the account name, the organization name and the site name. |
OBJECT_ID | Long |
Description | The object’s ID number. This is maintained through rentals. |
ORG_ID | Long |
Description | The organization’s ID number. |
PHONE | String |
Description | The contact’s phone number. |
PHONE_CONTACT_NAME_SEARCH | String |
Description | One of the fields in Store used when a “Phone Number” search is performed. |
PHONE_SEARCH | String |
Description | One of the fields in Store used when a “Phone Number” search is performed. |
PHONE_TYPE | String |
Description | Describes the type of phone number returned for the contact. Available values:
|
PTD | DateTime |
Description | The PTD of the returned rental. |
QUICK_SEARCH | String |
Description | The field in Store used when an “Quick Search” search is performed. |
RENTAL_ID | Decimal |
Description | The rental record’s ID number. |
RENTAL_STATUS | Integer |
Description | The textual value for the rental status of the rental. Available values:
|
RSTAT_RAW | Decimal |
Description | The numeric value for the rental status of the rental. Available values:
|
SITE_ID | Long |
Description | The site’s ID number where the unit is located. |
SITE_NAME | String |
Description | The site’s name where the unit is located. |
UNIT_NUMBER | String |
Description | The unit’s number as assigned by the organization. This is not the UnitID. |
UNIT_SEARCH | String |
Description | The field in Store used when a “Unit Number” search is performed. |
UNIT_STATUS | String |
Description | The rental status of the unit. Available values:
|
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We will assume you have a web reference, let us name it SWS, in your Visual Studio project. At this point we need to define our objects. We will need the standard service object, a SearchBy request object, and a SearchBy response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.SearchBy_Request request = new SWS.SearchBy_Request();
SWS.SearchBy_Response response;
Here is a sample code of the request object for the QuickSearch option:
// SearchBy Request
request.OrgID = 123456;
request.SiteID = 123456;
request.SearchTerm = "Joe";
request.SearchType = SWS.SearchTypes.QuickSearch;
Finally we can call the method and pass across the login object and the request object to retrieve our requested information. 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.SearchBy(user_request, request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You will want to capture the message in the exception so it can be debugged.
For a full list of methods see SWS Methods.