Skip to content

Commit 1433437

Browse files
Olman62Olman62
committed
update c# SDK project XML documentation
1 parent 684a71b commit 1433437

29 files changed

+154
-39
lines changed

‎.vs/Route4MeSDK/v16/.suo

0 Bytes
Binary file not shown.

‎Route4MeSDKLibrary/DataTypes/V5/Address/Address.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,9 @@ public class Address : QueryTypes.GenericParameters
336336
[ReadOnly(true)]
337337
public double? DistanceToNextDestination { get; set; }
338338

339+
/// <summary>
340+
/// UDU distance to next destination.
341+
/// </summary>
339342
[DataMember(Name = "udu_distance_to_next_destination", EmitDefaultValue = false)]
340343
[ReadOnly(true)]
341344
public double? UduDistanceToNextDestination { get; set; }
@@ -542,11 +545,17 @@ public class Address : QueryTypes.GenericParameters
542545
[DataMember(Name = "joint", EmitDefaultValue = false)]
543546
public int? Joint { get; set; }
544547

548+
/// <summary>
549+
/// Bundle count
550+
/// </summary>
545551
[DataMember(Name = "bundle_count", EmitDefaultValue = true)]
546552
[DefaultValue(0)]
547553
[ReadOnly(true)]
548554
public int BundleCount { get; set; }
549555

556+
/// <summary>
557+
/// Bundle items
558+
/// </summary>
550559
[DataMember(Name = "bundle_items", EmitDefaultValue = true)]
551560
[ReadOnly(true)]
552561
public BundledItemResponse[] BundleItems { get; set; }

‎Route4MeSDKLibrary/DataTypes/V5/DataObject.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ public class DataObject : DataObjectBase
1212
/// <summary>
1313
/// An optimization problem state. See <see cref="OptimizationState"/>
1414
/// </summary>
15-
///
1615
[DataMember(Name = "state")]
1716
public OptimizationState State { get; set; }
1817

‎Route4MeSDKLibrary/DataTypes/V5/Routes/RouteDataTableConfigResponse.cs

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,74 @@
33

44
namespace Route4MeSDK.DataTypes.V5
55
{
6+
/// <summary>
7+
/// Route datatable configuration
8+
/// </summary>
69
public class RouteDataTableConfigResponse
710
{
11+
/// <summary>
12+
/// API Capabilities
13+
/// </summary>
814
[DataMember(Name = "api_capabilities", EmitDefaultValue = false)]
915
public ApiCapabilitiesCls ApiCapabilities { get; set; }
1016

17+
/// <summary>
18+
/// API Preferences
19+
/// </summary>
1120
[DataMember(Name = "api_preferences", EmitDefaultValue = false)]
1221
public ApiPreferencesCls ApiPreferences { get; set; }
1322
}
1423

1524
public class ApiCapabilitiesCls
1625
{
26+
/// <summary>
27+
/// Sortable Fields
28+
/// </summary>
1729
[DataMember(Name = "sortable_fields", EmitDefaultValue = false)]
1830
public string[] SortableFields { get; set; }
1931

32+
/// <summary>
33+
/// Combinations of the sortable fields
34+
/// </summary>
2035
[DataMember(Name = "sortable_fields_combinations", EmitDefaultValue = false)]
2136
public List<string[]> SortableFieldsCombinations { get; set; }
2237

38+
/// <summary>
39+
/// If true, multi-sorting enabled.
40+
/// </summary>
2341
[DataMember(Name = "multi_sorting_enabled", EmitDefaultValue = false)]
2442
public bool? MultiSortingEnabled { get; set; }
2543

44+
/// <summary>
45+
/// An array of the filterable fields.
46+
/// </summary>
2647
[DataMember(Name = "filterable_fields", EmitDefaultValue = false)]
2748
public string[] FilterableFields { get; set; }
2849

50+
/// <summary>
51+
/// If true, search enabled.
52+
/// </summary>
2953
[DataMember(Name = "search", EmitDefaultValue = false)]
3054
public bool? Search { get; set; }
3155
}
3256

3357
public class ApiPreferencesCls
3458
{
59+
/// <summary>
60+
/// Force the server side search.
61+
/// </summary>
3562
[DataMember(Name = "force_server_side_search", EmitDefaultValue = false)]
3663
public bool? ForceServerSideSearch { get; set; }
3764

65+
/// <summary>
66+
/// If true, the search result loaded partially.
67+
/// </summary>
3868
[DataMember(Name = "partial_load", EmitDefaultValue = false)]
3969
public bool? PartialLoad { get; set; }
4070

71+
/// <summary>
72+
/// If true, simple pagination enabled.
73+
/// </summary>
4174
[DataMember(Name = "simple_pagination", EmitDefaultValue = false)]
4275
public bool? SimplePagination { get; set; }
4376
}

‎Route4MeSDKLibrary/DataTypes/V5/Routes/RouteDuplicateResponse.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public class RouteDuplicateResponse
2121
public bool? Async { get; set; }
2222

2323
/// <summary>
24-
/// An array of the duplicated route IDs.-
24+
/// An array of the duplicated route IDs.
2525
/// </summary>
2626
[DataMember(Name = "route_ids", EmitDefaultValue = false)]
2727
public string[] RouteIDs { get; set; }

‎Route4MeSDKLibrary/DataTypes/V5/Routes/RouteParameters.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ public class RouteParameters
433433
public string TruckBorders { get; set; }
434434

435435
/// <summary>
436-
///Truck side street adherence.
436+
/// Truck side street adherence.
437437
/// enum: ["OFF", "MINIMAL","MODERATE","AVERAGE","STRICT","ADHERE","STRONGLYHERE"]
438438
/// </summary>
439439
[DataMember(Name = "truck_side_street_adherence", EmitDefaultValue = false)]
@@ -628,7 +628,6 @@ public SlowdownParams()
628628
/// </summary>
629629
[DataMember(Name = "travel_time", EmitDefaultValue = false)]
630630
public int? TravelTime { get; set; }
631-
632631

633632
}
634633
}

‎Route4MeSDKLibrary/DataTypes/V5/Routes/RoutesDeleteResponse.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace Route4MeSDK.DataTypes.V5
44
{
55
/// <summary>
6-
/// The response from the endpoint R4MEInfrastructureSettingsV5.RoutesDuplicate.
6+
/// The response from the endpoint R4MEInfrastructureSettingsV5.Routes Delete.
77
/// </summary>
88
[DataContract]
99
public class RoutesDeleteResponse
@@ -20,11 +20,14 @@ public class RoutesDeleteResponse
2020
[DataMember(Name = "async", EmitDefaultValue = false)]
2121
public bool? Async { get; set; }
2222

23+
/// <summary>
24+
/// Route ID
25+
/// </summary>
2326
[DataMember(Name = "route_id", EmitDefaultValue = false)]
2427
public string RouteId { get; set; }
2528

2629
/// <summary>
27-
/// An array of the duplicated route IDs.-
30+
/// An array of the duplicated route IDs.
2831
/// </summary>
2932
[DataMember(Name = "route_ids", EmitDefaultValue = false)]
3033
public string[] RouteIDs { get; set; }

‎Route4MeSDKLibrary/QueryTypes/V5/OptimizationParameters.cs

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,22 @@
33

44
namespace Route4MeSDK.QueryTypes.V5
55
{
6-
6+
/// <summary>
7+
/// Optimization request parameters.
8+
/// </summary>
79
[DataContract]
810
public sealed class OptimizationParameters : QueryTypes.GenericParameters
911
{
12+
/// <summary>
13+
/// Optimization problem ID
14+
/// </summary>
1015
[IgnoreDataMember] // Don't serialize as JSON
1116
[HttpQueryMemberAttribute(Name = "optimization_problem_id", EmitDefaultValue = false)]
1217
public string OptimizationProblemID { get; set; }
1318

19+
/// <summary>
20+
/// If true, the optimization will be reoptimized.
21+
/// </summary>
1422
[IgnoreDataMember] // Don't serialize as JSON
1523
[HttpQueryMemberAttribute(Name = "reoptimize", EmitDefaultValue = false)]
1624
public bool? ReOptimize { get; set; }
@@ -22,10 +30,16 @@ public sealed class OptimizationParameters : QueryTypes.GenericParameters
2230
[HttpQueryMemberAttribute(Name = "redirect", EmitDefaultValue = false)]
2331
public bool? Redirect { get; set; }
2432

33+
/// <summary>
34+
/// If true, the directions are shown in the optimization.
35+
/// </summary>
2536
[IgnoreDataMember] // Don't serialize as JSON
2637
[HttpQueryMemberAttribute(Name = "show_directions", EmitDefaultValue = false)]
2738
public bool? ShowDirections { get; set; }
2839

40+
/// <summary>
41+
/// Optimization callback URL
42+
/// </summary>
2943
[IgnoreDataMember] // Don't serialize as JSON
3044
[HttpQueryMemberAttribute(Name = "optimized_callback_url", EmitDefaultValue = false)]
3145
public string OptimizedCallbackURL { get; set; }
@@ -44,14 +58,23 @@ public sealed class OptimizationParameters : QueryTypes.GenericParameters
4458
[HttpQueryMemberAttribute(Name = "offset", EmitDefaultValue = false)]
4559
public uint? Offset { get; set; }
4660

61+
/// <summary>
62+
/// Route start date
63+
/// </summary>
4764
[IgnoreDataMember]
4865
[HttpQueryMemberAttribute(Name = "start_date", EmitDefaultValue = false)]
4966
public string StartDate { get; set; }
5067

68+
/// <summary>
69+
/// Route end date
70+
/// </summary>
5171
[IgnoreDataMember]
5272
[HttpQueryMemberAttribute(Name = "end_date", EmitDefaultValue = false)]
5373
public string EndDate { get; set; }
5474

75+
/// <summary>
76+
/// Optimization query string
77+
/// </summary>
5578
[IgnoreDataMember]
5679
[HttpQueryMemberAttribute(Name = "query", EmitDefaultValue = false)]
5780
public string Query { get; set; }

‎Route4MeSDKLibrary/QueryTypes/V5/RouteParametersQuery.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,16 @@ public sealed class RouteParametersQuery : GenericParameters
5353
[HttpQueryMemberAttribute(Name = "offset", EmitDefaultValue = false)]
5454
public uint? Offset { get; set; }
5555

56+
/// <summary>
57+
/// Start date
58+
/// </summary>
5659
[IgnoreDataMember]
5760
[HttpQueryMemberAttribute(Name = "start_date", EmitDefaultValue = false)]
5861
public string StartDate { get; set; }
5962

63+
/// <summary>
64+
/// End date
65+
/// </summary>
6066
[IgnoreDataMember]
6167
[HttpQueryMemberAttribute(Name = "end_date", EmitDefaultValue = false)]
6268
public string EndDate { get; set; }

‎Route4MeSDKLibrary/Route4MeManager.cs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -748,18 +748,19 @@ public bool MergeRoutes(MergeRoutesQuery mergeRoutesParameters, out string error
748748
new KeyValuePair<string, string>("remove_origin", mergeRoutesParameters.RemoveOrigin.ToString()),
749749
new KeyValuePair<string, string>("depot_lat", mergeRoutesParameters.DepotLat.ToString()),
750750
new KeyValuePair<string, string>("depot_lng", mergeRoutesParameters.DepotLng.ToString()),
751-
new KeyValuePair<string, string>("to_route_id", mergeRoutesParameters.DepotLng.ToString()),
752-
new KeyValuePair<string, string>("route_destination_id", mergeRoutesParameters.DepotLng.ToString())
751+
new KeyValuePair<string, string>("to_route_id", mergeRoutesParameters.ToRouteId.ToString()),
752+
new KeyValuePair<string, string>("route_destination_id", mergeRoutesParameters.RouteDestinationId.ToString())
753753
};
754754

755-
HttpContent httpContent = new FormUrlEncodedContent(keyValues);
756-
757-
StatusResponse response = GetJsonObjectFromAPI<StatusResponse>
758-
(roParames, R4MEInfrastructureSettings.MergeRoutes,
759-
HttpMethodType.Post, httpContent, out errorString);
755+
using (HttpContent httpContent = new FormUrlEncodedContent(keyValues))
756+
{
757+
StatusResponse response = GetJsonObjectFromAPI<StatusResponse>
758+
(roParames, R4MEInfrastructureSettings.MergeRoutes,
759+
HttpMethodType.Post, httpContent, out errorString);
760760

761-
return (response != null && response.status) ? true : false;
762-
}
761+
return (response != null && response.status) ? true : false;
762+
};
763+
}
763764

764765
/// <summary>
765766
/// Resequences/roptimizes a route. TO DO: this endpoint seems to be deprecated and should be disabled

0 commit comments

Comments
 (0)