gis_server_ap_is v0.0.2-beta.1
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
Class | Method | HTTP request | Description |
---|---|---|---|
GisServerApIs.ClientsApi | apiV1ClientsByClientIdGet | GET /api/v1/clients/{clientId} | |
GisServerApIs.ClientsApi | apiV1UsersByUserIdClientsByClientIdPost | POST /api/v1/users/{userId}/clients/{clientId} | |
GisServerApIs.ClientsApi | apiV1UsersByUserIdClientsDelete | DELETE /api/v1/users/{userId}/clients | |
GisServerApIs.ClientsApi | apiV1UsersByUserIdClientsGet | GET /api/v1/users/{userId}/clients | |
GisServerApIs.ClientsApi | apiV1UsersByUserIdClientsPost | POST /api/v1/users/{userId}/clients | |
GisServerApIs.ClientsApi | apiV1UsersClientRolesGet | GET /api/v1/users/client/roles | |
GisServerApIs.ElevationApi | apiV1ElevationAreaPost | POST /api/v1/elevation/area | |
GisServerApIs.ElevationApi | apiV1ElevationGradeLinePost | POST /api/v1/elevation/grade/line | |
GisServerApIs.ElevationApi | apiV1ElevationGradePointsPost | POST /api/v1/elevation/grade/points | |
GisServerApIs.ElevationApi | apiV1ElevationLinePost | POST /api/v1/elevation/line | |
GisServerApIs.ElevationApi | apiV1ElevationPointPost | POST /api/v1/elevation/point | |
GisServerApIs.ElevationConfigurationApi | apiV1ElevationconfigGet | GET /api/v1/elevationconfig | |
GisServerApIs.ElevationConfigurationApi | apiV1ElevationconfigPost | POST /api/v1/elevationconfig | |
GisServerApIs.LoggersApi | apiV1LoggersByManagerNameLogsGet | GET /api/v1/loggers/{managerName}/logs | |
GisServerApIs.LoggersApi | apiV1LoggersLogsGet | GET /api/v1/loggers/logs | |
GisServerApIs.LoggersApi | apiV1LoggersManagerNamesGet | GET /api/v1/loggers/managerNames | |
GisServerApIs.MenuPermissionApi | apiV1MenupermissionGet | GET /api/v1/menupermission | |
GisServerApIs.MenuPermissionApi | apiV1MenupermissionPost | POST /api/v1/menupermission | |
GisServerApIs.MenuPermissionApi | apiV1RolesByRoleIdMenupermissionDelete | DELETE /api/v1/roles/{roleId}/menupermission | |
GisServerApIs.MenuPermissionApi | apiV1RolesByRoleIdMenupermissionGet | GET /api/v1/roles/{roleId}/menupermission | |
GisServerApIs.MenuPermissionApi | apiV1UsersByUserIdMenupermissionGet | GET /api/v1/users/{userId}/menupermission | |
GisServerApIs.PermissionsApi | apiV1PermissionByRoleIdDelete | DELETE /api/v1/permission/{roleId} | |
GisServerApIs.PermissionsApi | apiV1PermissionByRoleIdGet | GET /api/v1/permission/{roleId} | |
GisServerApIs.PermissionsApi | apiV1PermissionGet | GET /api/v1/permission | |
GisServerApIs.PermissionsApi | apiV1PermissionPost | POST /api/v1/permission | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdActionsDelete | DELETE /api/v1/restrictions/{restrictionId}/actions | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdActionsPost | POST /api/v1/restrictions/{restrictionId}/actions | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdDelete | DELETE /api/v1/restrictions/{restrictionId} | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdGet | GET /api/v1/restrictions/{restrictionId} | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdPost | POST /api/v1/restrictions/{restrictionId} | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdUsersDelete | DELETE /api/v1/restrictions/{restrictionId}/users | |
GisServerApIs.RestrictionApi | apiV1RestrictionsByRestrictionIdUsersPost | POST /api/v1/restrictions/{restrictionId}/users | |
GisServerApIs.RestrictionApi | apiV1RestrictionsConfigurationGet | GET /api/v1/restrictions/configuration | |
GisServerApIs.RestrictionApi | apiV1RestrictionsDelete | DELETE /api/v1/restrictions | |
GisServerApIs.RestrictionApi | apiV1RestrictionsGet | GET /api/v1/restrictions | |
GisServerApIs.RestrictionApi | apiV1RestrictionsPost | POST /api/v1/restrictions | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdActionsDelete | DELETE /api/v1/roles/{roleId}/actions | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdActionsPost | POST /api/v1/roles/{roleId}/actions | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdDelete | DELETE /api/v1/roles/{roleId} | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdGet | GET /api/v1/roles/{roleId} | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdPost | POST /api/v1/roles/{roleId} | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdUsersDelete | DELETE /api/v1/roles/{roleId}/users | |
GisServerApIs.RolesApi | apiV1RolesByRoleIdUsersPost | POST /api/v1/roles/{roleId}/users | |
GisServerApIs.RolesApi | apiV1RolesDelete | DELETE /api/v1/roles | |
GisServerApIs.RolesApi | apiV1RolesGet | GET /api/v1/roles | |
GisServerApIs.RolesApi | apiV1RolesPost | POST /api/v1/roles | |
GisServerApIs.RolesApi | apiV1RolesUserByUserIdGet | GET /api/v1/roles/user/{userId} | |
GisServerApIs.StatisticsApi | apiV1StatisticsGet | GET /api/v1/statistics | |
GisServerApIs.StatisticsApi | apiV1UsersByUserIdStatisticsGet | GET /api/v1/users/{userId}/statistics | |
GisServerApIs.TimeZoneApi | apiV1TimezonesGet | GET /api/v1/timezones | |
GisServerApIs.UsersApi | apiV1UsersByUserIdDelete | DELETE /api/v1/users/{userId} | |
GisServerApIs.UsersApi | apiV1UsersByUserIdGet | GET /api/v1/users/{userId} | |
GisServerApIs.UsersApi | apiV1UsersByUserIdPost | POST /api/v1/users/{userId} | |
GisServerApIs.UsersApi | apiV1UsersByUserIdRestrictionsDelete | DELETE /api/v1/users/{userId}/restrictions | |
GisServerApIs.UsersApi | apiV1UsersByUserIdRestrictionsGet | GET /api/v1/users/{userId}/restrictions | |
GisServerApIs.UsersApi | apiV1UsersByUserIdRestrictionsPost | POST /api/v1/users/{userId}/restrictions | |
GisServerApIs.UsersApi | apiV1UsersByUserIdRolesDelete | DELETE /api/v1/users/{userId}/roles | |
GisServerApIs.UsersApi | apiV1UsersByUserIdRolesPost | POST /api/v1/users/{userId}/roles | |
GisServerApIs.UsersApi | apiV1UsersChangepasswordPost | POST /api/v1/users/changepassword | |
GisServerApIs.UsersApi | apiV1UsersDelete | DELETE /api/v1/users | |
GisServerApIs.UsersApi | apiV1UsersGet | GET /api/v1/users | |
GisServerApIs.UsersApi | apiV1UsersPost | POST /api/v1/users | |
GisServerApIs.UsersApi | apiV1UsersRestrictionByRestrictionIdGet | GET /api/v1/users/restriction/{restrictionId} | |
GisServerApIs.UsersApi | apiV1UsersRoleByRoleIdGet | GET /api/v1/users/role/{roleId} |
Documentation for Models
- GisServerApIs.ActionToRoleResource
- GisServerApIs.ChangePasswordResource
- GisServerApIs.ClientResource
- GisServerApIs.ClientResponse
- GisServerApIs.ClientsResponse
- GisServerApIs.ElevationConfigurationResource
- GisServerApIs.ElevationPoint
- GisServerApIs.ElevationRequest
- GisServerApIs.ElevationResponse
- GisServerApIs.ElevationsResponse
- GisServerApIs.ErrorResponse
- GisServerApIs.ExceptionInfo
- GisServerApIs.GeoResponseLink
- GisServerApIs.GradeRequest
- GisServerApIs.GradeResponse
- GisServerApIs.GradesResponse
- GisServerApIs.LoggerMessage
- GisServerApIs.MenuPermissionResponse
- GisServerApIs.MenuPermissionToRoleResource
- GisServerApIs.MenuPermissionsResponse
- GisServerApIs.PermissionResponse
- GisServerApIs.PermissionsResponse
- GisServerApIs.RegisterUserResource
- GisServerApIs.ResponseClientResponse
- GisServerApIs.ResponseCollectionLoggerMessage
- GisServerApIs.ResponseCollectionString
- GisServerApIs.ResponseElevationConfigurationResource
- GisServerApIs.ResponseElevationPoint
- GisServerApIs.ResponseListRestrictionActionResource
- GisServerApIs.ResponseObject
- GisServerApIs.ResponseRestrictionResponse
- GisServerApIs.ResponseRoleResponse
- GisServerApIs.ResponseUserResponse
- GisServerApIs.ResponseUserRestrictionResponse
- GisServerApIs.RestrictionActionResource
- GisServerApIs.RestrictionResource
- GisServerApIs.RestrictionResponse
- GisServerApIs.RestrictionsResponse
- GisServerApIs.RoleActionResource
- GisServerApIs.RoleResource
- GisServerApIs.RoleResponse
- GisServerApIs.RolesResponse
- GisServerApIs.StatisticResponse
- GisServerApIs.StatisticsResponse
- GisServerApIs.UserResource
- GisServerApIs.UserResponse
- GisServerApIs.UserRestrictionResponse
- GisServerApIs.UserRestrictionsResponse
- GisServerApIs.UsersResponse
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.