port_cdm___location_registry v0.0.1-DRAFT

port_cdm___location_registry

PortCdmLocationRegistry - JavaScript client for port_cdm___location_registry This specification describes the location registry endpoints which is available for consumption. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1-DRAFT
• Package version: 0.1-DRAFT
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install port_cdm___location_registry --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/port_cdm___location_registry then install it via:

    npm install YOUR_USERNAME/port_cdm___location_registry --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var PortCdmLocationRegistry = require('port_cdm___location_registry');

var api = new PortCdmLocationRegistry.LocationRegistryServiceApi()

var opts = { 
  'requestType': "requestType_example", // {String} Select different modes of fetching.
  'longitude': "longitude_example", // {String} The geospatial longitude of where to search for locations.
  'latitude': "latitude_example", // {String} The geospatial latitude of where to search for locations.
  'locationType': "locationType_example", // {String} This parameter should be used when only certain types of locations is desired. | The returned location will be filtered with this in mind.
  'radius': "radius_example", // {String} The geospatial latitude of where to search for locations.
  'coordinateSystem': "coordinateSystem_example", // {String} Specifies which format input and output coordinates should use. | Either degrees, minutes and seconds (DEGREES_MINUTES_SECONDS) or decimal degrees (DECIMAL_DEGREES)
  'name': "name_example", // {String} Only one of name, shortName, alias & mrn may be used in a request.
  'shortName': "shortName_example", // {String} Only one of name, shortName, alias & mrn may be used in a request.
  'alias': "alias_example", // {String} Only one of name, shortName, alias & mrn may be used in a request.
  'mrn': "mrn_example" // {String} Only one of name, shortName, alias & mrn may be used in a request.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationGet(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost/locationregistry

Documentation for Models

• PortCdmLocationRegistry.Area
• PortCdmLocationRegistry.Coordinate
• PortCdmLocationRegistry.CoordinateSystem
• PortCdmLocationRegistry.LocationType
• PortCdmLocationRegistry.PortLocation
• PortCdmLocationRegistry.RequestType

Documentation for Authorization

All endpoints do not require authorization.