/// <summary>
/// Example referes to the process of retrieving a team member specified by UserId.
/// </summary>
public void GetTeamMemberById()
{
// Create the manager with the api key
var route4Me = new Route4MeManagerV5(ActualApiKey);
#region Get Random member
var randomMember = GetRandomTeamMember();
if ((randomMember?.MemberId ?? 0) < 1)
{
Console.WriteLine("Cannot retrieve a random team member");
return;
}
#endregion
var memberParams = new MemberQueryParameters()
{
UserId = randomMember.MemberId.ToString()
};
// Run the query
var member = route4Me.GetTeamMemberById(memberParams,
out ResultResponse resultResponse);
PrintTeamMembers(member, resultResponse);
}
/// <summary>
/// The example refers to the process of updating a route member.
/// </summary>
public void UpdateTeamMember()
{
// Create the manager with the api key
var route4Me = new Route4MeManagerV5(ActualApiKey);
#region Create Member To Update
membersToRemove = new List <TeamResponse>();
CreateTestTeamMember();
if (membersToRemove.Count < 1)
{
Console.WriteLine("Cannot create a team member to remove");
return;
}
var member = membersToRemove[membersToRemove.Count - 1];
#endregion
var queryParams = new MemberQueryParameters()
{
UserId = member.MemberId.ToString()
};
var requestParams = new TeamRequest()
{
MemberPhone = "555-777-888",
ReadOnlyUser = true,
DrivingRate = 4
};
// Run the query
var updatedMember = route4Me.UpdateTeamMember(
queryParams,
requestParams,
out ResultResponse resultResponse);
PrintTeamMembers(updatedMember, resultResponse);
Console.WriteLine(
(updatedMember?.MemberPhone ?? null) == requestParams.MemberPhone
? "The member phone updated"
: "Cannot update the member phone"
);
Console.WriteLine(
(updatedMember?.ReadOnlyUser ?? null) == requestParams.ReadOnlyUser
? "The member parameter ReadOnlyUser updated"
: "Cannot update the member parameter ReadOnlyUser"
);
Console.WriteLine(
(updatedMember?.DrivingRate ?? null) == requestParams.DrivingRate
? "The member parameter DrivingRate updated"
: "Cannot update the member parameter DrivingRate"
);
RemoveTestTeamMembers();
}
private void RemoveTestTeamMembers()
{
if ((membersToRemove?.Count ?? 0) < 1)
{
return;
}
var route4Me = new Route4MeManagerV5(ActualApiKey);
foreach (var member in membersToRemove)
{
var memberParams = new MemberQueryParameters()
{
UserId = member.MemberId.ToString()
};
var removedMember = route4Me.RemoveTeamMember(memberParams,
out ResultResponse resultResponse);
Console.WriteLine(
(removedMember?.MemberEmail?.Contains(".deleted") ?? false)
? String.Format("A test member {0} removed succsessfully", removedMember.MemberId)
: String.Format("Cannot remove a test member {0}", removedMember.MemberId)
);
}
}
public void AddSkillsToDriver()
{
// Create the manager with the api key
var route4Me = new Route4MeManagerV5(ActualApiKey);
#region Create Member To Update
membersToRemove = new List <TeamResponse>();
CreateTestTeamMember();
if (membersToRemove.Count < 1)
{
Console.WriteLine("Cannot create a team member to remove");
return;
}
var member = membersToRemove[membersToRemove.Count - 1];
#endregion
var queryParams = new MemberQueryParameters()
{
UserId = member.MemberId.ToString()
};
string[] skills = new string[]
{
"Class A CDL", "Forklift", "Skid Steer Loader"
};
var updatedMember = route4Me.AddSkillsToDriver(queryParams,
skills,
out ResultResponse resultResponse);
PrintTeamMembers(updatedMember, resultResponse);
Console.WriteLine("");
Console.WriteLine(
(updatedMember?.CustomData?.ContainsKey("driver_skills") ?? false) == true
? "Driver skills :" + updatedMember.CustomData["driver_skills"]
: "Cannot add skills to the driver"
);
RemoveTestTeamMembers();
}
// The example refers to the process of removing a team member from a user account.
public void RemoveTeamMember()
{
// Create the manager with the api key
var route4Me = new Route4MeManagerV5(ActualApiKey);
#region Create Member To Remove
membersToRemove = new List <TeamResponse>();
CreateTestTeamMember();
if (membersToRemove.Count < 1)
{
Console.WriteLine("Cannot create a team member to remove");
return;
}
var member = membersToRemove[membersToRemove.Count - 1];
#endregion
var memberParams = new MemberQueryParameters()
{
UserId = member.MemberId.ToString()
};
// Run the query
var removedMember = route4Me.RemoveTeamMember(memberParams,
out ResultResponse resultResponse);
PrintTeamMembers(removedMember, resultResponse);
Console.WriteLine(
(removedMember?.MemberEmail?.Contains(".deleted") ?? false)
? String.Format("A member {0} removed succsessfully", removedMember.MemberId)
: String.Format("Cannot remove a member {0}", removedMember.MemberId)
);
}
/// <summary>
/// The Example refers to the process of creating an optimization
/// with advanced constraints (including driver skills).
/// </summary>
public void CreateOptimizationWithDriverSkills()
{
// Create the manager with the api key
var route4Me = new Route4MeManagerV5(ActualApiKey);
#region Create Skilled Drivers
int?ownerId = GetOwnerMemberId();
if (ownerId == null)
{
return;
}
#region 1st Driver
var newMemberParameters1 = new TeamRequest()
{
NewPassword = testPassword,
MemberFirstName = "John1",
MemberLastName = "Doe1",
MemberCompany = "Test Member Created",
MemberEmail = GetTestEmail().Replace("+", "1+"),
OwnerMemberId = (int)ownerId
};
newMemberParameters1.SetMemberType(DataTypes.V5.MemberTypes.Driver);
var route4MeV5 = new Route4MeManagerV5(ActualApiKey);
// Run the query
var member1 = route4MeV5.CreateTeamMember(newMemberParameters1,
out DataTypes.V5.ResultResponse resultResponse);
if (member1 != null && member1.GetType() == typeof(DataTypes.V5.TeamResponse))
{
membersToRemove.Add(member1);
}
var queryParams1 = new MemberQueryParameters()
{
UserId = member1.MemberId.ToString()
};
string[] skills1 = new string[]
{
"Class A CDL", "Forklift"
};
var updatedMember1 = route4MeV5.AddSkillsToDriver(queryParams1,
skills1,
out resultResponse);
#endregion
#region 2nd Driver
var newMemberParameters2 = new TeamRequest()
{
NewPassword = testPassword,
MemberFirstName = "John2",
MemberLastName = "Doe2",
MemberCompany = "Test Member Created",
MemberEmail = GetTestEmail().Replace("+", "2+"),
OwnerMemberId = (int)ownerId
};
newMemberParameters2.SetMemberType(DataTypes.V5.MemberTypes.Driver);
// Run the query
var member2 = route4MeV5.CreateTeamMember(newMemberParameters2,
out resultResponse);
if (member2 != null && member2.GetType() == typeof(DataTypes.V5.TeamResponse))
{
membersToRemove.Add(member2);
}
var queryParams2 = new MemberQueryParameters()
{
UserId = member2.MemberId.ToString()
};
string[] skills2 = new string[]
{
"Forklift", "Skid Steer Loader"
};
var updatedMember2 = route4MeV5.AddSkillsToDriver(queryParams2,
skills2,
out resultResponse);
#endregion
#endregion
// Prepare the addresses
var addresses = new Address[]
{
#region Addresses
new Address()
{
AddressString = "3634 W Market St, Fairlawn, OH 44333",
//all possible originating locations are depots, should be marked as true
//stylistically we recommend all depots should be at the top of the destinations list
IsDepot = true,
Latitude = 41.135762259364,
Longitude = -81.629313826561,
//the number of seconds at destination
Time = 300,
//together these two specify the time window of a destination
//seconds offset relative to the route start time for the open availability of a destination
TimeWindowStart = 28800,
//seconds offset relative to the route end time for the open availability of a destination
TimeWindowEnd = 29465
},
new Address()
{
AddressString = "1218 Ruth Ave, Cuyahoga Falls, OH 44221",
Latitude = 41.135762259364,
Longitude = -81.629313826561,
Time = 300,
TimeWindowStart = 29465,
TimeWindowEnd = 30529
},
new Address()
{
AddressString = "512 Florida Pl, Barberton, OH 44203",
Latitude = 41.003671512008,
Longitude = -81.598461046815,
Time = 300,
TimeWindowStart = 30529,
TimeWindowEnd = 33779,
Tags = new string[] { "Class A CDL", "Forklift" }
},
new Address()
{
AddressString = "512 Florida Pl, Barberton, OH 44203",
IsDepot = true,
Latitude = 41.003671512008,
Longitude = -81.598461046815,
Time = 100,
TimeWindowStart = 33779,
TimeWindowEnd = 33944
},
new Address()
{
AddressString = "3495 Purdue St, Cuyahoga Falls, OH 44221",
Latitude = 41.162971496582,
Longitude = -81.479049682617,
Time = 300,
TimeWindowStart = 33944,
TimeWindowEnd = 34801,
Tags = new string[] { "Forklift", "Skid Steer Loader" }
},
new Address()
{
AddressString = "1659 Hibbard Dr, Stow, OH 44224",
Latitude = 41.194505989552,
Longitude = -81.443351581693,
Time = 300,
TimeWindowStart = 34801,
TimeWindowEnd = 36366
},
new Address()
{
AddressString = "2705 N River Rd, Stow, OH 44224",
Latitude = 41.145240783691,
Longitude = -81.410247802734,
Time = 300,
TimeWindowStart = 36366,
TimeWindowEnd = 39173
},
new Address()
{
AddressString = "10159 Bissell Dr, Twinsburg, OH 44087",
Latitude = 41.340042114258,
Longitude = -81.421226501465,
Time = 300,
TimeWindowStart = 39173,
TimeWindowEnd = 41617
},
new Address()
{
AddressString = "367 Cathy Dr, Munroe Falls, OH 44262",
Latitude = 41.148578643799,
Longitude = -81.429229736328,
Time = 300,
TimeWindowStart = 41617,
TimeWindowEnd = 43660
},
new Address()
{
AddressString = "367 Cathy Dr, Munroe Falls, OH 44262",
Latitude = 41.148578643799,
Longitude = -81.429229736328,
Time = 300,
TimeWindowStart = 43660,
TimeWindowEnd = 46392
},
new Address()
{
AddressString = "512 Florida Pl, Barberton, OH 44203",
Latitude = 41.003671512008,
Longitude = -81.598461046815,
Time = 300,
TimeWindowStart = 46392,
TimeWindowEnd = 48389
},
new Address()
{
AddressString = "559 W Aurora Rd, Northfield, OH 44067",
Latitude = 41.315116882324,
Longitude = -81.558746337891,
Time = 50,
TimeWindowStart = 48389,
TimeWindowEnd = 48449
},
new Address()
{
AddressString = "3933 Klein Ave, Stow, OH 44224",
Latitude = 41.169467926025,
Longitude = -81.429420471191,
Time = 300,
TimeWindowStart = 48449,
TimeWindowEnd = 50152
},
new Address()
{
AddressString = "2148 8th St, Cuyahoga Falls, OH 44221",
Latitude = 41.136692047119,
Longitude = -81.493492126465,
Time = 300,
TimeWindowStart = 50152,
TimeWindowEnd = 51982
},
new Address()
{
AddressString = "3731 Osage St, Stow, OH 44224",
Latitude = 41.161357879639,
Longitude = -81.42293548584,
Time = 100,
TimeWindowStart = 51982,
TimeWindowEnd = 52180
},
new Address()
{
AddressString = "3731 Osage St, Stow, OH 44224",
Latitude = 41.161357879639,
Longitude = -81.42293548584,
Time = 300,
TimeWindowStart = 52180,
TimeWindowEnd = 54379
}
#endregion
};
// Set parameters
var parameters = new RouteParameters()
{
//specify capacitated vehicle routing with time windows and multiple depots, with multiple drivers
AlgorithmType = AlgorithmType.ADVANCED_CVRP_TW,
//set an arbitrary route name
//this value shows up in the website, and all the connected mobile device
RouteName = "Multiple Depot, Multiple Driver",
//the route start date in UTC, unix timestamp seconds (Tomorrow)
RouteDate = R4MeUtils.ConvertToUnixTimestamp(DateTime.UtcNow.Date.AddDays(1)),
//the time in UTC when a route is starting (7AM)
RouteTime = 60 * 60 * 7,
//the maximum duration of a route
RouteMaxDuration = 86400,
VehicleCapacity = 7,
VehicleMaxDistanceMI = 10000,
Optimize = Optimize.Distance.Description(),
DistanceUnit = DistanceUnit.MI.Description(),
DeviceType = DeviceType.Web.Description(),
TravelMode = TravelMode.Driving.Description(),
Metric = Metric.Geodesic,
AdvancedConstraints = new DataTypes.V5.RouteAdvancedConstraints[]
{
new DataTypes.V5.RouteAdvancedConstraints()
{
AvailableTimeWindows = new List <int[]>()
{
new int[] { 25200, 39600 },
new int[] { 57600, 61200 }
},
MaximumCapacity = 30,
MaximumCargoVolume = 15,
MembersCount = 10,
Tags = new string[] { "Forklift", "Skid Steer Loader" },
Route4meMembersId = new int[]
{
(int)updatedMember1.MemberId,
(int)updatedMember2.MemberId
}
}
}
};
var optimizationParameters = new OptimizationParameters()
{
Addresses = addresses,
Parameters = parameters
};
// Run the query
DataObject dataObject = route4Me.RunOptimization(
optimizationParameters,
out ResultResponse resultResponse1);
OptimizationsToRemove = new List <string>()
{
dataObject?.OptimizationProblemId ?? null
};
// Output the result
PrintExampleOptimizationResult(
dataObject,
resultResponse1.Messages.Count > 0 ? String.Join(Environment.NewLine, resultResponse1.Messages) : ""
);
RemoveTestOptimizations();
RemoveTestTeamMembers();
}
public void CreateBBCSOptimizationWithDriverSkills()
{
// Create the manager with the api key
var route4Me = new Route4MeManager(ActualApiKey);
Dictionary <string, string> r4metobbcsid = new Dictionary <string, string>();
#region Create Skilled Drivers
int?ownerId = GetOwnerMemberId();
if (ownerId == null)
{
return;
}
#region 1st Driver
// Driver 1
var newMemberParameters1 = new TeamRequest()
{
NewPassword = testPassword,
MemberFirstName = "Vaishali",
MemberLastName = "Deshpande",
MemberCompany = "Test Member 1 Created",
MemberEmail = GetTestEmail().Replace("+", "1+"),
OwnerMemberId = (int)ownerId,
};
newMemberParameters1.SetMemberType(DataTypes.V5.MemberTypes.Driver);
var route4MeV5 = new Route4MeManagerV5(ActualApiKey);
// Run the query
var member1 = route4MeV5.CreateTeamMember(newMemberParameters1,
out DataTypes.V5.ResultResponse resultResponse);
if (member1 != null && member1.GetType() == typeof(DataTypes.V5.TeamResponse))
{
membersToRemove.Add(member1);
}
var queryParams1 = new MemberQueryParameters()
{
UserId = member1.MemberId.ToString()
};
string[] skills1 = new string[]
{
"MLT3PLUMB", "MLT3AUDIT"
};
var updatedMember1 = route4MeV5.AddSkillsToDriver(queryParams1,
skills1,
out resultResponse);
#endregion
#region 2nd Driver
var newMemberParameters2 = new TeamRequest()
{
NewPassword = testPassword,
MemberFirstName = "Guru",
MemberLastName = "Deshpande",
MemberCompany = "Test Member 2 Created",
MemberEmail = GetTestEmail().Replace("+", "1+"),
OwnerMemberId = (int)ownerId,
};
newMemberParameters2.SetMemberType(DataTypes.V5.MemberTypes.Driver);
route4MeV5 = new Route4MeManagerV5(ActualApiKey);
// Run the query
var member2 = route4MeV5.CreateTeamMember(newMemberParameters2,
out resultResponse);
if (member2 != null && member2.GetType() == typeof(DataTypes.V5.TeamResponse))
{
membersToRemove.Add(member2);
}
var queryParams2 = new MemberQueryParameters()
{
UserId = member2.MemberId.ToString()
};
string[] skills2 = new string[]
{
"MLT3ELEC", "MLT3AUDIT"
};
var updatedMember2 = route4MeV5.AddSkillsToDriver(queryParams2,
skills2,
out resultResponse);
#endregion
#endregion
// Prepare the addresses
var addresses = new Address[]
{
#region Addresses
new Address()
{
AddressString = "Orion Tower 1, 19/2, Devarbisana halli, KR puram Hobli",
//all possible originating locations are depots, should be marked as true
//stylistically we recommend all depots should be at the top of the destinations list
IsDepot = true,
Latitude = 12.924868075027042,
Longitude = 77.686757839656,
},
new Address()
{
AddressString = "Janhavi Shelters,Koppa Rd,Yelenahalli, Akshayanagar",
Latitude = 12.867198760559722,
Longitude = 77.61945059918025,
Time = 60 * 60,
TimeWindowStart = (10 - 5) * 3600,
TimeWindowEnd = (12 - 5) * 3600,
Tags = new string[] { "MLT3PLUMB" },
},
new Address()
{
AddressString = "Bannerghatta Main Rd, Classic Orchards Layout, Hulimavu, Bengaluru, Karnataka 560076",
Latitude = 12.874972927579234,
Longitude = 77.59465999732771,
Time = 60 * 60,
TimeWindowStart = (12 - 5) * 3600,
TimeWindowEnd = (14 - 5) * 3600,
Tags = new string[] { "MLT3PLUMB" },
},
new Address()
{
AddressString = "DLF Newtown,Akshayanagar",
Latitude = 12.877644069349397,
Longitude = 77.61905398407804,
Time = 60 * 60,
TimeWindowStart = (14 - 5) * 3600,
TimeWindowEnd = (16 - 5) * 3600,
Tags = new string[] { "MLT3ELEC" },
},
new Address()
{
AddressString = "9th Main, 6th Sector, HSR Layout, Bengaluru, Karnataka 560034",
Latitude = 12.914053742570712,
Longitude = 77.63510075685282,
Time = 60 * 60,
TimeWindowStart = (16 - 5) * 3600,
TimeWindowEnd = (18 - 5) * 3600,
Tags = new string[] { "MLT3PLUMB" }
}
#endregion
};
// Set parameters
var parameters = new RouteParameters()
{
//specify capacitated vehicle routing with time windows and multiple depots, with multiple drivers
AlgorithmType = AlgorithmType.ADVANCED_CVRP_TW,
//set an arbitrary route name
//this value shows up in the website, and all the connected mobile device
RouteName = "Multiple Depot, Multiple Driver Fixed " + DateTime.Now,
//the route start date in UTC, unix timestamp seconds (Tomorrow)
RouteDate = R4MeUtils.ConvertToUnixTimestamp(DateTime.UtcNow.Date.AddDays(1)),
//the time in UTC when a route is starting (7AM)
RouteTime = 60 * 60 * (9 - 5),
//the maximum duration of a route
VehicleCapacity = 7,
VehicleMaxDistanceMI = 10000,
Optimize = Optimize.Distance.Description(),
DistanceUnit = DistanceUnit.MI.Description(),
DeviceType = DeviceType.Web.Description(),
TravelMode = TravelMode.Driving.Description(),
AdvancedConstraints = new DataTypes.V5.RouteAdvancedConstraints[]
{
new DataTypes.V5.RouteAdvancedConstraints()
{
AvailableTimeWindows = new List <int[]>() // drivers availability or working hours?
{
new int[] { 60 * 60 * (9 - 5), 60 * 60 * (20 - 5) }
},
MaximumCapacity = 30,
MaximumCargoVolume = 15,
Tags = new string[] { "MLT3PLUMB" },
Route4meMembersId = new int[]
{
(int)updatedMember1.MemberId
}
},
new DataTypes.V5.RouteAdvancedConstraints()
{
AvailableTimeWindows = new List <int[]>() // drivers availability or working hours?
{
new int[] { 60 * 60 * (9 - 5), 60 * 60 * (20 - 5) }
},
MaximumCapacity = 30,
MaximumCargoVolume = 15,
MembersCount = 10,
Tags = new string[] { "MLT3ELEC" },
Route4meMembersId = new int[]
{
(int)updatedMember2.MemberId
}
}
}
};
var optimizationParameters = new QueryTypes.OptimizationParameters()
{
Addresses = addresses,
Parameters = parameters
};
// Run the query
DataObject dataObject = route4Me.RunOptimization(
optimizationParameters,
out string errorString);
OptimizationsToRemove = new List <string>()
{
dataObject?.OptimizationProblemId ?? null
};
// Output the result
PrintExampleOptimizationResult(dataObject, errorString);
RemoveTestOptimizations();
RemoveTestTeamMembers();
}
