# 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](https://github.com/swagger-api/swagger-codegen) project: - API version: v1 - Package version: v1 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your gis_server_ap_is from, and run: ```shell npm link /path/to/ ``` 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: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *GisServerApIs.ClientsApi* | [**apiV1ClientsByClientIdGet**](docs/ClientsApi.md#apiV1ClientsByClientIdGet) | **GET** /api/v1/clients/{clientId} | *GisServerApIs.ClientsApi* | [**apiV1UsersByUserIdClientsByClientIdPost**](docs/ClientsApi.md#apiV1UsersByUserIdClientsByClientIdPost) | **POST** /api/v1/users/{userId}/clients/{clientId} | *GisServerApIs.ClientsApi* | [**apiV1UsersByUserIdClientsDelete**](docs/ClientsApi.md#apiV1UsersByUserIdClientsDelete) | **DELETE** /api/v1/users/{userId}/clients | *GisServerApIs.ClientsApi* | [**apiV1UsersByUserIdClientsGet**](docs/ClientsApi.md#apiV1UsersByUserIdClientsGet) | **GET** /api/v1/users/{userId}/clients | *GisServerApIs.ClientsApi* | [**apiV1UsersByUserIdClientsPost**](docs/ClientsApi.md#apiV1UsersByUserIdClientsPost) | **POST** /api/v1/users/{userId}/clients | *GisServerApIs.ClientsApi* | [**apiV1UsersClientRolesGet**](docs/ClientsApi.md#apiV1UsersClientRolesGet) | **GET** /api/v1/users/client/roles | *GisServerApIs.ElevationApi* | [**apiV1ElevationAreaPost**](docs/ElevationApi.md#apiV1ElevationAreaPost) | **POST** /api/v1/elevation/area | *GisServerApIs.ElevationApi* | [**apiV1ElevationGradeLinePost**](docs/ElevationApi.md#apiV1ElevationGradeLinePost) | **POST** /api/v1/elevation/grade/line | *GisServerApIs.ElevationApi* | [**apiV1ElevationGradePointsPost**](docs/ElevationApi.md#apiV1ElevationGradePointsPost) | **POST** /api/v1/elevation/grade/points | *GisServerApIs.ElevationApi* | [**apiV1ElevationLinePost**](docs/ElevationApi.md#apiV1ElevationLinePost) | **POST** /api/v1/elevation/line | *GisServerApIs.ElevationApi* | [**apiV1ElevationPointPost**](docs/ElevationApi.md#apiV1ElevationPointPost) | **POST** /api/v1/elevation/point | *GisServerApIs.ElevationConfigurationApi* | [**apiV1ElevationconfigGet**](docs/ElevationConfigurationApi.md#apiV1ElevationconfigGet) | **GET** /api/v1/elevationconfig | *GisServerApIs.ElevationConfigurationApi* | [**apiV1ElevationconfigPost**](docs/ElevationConfigurationApi.md#apiV1ElevationconfigPost) | **POST** /api/v1/elevationconfig | *GisServerApIs.LoggersApi* | [**apiV1LoggersByManagerNameLogsGet**](docs/LoggersApi.md#apiV1LoggersByManagerNameLogsGet) | **GET** /api/v1/loggers/{managerName}/logs | *GisServerApIs.LoggersApi* | [**apiV1LoggersLogsGet**](docs/LoggersApi.md#apiV1LoggersLogsGet) | **GET** /api/v1/loggers/logs | *GisServerApIs.LoggersApi* | [**apiV1LoggersManagerNamesGet**](docs/LoggersApi.md#apiV1LoggersManagerNamesGet) | **GET** /api/v1/loggers/managerNames | *GisServerApIs.MenuPermissionApi* | [**apiV1MenupermissionGet**](docs/MenuPermissionApi.md#apiV1MenupermissionGet) | **GET** /api/v1/menupermission | *GisServerApIs.MenuPermissionApi* | [**apiV1MenupermissionPost**](docs/MenuPermissionApi.md#apiV1MenupermissionPost) | **POST** /api/v1/menupermission | *GisServerApIs.MenuPermissionApi* | [**apiV1RolesByRoleIdMenupermissionDelete**](docs/MenuPermissionApi.md#apiV1RolesByRoleIdMenupermissionDelete) | **DELETE** /api/v1/roles/{roleId}/menupermission | *GisServerApIs.MenuPermissionApi* | [**apiV1RolesByRoleIdMenupermissionGet**](docs/MenuPermissionApi.md#apiV1RolesByRoleIdMenupermissionGet) | **GET** /api/v1/roles/{roleId}/menupermission | *GisServerApIs.MenuPermissionApi* | [**apiV1UsersByUserIdMenupermissionGet**](docs/MenuPermissionApi.md#apiV1UsersByUserIdMenupermissionGet) | **GET** /api/v1/users/{userId}/menupermission | *GisServerApIs.PermissionsApi* | [**apiV1PermissionByRoleIdDelete**](docs/PermissionsApi.md#apiV1PermissionByRoleIdDelete) | **DELETE** /api/v1/permission/{roleId} | *GisServerApIs.PermissionsApi* | [**apiV1PermissionByRoleIdGet**](docs/PermissionsApi.md#apiV1PermissionByRoleIdGet) | **GET** /api/v1/permission/{roleId} | *GisServerApIs.PermissionsApi* | [**apiV1PermissionGet**](docs/PermissionsApi.md#apiV1PermissionGet) | **GET** /api/v1/permission | *GisServerApIs.PermissionsApi* | [**apiV1PermissionPost**](docs/PermissionsApi.md#apiV1PermissionPost) | **POST** /api/v1/permission | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdActionsDelete**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdActionsDelete) | **DELETE** /api/v1/restrictions/{restrictionId}/actions | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdActionsPost**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdActionsPost) | **POST** /api/v1/restrictions/{restrictionId}/actions | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdDelete**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdDelete) | **DELETE** /api/v1/restrictions/{restrictionId} | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdGet**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdGet) | **GET** /api/v1/restrictions/{restrictionId} | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdPost**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdPost) | **POST** /api/v1/restrictions/{restrictionId} | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdUsersDelete**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdUsersDelete) | **DELETE** /api/v1/restrictions/{restrictionId}/users | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsByRestrictionIdUsersPost**](docs/RestrictionApi.md#apiV1RestrictionsByRestrictionIdUsersPost) | **POST** /api/v1/restrictions/{restrictionId}/users | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsConfigurationGet**](docs/RestrictionApi.md#apiV1RestrictionsConfigurationGet) | **GET** /api/v1/restrictions/configuration | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsDelete**](docs/RestrictionApi.md#apiV1RestrictionsDelete) | **DELETE** /api/v1/restrictions | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsGet**](docs/RestrictionApi.md#apiV1RestrictionsGet) | **GET** /api/v1/restrictions | *GisServerApIs.RestrictionApi* | [**apiV1RestrictionsPost**](docs/RestrictionApi.md#apiV1RestrictionsPost) | **POST** /api/v1/restrictions | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdActionsDelete**](docs/RolesApi.md#apiV1RolesByRoleIdActionsDelete) | **DELETE** /api/v1/roles/{roleId}/actions | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdActionsPost**](docs/RolesApi.md#apiV1RolesByRoleIdActionsPost) | **POST** /api/v1/roles/{roleId}/actions | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdDelete**](docs/RolesApi.md#apiV1RolesByRoleIdDelete) | **DELETE** /api/v1/roles/{roleId} | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdGet**](docs/RolesApi.md#apiV1RolesByRoleIdGet) | **GET** /api/v1/roles/{roleId} | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdPost**](docs/RolesApi.md#apiV1RolesByRoleIdPost) | **POST** /api/v1/roles/{roleId} | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdUsersDelete**](docs/RolesApi.md#apiV1RolesByRoleIdUsersDelete) | **DELETE** /api/v1/roles/{roleId}/users | *GisServerApIs.RolesApi* | [**apiV1RolesByRoleIdUsersPost**](docs/RolesApi.md#apiV1RolesByRoleIdUsersPost) | **POST** /api/v1/roles/{roleId}/users | *GisServerApIs.RolesApi* | [**apiV1RolesDelete**](docs/RolesApi.md#apiV1RolesDelete) | **DELETE** /api/v1/roles | *GisServerApIs.RolesApi* | [**apiV1RolesGet**](docs/RolesApi.md#apiV1RolesGet) | **GET** /api/v1/roles | *GisServerApIs.RolesApi* | [**apiV1RolesPost**](docs/RolesApi.md#apiV1RolesPost) | **POST** /api/v1/roles | *GisServerApIs.RolesApi* | [**apiV1RolesUserByUserIdGet**](docs/RolesApi.md#apiV1RolesUserByUserIdGet) | **GET** /api/v1/roles/user/{userId} | *GisServerApIs.StatisticsApi* | [**apiV1StatisticsGet**](docs/StatisticsApi.md#apiV1StatisticsGet) | **GET** /api/v1/statistics | *GisServerApIs.StatisticsApi* | [**apiV1UsersByUserIdStatisticsGet**](docs/StatisticsApi.md#apiV1UsersByUserIdStatisticsGet) | **GET** /api/v1/users/{userId}/statistics | *GisServerApIs.TimeZoneApi* | [**apiV1TimezonesGet**](docs/TimeZoneApi.md#apiV1TimezonesGet) | **GET** /api/v1/timezones | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdDelete**](docs/UsersApi.md#apiV1UsersByUserIdDelete) | **DELETE** /api/v1/users/{userId} | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdGet**](docs/UsersApi.md#apiV1UsersByUserIdGet) | **GET** /api/v1/users/{userId} | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdPost**](docs/UsersApi.md#apiV1UsersByUserIdPost) | **POST** /api/v1/users/{userId} | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdRestrictionsDelete**](docs/UsersApi.md#apiV1UsersByUserIdRestrictionsDelete) | **DELETE** /api/v1/users/{userId}/restrictions | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdRestrictionsGet**](docs/UsersApi.md#apiV1UsersByUserIdRestrictionsGet) | **GET** /api/v1/users/{userId}/restrictions | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdRestrictionsPost**](docs/UsersApi.md#apiV1UsersByUserIdRestrictionsPost) | **POST** /api/v1/users/{userId}/restrictions | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdRolesDelete**](docs/UsersApi.md#apiV1UsersByUserIdRolesDelete) | **DELETE** /api/v1/users/{userId}/roles | *GisServerApIs.UsersApi* | [**apiV1UsersByUserIdRolesPost**](docs/UsersApi.md#apiV1UsersByUserIdRolesPost) | **POST** /api/v1/users/{userId}/roles | *GisServerApIs.UsersApi* | [**apiV1UsersChangepasswordPost**](docs/UsersApi.md#apiV1UsersChangepasswordPost) | **POST** /api/v1/users/changepassword | *GisServerApIs.UsersApi* | [**apiV1UsersDelete**](docs/UsersApi.md#apiV1UsersDelete) | **DELETE** /api/v1/users | *GisServerApIs.UsersApi* | [**apiV1UsersGet**](docs/UsersApi.md#apiV1UsersGet) | **GET** /api/v1/users | *GisServerApIs.UsersApi* | [**apiV1UsersPost**](docs/UsersApi.md#apiV1UsersPost) | **POST** /api/v1/users | *GisServerApIs.UsersApi* | [**apiV1UsersRestrictionByRestrictionIdGet**](docs/UsersApi.md#apiV1UsersRestrictionByRestrictionIdGet) | **GET** /api/v1/users/restriction/{restrictionId} | *GisServerApIs.UsersApi* | [**apiV1UsersRoleByRoleIdGet**](docs/UsersApi.md#apiV1UsersRoleByRoleIdGet) | **GET** /api/v1/users/role/{roleId} | ## Documentation for Models - [GisServerApIs.ActionToRoleResource](docs/ActionToRoleResource.md) - [GisServerApIs.ChangePasswordResource](docs/ChangePasswordResource.md) - [GisServerApIs.ClientResource](docs/ClientResource.md) - [GisServerApIs.ClientResponse](docs/ClientResponse.md) - [GisServerApIs.ClientsResponse](docs/ClientsResponse.md) - [GisServerApIs.ElevationConfigurationResource](docs/ElevationConfigurationResource.md) - [GisServerApIs.ElevationPoint](docs/ElevationPoint.md) - [GisServerApIs.ElevationRequest](docs/ElevationRequest.md) - [GisServerApIs.ElevationResponse](docs/ElevationResponse.md) - [GisServerApIs.ElevationsResponse](docs/ElevationsResponse.md) - [GisServerApIs.ErrorResponse](docs/ErrorResponse.md) - [GisServerApIs.ExceptionInfo](docs/ExceptionInfo.md) - [GisServerApIs.GeoResponseLink](docs/GeoResponseLink.md) - [GisServerApIs.GradeRequest](docs/GradeRequest.md) - [GisServerApIs.GradeResponse](docs/GradeResponse.md) - [GisServerApIs.GradesResponse](docs/GradesResponse.md) - [GisServerApIs.LoggerMessage](docs/LoggerMessage.md) - [GisServerApIs.MenuPermissionResponse](docs/MenuPermissionResponse.md) - [GisServerApIs.MenuPermissionToRoleResource](docs/MenuPermissionToRoleResource.md) - [GisServerApIs.MenuPermissionsResponse](docs/MenuPermissionsResponse.md) - [GisServerApIs.PermissionResponse](docs/PermissionResponse.md) - [GisServerApIs.PermissionsResponse](docs/PermissionsResponse.md) - [GisServerApIs.RegisterUserResource](docs/RegisterUserResource.md) - [GisServerApIs.ResponseClientResponse](docs/ResponseClientResponse.md) - [GisServerApIs.ResponseCollectionLoggerMessage](docs/ResponseCollectionLoggerMessage.md) - [GisServerApIs.ResponseCollectionString](docs/ResponseCollectionString.md) - [GisServerApIs.ResponseElevationConfigurationResource](docs/ResponseElevationConfigurationResource.md) - [GisServerApIs.ResponseElevationPoint](docs/ResponseElevationPoint.md) - [GisServerApIs.ResponseListRestrictionActionResource](docs/ResponseListRestrictionActionResource.md) - [GisServerApIs.ResponseObject](docs/ResponseObject.md) - [GisServerApIs.ResponseRestrictionResponse](docs/ResponseRestrictionResponse.md) - [GisServerApIs.ResponseRoleResponse](docs/ResponseRoleResponse.md) - [GisServerApIs.ResponseUserResponse](docs/ResponseUserResponse.md) - [GisServerApIs.ResponseUserRestrictionResponse](docs/ResponseUserRestrictionResponse.md) - [GisServerApIs.RestrictionActionResource](docs/RestrictionActionResource.md) - [GisServerApIs.RestrictionResource](docs/RestrictionResource.md) - [GisServerApIs.RestrictionResponse](docs/RestrictionResponse.md) - [GisServerApIs.RestrictionsResponse](docs/RestrictionsResponse.md) - [GisServerApIs.RoleActionResource](docs/RoleActionResource.md) - [GisServerApIs.RoleResource](docs/RoleResource.md) - [GisServerApIs.RoleResponse](docs/RoleResponse.md) - [GisServerApIs.RolesResponse](docs/RolesResponse.md) - [GisServerApIs.StatisticResponse](docs/StatisticResponse.md) - [GisServerApIs.StatisticsResponse](docs/StatisticsResponse.md) - [GisServerApIs.UserResource](docs/UserResource.md) - [GisServerApIs.UserResponse](docs/UserResponse.md) - [GisServerApIs.UserRestrictionResponse](docs/UserRestrictionResponse.md) - [GisServerApIs.UserRestrictionsResponse](docs/UserRestrictionsResponse.md) - [GisServerApIs.UsersResponse](docs/UsersResponse.md) ## 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.