0.0.2-beta.1 • Published 6 years ago

gis_server_ap_is v0.0.2-beta.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
6 years ago

gis_server_ap_is

GisServerApIs - JavaScript client for gis_server_ap_is No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • 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 gis_server_ap_is --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your gis_server_ap_is from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('gis_server_ap_is') in javascript files from the directory you ran the last command above from.

git

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

    npm install GIT_USER_ID/GIT_REPO_ID --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, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var GisServerApIs = require('gis_server_ap_is');

var api = new GisServerApIs.ClientsApi()

var clientId = "clientId_example"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiV1ClientsByClientIdGet(clientId, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost

ClassMethodHTTP requestDescription
GisServerApIs.ClientsApiapiV1ClientsByClientIdGetGET /api/v1/clients/{clientId}
GisServerApIs.ClientsApiapiV1UsersByUserIdClientsByClientIdPostPOST /api/v1/users/{userId}/clients/{clientId}
GisServerApIs.ClientsApiapiV1UsersByUserIdClientsDeleteDELETE /api/v1/users/{userId}/clients
GisServerApIs.ClientsApiapiV1UsersByUserIdClientsGetGET /api/v1/users/{userId}/clients
GisServerApIs.ClientsApiapiV1UsersByUserIdClientsPostPOST /api/v1/users/{userId}/clients
GisServerApIs.ClientsApiapiV1UsersClientRolesGetGET /api/v1/users/client/roles
GisServerApIs.ElevationApiapiV1ElevationAreaPostPOST /api/v1/elevation/area
GisServerApIs.ElevationApiapiV1ElevationGradeLinePostPOST /api/v1/elevation/grade/line
GisServerApIs.ElevationApiapiV1ElevationGradePointsPostPOST /api/v1/elevation/grade/points
GisServerApIs.ElevationApiapiV1ElevationLinePostPOST /api/v1/elevation/line
GisServerApIs.ElevationApiapiV1ElevationPointPostPOST /api/v1/elevation/point
GisServerApIs.ElevationConfigurationApiapiV1ElevationconfigGetGET /api/v1/elevationconfig
GisServerApIs.ElevationConfigurationApiapiV1ElevationconfigPostPOST /api/v1/elevationconfig
GisServerApIs.LoggersApiapiV1LoggersByManagerNameLogsGetGET /api/v1/loggers/{managerName}/logs
GisServerApIs.LoggersApiapiV1LoggersLogsGetGET /api/v1/loggers/logs
GisServerApIs.LoggersApiapiV1LoggersManagerNamesGetGET /api/v1/loggers/managerNames
GisServerApIs.MenuPermissionApiapiV1MenupermissionGetGET /api/v1/menupermission
GisServerApIs.MenuPermissionApiapiV1MenupermissionPostPOST /api/v1/menupermission
GisServerApIs.MenuPermissionApiapiV1RolesByRoleIdMenupermissionDeleteDELETE /api/v1/roles/{roleId}/menupermission
GisServerApIs.MenuPermissionApiapiV1RolesByRoleIdMenupermissionGetGET /api/v1/roles/{roleId}/menupermission
GisServerApIs.MenuPermissionApiapiV1UsersByUserIdMenupermissionGetGET /api/v1/users/{userId}/menupermission
GisServerApIs.PermissionsApiapiV1PermissionByRoleIdDeleteDELETE /api/v1/permission/{roleId}
GisServerApIs.PermissionsApiapiV1PermissionByRoleIdGetGET /api/v1/permission/{roleId}
GisServerApIs.PermissionsApiapiV1PermissionGetGET /api/v1/permission
GisServerApIs.PermissionsApiapiV1PermissionPostPOST /api/v1/permission
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdActionsDeleteDELETE /api/v1/restrictions/{restrictionId}/actions
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdActionsPostPOST /api/v1/restrictions/{restrictionId}/actions
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdDeleteDELETE /api/v1/restrictions/{restrictionId}
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdGetGET /api/v1/restrictions/{restrictionId}
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdPostPOST /api/v1/restrictions/{restrictionId}
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdUsersDeleteDELETE /api/v1/restrictions/{restrictionId}/users
GisServerApIs.RestrictionApiapiV1RestrictionsByRestrictionIdUsersPostPOST /api/v1/restrictions/{restrictionId}/users
GisServerApIs.RestrictionApiapiV1RestrictionsConfigurationGetGET /api/v1/restrictions/configuration
GisServerApIs.RestrictionApiapiV1RestrictionsDeleteDELETE /api/v1/restrictions
GisServerApIs.RestrictionApiapiV1RestrictionsGetGET /api/v1/restrictions
GisServerApIs.RestrictionApiapiV1RestrictionsPostPOST /api/v1/restrictions
GisServerApIs.RolesApiapiV1RolesByRoleIdActionsDeleteDELETE /api/v1/roles/{roleId}/actions
GisServerApIs.RolesApiapiV1RolesByRoleIdActionsPostPOST /api/v1/roles/{roleId}/actions
GisServerApIs.RolesApiapiV1RolesByRoleIdDeleteDELETE /api/v1/roles/{roleId}
GisServerApIs.RolesApiapiV1RolesByRoleIdGetGET /api/v1/roles/{roleId}
GisServerApIs.RolesApiapiV1RolesByRoleIdPostPOST /api/v1/roles/{roleId}
GisServerApIs.RolesApiapiV1RolesByRoleIdUsersDeleteDELETE /api/v1/roles/{roleId}/users
GisServerApIs.RolesApiapiV1RolesByRoleIdUsersPostPOST /api/v1/roles/{roleId}/users
GisServerApIs.RolesApiapiV1RolesDeleteDELETE /api/v1/roles
GisServerApIs.RolesApiapiV1RolesGetGET /api/v1/roles
GisServerApIs.RolesApiapiV1RolesPostPOST /api/v1/roles
GisServerApIs.RolesApiapiV1RolesUserByUserIdGetGET /api/v1/roles/user/{userId}
GisServerApIs.StatisticsApiapiV1StatisticsGetGET /api/v1/statistics
GisServerApIs.StatisticsApiapiV1UsersByUserIdStatisticsGetGET /api/v1/users/{userId}/statistics
GisServerApIs.TimeZoneApiapiV1TimezonesGetGET /api/v1/timezones
GisServerApIs.UsersApiapiV1UsersByUserIdDeleteDELETE /api/v1/users/{userId}
GisServerApIs.UsersApiapiV1UsersByUserIdGetGET /api/v1/users/{userId}
GisServerApIs.UsersApiapiV1UsersByUserIdPostPOST /api/v1/users/{userId}
GisServerApIs.UsersApiapiV1UsersByUserIdRestrictionsDeleteDELETE /api/v1/users/{userId}/restrictions
GisServerApIs.UsersApiapiV1UsersByUserIdRestrictionsGetGET /api/v1/users/{userId}/restrictions
GisServerApIs.UsersApiapiV1UsersByUserIdRestrictionsPostPOST /api/v1/users/{userId}/restrictions
GisServerApIs.UsersApiapiV1UsersByUserIdRolesDeleteDELETE /api/v1/users/{userId}/roles
GisServerApIs.UsersApiapiV1UsersByUserIdRolesPostPOST /api/v1/users/{userId}/roles
GisServerApIs.UsersApiapiV1UsersChangepasswordPostPOST /api/v1/users/changepassword
GisServerApIs.UsersApiapiV1UsersDeleteDELETE /api/v1/users
GisServerApIs.UsersApiapiV1UsersGetGET /api/v1/users
GisServerApIs.UsersApiapiV1UsersPostPOST /api/v1/users
GisServerApIs.UsersApiapiV1UsersRestrictionByRestrictionIdGetGET /api/v1/users/restriction/{restrictionId}
GisServerApIs.UsersApiapiV1UsersRoleByRoleIdGetGET /api/v1/users/role/{roleId}

Documentation for Models

Documentation for Authorization

Basic

  • Type: HTTP basic authentication

ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • GisServerAPIs: This scope encompasses all GIS Server APIs, including its service plugins.

ClientId

  • Type: API key
  • API key parameter name: ClientId
  • Location: URL query string

ResourceOwnerPassword

  • Type: OAuth
  • Flow: password
  • Authorization URL:
  • Scopes:
    • GisServerAPIs: This scope allows access to GIS Server APIs, including its service plugins.
    • offline_access: This scope allows the use of refresh tokens for offline or continuous access.