rp_utils::getscheduledservices

This returns charge and customer details for scheduled customers on a particular set of runs and a particular date. It does not include any runsheet comments or container information

o.getscheduledservices( tcRoutes,tddate, tnResultMode, tcCursor)

Return Value

The number of services and associated charges as specified by the service diagram

Parameters

tcRoutes
The route numbers that route records must have to be included in the returned service details.
Must be a comma separated list.

tdDate
The date of the scheduled services required

tnResultMode
This specifies how you want the data returned. For example 1 = XML , 31 = oRows data set

tcCursor
The name of the internal cursor to store the results

Remarks

This function is a quick and easy method for retrieving charge information for scheduled
services as specified by the service diagram for a specific date

Example

* Set the route numbers to include
lcRoutes = "1,2,3,4"

* Set the date
ldDate = {08/02/2002}

* Load results into oRows
lnResultMode = 31

lvRetval = o.GetScheduledServices(lcRoutes,lddate,lnResultMode)

The above would;
1.	Retrieve all route records and associated charge details as specified
	by the service diagram.
2.	These records would only be for routes 1,2,3,4 for the date 08/02/2002
3.	Place the list in the collection o.oRows


The field output of this function is as shown below;

	Servlink.id as "Serv_ID",
	Route.ID as "ROUTE_ID",
	Route.Route_Num as "Route_Num",
	Route.Account as "Account",
	Route.Day as "Day",
	Route.Sequence as "Sequence",
	Route.Stop_Date as "R_Stop_Date",
	Route.Schedule as "Schedule",
	Route.Active as "Active",
	Route.System as "System",
	Route.Day_Number as "Day_Number",
	Charge.id as "Charge_ID",
	Charge.Area as "Area",
	Charge.cycle as "cycle",
	Charge.code as "code",
	Charge.Descript as "Descript",
	Charge.Units as "Units",
	Charge.Reference as "Reference",
	Charge.Frequency as "Frequency",
	Charge.Start_Date as "C_Start_Date",
	Charge.Stop_Date as "C_Stop_Date",
	Charge.Contract as "Contract",
	Charge.History as "History",
	code.Factor as "Size",
	code.Factor*Charge.Units as "Volume",
	customer.site_name as "site_name",
	customer.site_street_number as "site_street_number",
	customer.site_street_suffix as "site_street_suffix",
	customer.site_street_name as "site_street_name",
	customer.site_city as "site_city",
	customer.site_state as "site_state",
	customer.site_phoneas "site_phone",
	customer.Latitude as "Latitude",
	customer.Longitude as "Longitude"


!!!!  Warning  !!!!
This function relies on the route list ID being setup correctly on the routes table

See also:

Class rp_utils


Last Updated: 23/11/2005