1Fetch Client API

ValidateWaypoints

The following routes are available for this service:
POST	/quote/validatewaypoints	Validate the waypoints for a client.

**ValidateWaypoints** Parameters:
Name	Parameter	Data Type	Required	Description
Waypoints	body	List<RequestQuoteWaypoint>	Yes	Array of waypoints
Test	body	bool	Yes	Set this to true to prevent while testing the API.

**ApiServiceRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	form	string	Yes	The API Key required for authentication

**RequestQuoteWaypoint** Parameters:
Name	Parameter	Data Type	Required	Description
WaypointNumber	form	int	Yes	Number of waypoint for ordering
Latitude	form	double	Yes	Waypoint Latitude
Longitude	form	double	Yes	Waypoint Longitude
ContactName	form	string	Yes	Name of contact person at waypoint
ContactNumber	form	string	Yes	Telephone number of contact person at waypoint
DeliveryInstructions	form	string	Yes	Instructions for driver to follow at waypoint
Address	form	string	Yes	Waypoint address

**ValidateWaypointsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
WaypointValidations	form	List<WaypointValidationInformation>	No	List with validation information for each waypoint
TotalDistance	form	double	No	The total distance for the order
TotalDistanceValue	form	string	No	The total distance for the order, formatted as a string
Waypoints	form	List<WaypointQuoteInformation>	No	List of information for pricing etc between each waypoint
WaypointIssue	form	bool	No	Is there an issue for the waypoints details specified?

**ApiServiceResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	Yes	Information about the response.
Heading	form	string	Yes	Heading or summary of the response.
WasSuccessful	form	boolean	Yes	Did the intended operation for this response complete successfully?

**WaypointValidationInformation** Parameters:
Name	Parameter	Data Type	Required
WaypointNumber	form	int	No
IsValid	form	bool	No
ErrorMessages	form	List<string>	No

**WaypointQuoteInformation** Parameters:
Name	Parameter	Data Type	Required	Description
Distance	form	double	No	Distance between waypoints as a number
DistanceValue	form	string	No	String formatted distance
WaypointValid	form	bool	No
Message	form	string	No
ErrorDetails	form	List<string>	No
Price	form	decimal	No	Caculated price between waypoints excluding vat
PriceValue	form	string	No	Price excluding vat formatted as a string rand value
PriceWithVAT	form	decimal	No	The price between waypoints including vat
PriceValueWithVAT	form	string	No	The price including vat formatted as a rand value string

**LinkedWaypoint** Parameters:
Name	Parameter	Data Type	Required
FromWaypointNumber	form	int	No
ToWaypointNumber	form	int	No
FromLatitude	form	double	No
FromLongitude	form	double	No
ToLatitude	form	double	No
ToLongitude	form	double	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /quote/validatewaypoints HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Waypoints":[{"WaypointNumber":0,"Latitude":0,"Longitude":0,"ContactName":"String","ContactNumber":"String","DeliveryInstructions":"String","Address":"String"}],"Test":false,"ApiKey":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'ValidateWaypointsResponse' using the custom 'csv' filter}One or more errors occurred. (Object reference not set to an instance of an object.)