Home > API General, Rates/Pricing > BulkData GetBulkRates Method

BulkData GetBulkRates Method


Retrieves a list of units that have had a rate change up to 48 hours in the past.

Parameters

Name Data Type Is Required
OrgID Long Required
Description The organization’s ID number.
BeginDate DateTime Required
Description The beginning date of the date range for which to retrieve the rate changes that have occurred.
EndDate DateTime Optional
Description The end date of the date range for which to retrieve the rate changes that have occurred.

Returned Parameters

Name Data Type
RATE_ID Long
Description The ID of the unit’s rates record.
UNIT_ID Long
Description The unit’s ID number. This is maintained through rentals.
UNIT_NUMBER String
Description The unit’s number as assigned by the organization. This is not the UnitID.
SITE_ID Long
Description The site’s ID number.
SITE_NAME String
Description The site’s name as it appears in Store.
RENT_RATE Decimal
Description The current rent rate for the unit.
RENT_RATE_DATE DateTime
Description The date the rent rate was changed to it’s current amount.
STREET_RATE Decimal
Description The current street rate for the unit.
STREET_RATE_DATE DateTime
Description The date the street rate was change to it’s current amount.
PROFORMA_RATE Decimal
Description The current proforma rate for the unit.
PROFORMA_RATE_DATE DateTime
Description The date the proforma rate was changed to it’s current amount.
RACK_RATE Decimal
Description The current rack rate for the unit.
RACK_RATE_DATE DateTime
Description The date the rack rate was changed to it’s current amount.
RACK_TYPE_NUM Integer
Description The numerical value for the rack type.
RACK_TYPE_VAL String
Description The textual value for the rack type.
FUTURE_RATE Decimal
Description The rent rate to which the unit will change.
FUTURE_RATE_DATE DateTime
Description The date the future rate will take affect.
VERSION Integer
Description The unit’s version number which serves to prevent duplicate use of the unit.
CREATED_DATE DateTime
Description The date the rate record was originally created.
CREATED_BY_ID Long
Description The user’s ID that originally created the rate record.
CREATED_BY_NAME String
Description The first and last name of the user that originally created the rate record.
UPDATED_DATE DateTime
Description The date the rate record was most recently updated.
UPDATED_BY_ID Long
Description The user’s ID that most recently updated the rate record.
UPDATED_BY_NAME String
Description The first and last name of the user that last updated the rate record.
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 and response 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.BulkRates_Response response;
  response = service.GetBulkRates(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.

Categories: API General, Rates/Pricing
  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: