1Fetch Client API

<back to all web services

ValidateWaypoints

The following routes are available for this service:
POST/quote/validatewaypointsValidate the waypoints for a client.
ValidateWaypoints Parameters:
NameParameterData TypeRequiredDescription
WaypointsbodyList<RequestQuoteWaypoint>YesArray of waypoints
TestbodyboolYesSet this to true to prevent while testing the API.
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
RequestQuoteWaypoint Parameters:
NameParameterData TypeRequiredDescription
WaypointNumberformintYesNumber of waypoint for ordering
LatitudeformdoubleYesWaypoint Latitude
LongitudeformdoubleYesWaypoint Longitude
ContactNameformstringYesName of contact person at waypoint
ContactNumberformstringYesTelephone number of contact person at waypoint
DeliveryInstructionsformstringYesInstructions for driver to follow at waypoint
AddressformstringYesWaypoint address
ValidateWaypointsResponse Parameters:
NameParameterData TypeRequiredDescription
WaypointValidationsformList<WaypointValidationInformation>NoList with validation information for each waypoint
TotalDistanceformdoubleNoThe total distance for the order
TotalDistanceValueformstringNoThe total distance for the order, formatted as a string
WaypointsformList<WaypointQuoteInformation>NoList of information for pricing etc between each waypoint
WaypointIssueformboolNoIs there an issue for the waypoints details specified?
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
WaypointValidationInformation Parameters:
NameParameterData TypeRequiredDescription
WaypointNumberformintNo
IsValidformboolNo
ErrorMessagesformList<string>No
WaypointQuoteInformation Parameters:
NameParameterData TypeRequiredDescription
DistanceformdoubleNoDistance between waypoints as a number
DistanceValueformstringNoString formatted distance
WaypointValidformboolNo
MessageformstringNo
ErrorDetailsformList<string>No
PriceformdecimalNoCaculated price between waypoints excluding vat
PriceValueformstringNoPrice excluding vat formatted as a string rand value
PriceWithVATformdecimalNoThe price between waypoints including vat
PriceValueWithVATformstringNoThe price including vat formatted as a rand value string
LinkedWaypoint Parameters:
NameParameterData TypeRequiredDescription
FromWaypointNumberformintNo
ToWaypointNumberformintNo
FromLatitudeformdoubleNo
FromLongitudeformdoubleNo
ToLatitudeformdoubleNo
ToLongitudeformdoubleNo

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: 1fetch.api.client.prod.86degrees.com 
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.)