Api Documentation

API Documentation

Response in JSON or XML depending on the http request Content-Type

Content-Type: application/xml;

Content-Type: application/json;

Services

Routes

Format: http://imar.ca/Services/api/Route/<Origin>/<Destination>

Parameter	Type	Description/Values
<Origin>	string	[quebec \| escoumins \| trois-rivieres \| montreal \| sorel \| cap_brule \| portneuf \| batiscan]
<Destination>	string	[quebec \| escoumins \| trois-rivieres \| montreal \| sorel \| cap_brule \| portneuf \| batiscan]

You can also retrieve the available origins or destinations via the API with this url: http://imar.ca/Services/api/Locations

Example: http://imar.ca/Services/api/Route/quebec/cap_brule

<RouteLong xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Error i:nil="true"/>
	<Id>24</Id>
	<Map i:nil="true"/>
	<Name>Qc --> Cap-brulé</Name>
	<PortDestination>cap_brule</PortDestination>
	<PortSource>quebec</PortSource>
	<Success>true</Success>
	<Waypoints>
		<Waypoint>
			<Lat>46°48'35"N</Lat>
			<Lon>-071°11'47"W</Lon>
			<Name>Québec - CP-13</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°49'54"N</Lat>
			<Lon>-071°11'06"W</Lon>
			<Name>Beauport</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°50'31"N</Lat>
			<Lon>-071°09'30"W</Lon>
			<Name>Lévis</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°50'29"N</Lat>
			<Lon>-071°07'53"W</Lon>
			<Name>Ste-Petronille</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°50'25"N</Lat>
			<Lon>-071°05'13"W</Lon>
			<Name>Pointe Maranda</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°50'37"N</Lat>
			<Lon>-071°03'30"W</Lon>
			<Name>Beaumont</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°51'30"N</Lat>
			<Lon>-070°59'15"W</Lon>
			<Name>St-Laurent</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°53'23"N</Lat>
			<Lon>-070°55'13"W</Lon>
			<Name>Saint-Michel-de-Bellechasse</Name>
		</Waypoint>
		<Waypoint>
			<Lat>46°55'20"N</Lat>
			<Lon>-070°52'19"W</Lon>
			<Name>Pointe St-Jean</Name>
		</Waypoint>
		<Waypoint>
			<Lat>47°03'51"N</Lat>
			<Lon>-070°44'06"W</Lon>
			<Name>Traverse Nord</Name>
		</Waypoint>
		<Waypoint>
			<Lat>47°06'24"N</Lat>
			<Lon>-070°42'27"W</Lon>
			<Name>Cap Brulé</Name>
		</Waypoint>
	</Waypoints>
</RouteLong>

Estimated Time of Arrival (ETA)

Format: http://imar.ca/Services/api/Eta/<Origin> /<Destination> /<Speed> /<Year> /<Month> /<Day> /<Hour> /<Minute>/<ApplySpeedConstraints>

Parameter	Type	Description/Values
<Origin>	string	[quebec \| escoumins \| trois-rivieres \| montreal \| sorel \| cap_brule \| portneuf \| batiscan]
<Destination>	string	[quebec \| escoumins \| trois-rivieres \| montreal \| sorel \| cap_brule \| portneuf \| batiscan]
<Speed>	float	Range from 6 to 30 knots
<Year>	int	Year
<Month>	int	Month
<Day>	int	Day
<Hour>	int	Hour
<Minute>	int	Minute
<ApplySpeedConstraints>	bool	[true \| false] (default value is false)

Example: http://localhost:56403/api/Eta/quebec/escoumins/14/2013/6/27/14/47/false

<Eta xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Destination>escoumins</Destination>
	<DurationInMinutes>500</DurationInMinutes>
	<Error i:nil="true"/>
	<EstimatedTimeOfArrival>2013-06-27T23:09:45.44-04:00</EstimatedTimeOfArrival>
	<Origin>quebec</Origin>
	<RouteUrl>http://localhost:56403/api/Route/7</RouteUrl>
	<Speed>14</Speed>
    <SpeedConstraintsApplied>false</SpeedConstraintsApplied>
	<StartTime>2013-06-27T14:49:00-04:00</StartTime>
	<Success>true</Success>
</Eta>

Currents

Format: http://imar.ca/Services/api/Current/<Latitude>/<Longitude> /<Year>/<Month>/<Day>/<Hour>/<Minute>

Parameter	Type	Description/Values
<Latitude>	float	Latitude
<Longitude>	float	Longitude
<Year>	int	Year
<Month>	int	Month
<Day>	int	Day
<Hour>	int	Hour
<Minute>	int	Minute

Example: http://localhost:56403/api/Current/48.52/-68.83/2013/6/27/14/48

<Current xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Error i:nil="true"/>
	<Latitude>48.52</Latitude>
	<Longitude>-68.83</Longitude>
	<Success>true</Success>
	<Time>2013-06-27T14:49:00-04:00</Time>
	<U>836</U>
	<UnitOfMeasurement>mm/s</UnitOfMeasurement>
	<V>413</V>
</Current>

Speed Through Water (STW)

Format: http://imar.ca/Services/api/Stw/<Latitude>/<Longitude>/<Speed Over Ground>/<Course Over Ground>/<Year>/<Month>/<Day>/<Hour>/<Minute>

Parameter	Type	Description/Values
<Latitude>	float	Latitude
<Longitude>	float	Longitude
<Speed Over Ground>	float	Range from 6 to 30 knots
<Course Over Ground>	float	Range from 0 to 360 degrees from true north
<Year>	int	Year
<Month>	int	Month
<Day>	int	Day
<Hour>	int	Hour
<Minute>	int	Minute

Example: http://localhost:56403/api/Stw/48.52/-68.83/10/220/2013/6/27/14/48

<Stw xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Cog>220</Cog>
	<Error/>
	<Latitude>48.52</Latitude>
	<Longitude>-68.83</Longitude>
	<Sog>10</Sog>
	<SpeedThroughWater>11.686862873862134</SpeedThroughWater>
	<Success>true</Success>
	<Time>2013-06-27T14:48:00-04:00</Time>
</Stw>