POST api/Route/Calculate
Request Information
URI Parameters
None.
Body Parameters
CalculateRequestName | Description | Type | Additional information |
---|---|---|---|
Network | string |
None. |
|
Start | Point |
None. |
|
End | Point |
None. |
Request Formats
application/json, text/json
Sample:
{ "Network": "sample string 1", "Start": { "Latitude": 1.1, "Longitude": 2.1 }, "End": { "Latitude": 1.1, "Longitude": 2.1 } }
application/xml, text/xml
Sample:
<CalculateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceMinder.Geo.Api"> <End> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </End> <Network>sample string 1</Network> <Start> <Latitude>1.1</Latitude> <Longitude>2.1</Longitude> </Start> </CalculateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CalculateResponseName | Description | Type | Additional information |
---|---|---|---|
Metrics | RouteMetrics |
None. |
|
Result | integer |
None. |
|
Message | string |
None. |
|
DurationMs | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Metrics": { "Duration": 1, "Distance": 2.1 }, "Result": 1, "Message": "sample string 2", "DurationMs": 3 }
application/xml, text/xml
Sample:
<CalculateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceMinder.Geo.Api"> <DurationMs>3</DurationMs> <Message>sample string 2</Message> <Result>1</Result> <Metrics> <Distance>2.1</Distance> <Duration>1</Duration> </Metrics> </CalculateResponse>