VESSEL REGISTRATION QUERY SYSTEM - LARGE VESSELS API



-219075-295275VESSEL REGISTRATION QUERY SYSTEM - LARGE VESSELS APIDocumentationDecember 20, 2016Table of Contents TOC \o "1-3" \h \z \u Purpose PAGEREF _Toc470078136 \h 3Description PAGEREF _Toc470078137 \h 3Supported Formats PAGEREF _Toc470078138 \h 3Parameters PAGEREF _Toc470078139 \h 4Usage PAGEREF _Toc470078140 \h 4Large Vessels Search PAGEREF _Toc470078141 \h 4Multiple Search Values PAGEREF _Toc470078142 \h 4Multiple Search Parameters PAGEREF _Toc470078143 \h 5Large Vessels Count PAGEREF _Toc470078144 \h 5PurposeAs part of the Open Data initiative, Transport Canada has created a Web API to query the Vessel Registration Query System for data relating to the Canadian Register of Large Vessels. This document details the usage of the API and its supported functions.DescriptionThe Canadian Register of Large Vessels API is a self-documented API that is intended for developers who would like to query it and use its information. Results are returned in either JSON or XML format depending on the format URL parameter.Supported FormatsThe Canadian Register of Large Vessels API currently supports two formats: JavaScript Object Notation (JSON); and, EXtensible Markup Language (XML)In order to specify the output format, simply append the format parameter to the query string and specify either json or xml. Examples: The following request returns a list of large vessels in JSON format: The following request returns a list of large vessels in XML format:: JSON format is used by default when either the format parameter isn’t specified or is invalid.ParametersThe following parameters can be used in combination to further narrow down the list of returned results by the API.NameVariable NameUsageVessel Namevessel-nameSearch and CountOfficial Numberofficial-numberSearchStatusstatusSearchPort of Registryport-of-registrySearchOfficial IDofficial-idCountYear Builtyear-builtCountVessel Typevessel-typeCountBuilt Betweenbuilt-betweenCountNote: A complete list of available parameters can also be returned by querying the API without any parameters UsageLarge Vessels SearchTo perform a search on large vessels, simply add the parameter acronym (see Parameters for a list of acronyms) and search value to the URL: : To request a list of all large vessels that contain “Queen” as part of the vessel name, the URL would look as such: Multiple Search ValuesThe API supports multiple values for the same parameter by combining the values using the pipe ‘|’: : To request a list of all large vessels with a port of registry for Nanaimo or Vancouver, the URL would look as such: Multiple Search ParametersFinally, the API supports the combination of multiple parameters by appending them to the URL using the slash ‘/’: request a list of all registered large vessels that contain “Sea” as part of the vessel name, the URL would look as such: Vessels CountTo retrieve a count for all large vessels that match your criteria, simply append ‘/count’ to your query: Example: To request a count of all registered large vessels built between 1950 and 1955, the URL would look as such: ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download