Commit 6d3bb37d76a8678176923e2888c0dae383e91584

Authored by Evgeniy Pavlovskiy
0 parents

Minor update

Too many changes to show.

To preserve performance only 38 of 38+ files are displayed.

  1 +# NOTE: This file is auto generated by OpenAPI Generator.
  2 +# URL: https://openapi-generator.tech
  3 +#
  4 +# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
  5 +
  6 +name: openapi_client Python package
  7 +
  8 +on: [push, pull_request]
  9 +
  10 +jobs:
  11 + build:
  12 +
  13 + runs-on: ubuntu-latest
  14 + strategy:
  15 + matrix:
  16 + python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
  17 +
  18 + steps:
  19 + - uses: actions/checkout@v4
  20 + - name: Set up Python ${{ matrix.python-version }}
  21 + uses: actions/setup-python@v4
  22 + with:
  23 + python-version: ${{ matrix.python-version }}
  24 + - name: Install dependencies
  25 + run: |
  26 + python -m pip install --upgrade pip
  27 + pip install -r requirements.txt
  28 + pip install -r test-requirements.txt
  29 + - name: Test with pytest
  30 + run: |
  31 + pytest --cov={{packageName}}
... ...
  1 +# Byte-compiled / optimized / DLL files
  2 +__pycache__/
  3 +*.py[cod]
  4 +*$py.class
  5 +
  6 +# C extensions
  7 +*.so
  8 +
  9 +# Distribution / packaging
  10 +.Python
  11 +env/
  12 +build/
  13 +develop-eggs/
  14 +dist/
  15 +downloads/
  16 +eggs/
  17 +.eggs/
  18 +lib/
  19 +lib64/
  20 +parts/
  21 +sdist/
  22 +var/
  23 +*.egg-info/
  24 +.installed.cfg
  25 +*.egg
  26 +
  27 +# PyInstaller
  28 +# Usually these files are written by a python script from a template
  29 +# before PyInstaller builds the exe, so as to inject date/other infos into it.
  30 +*.manifest
  31 +*.spec
  32 +
  33 +# Installer logs
  34 +pip-log.txt
  35 +pip-delete-this-directory.txt
  36 +
  37 +# Unit test / coverage reports
  38 +htmlcov/
  39 +.tox/
  40 +.coverage
  41 +.coverage.*
  42 +.cache
  43 +nosetests.xml
  44 +coverage.xml
  45 +*,cover
  46 +.hypothesis/
  47 +venv/
  48 +.venv/
  49 +.python-version
  50 +.pytest_cache
  51 +
  52 +# Translations
  53 +*.mo
  54 +*.pot
  55 +
  56 +# Django stuff:
  57 +*.log
  58 +
  59 +# Sphinx documentation
  60 +docs/_build/
  61 +
  62 +# PyBuilder
  63 +target/
  64 +
  65 +#Ipython Notebook
  66 +.ipynb_checkpoints
... ...
  1 +# NOTE: This file is auto generated by OpenAPI Generator.
  2 +# URL: https://openapi-generator.tech
  3 +#
  4 +# ref: https://docs.gitlab.com/ee/ci/README.html
  5 +# ref: https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Python.gitlab-ci.yml
  6 +
  7 +stages:
  8 + - test
  9 +
  10 +.pytest:
  11 + stage: test
  12 + script:
  13 + - pip install -r requirements.txt
  14 + - pip install -r test-requirements.txt
  15 + - pytest --cov=openapi_client
  16 +
  17 +pytest-3.8:
  18 + extends: .pytest
  19 + image: python:3.8-alpine
  20 +pytest-3.9:
  21 + extends: .pytest
  22 + image: python:3.9-alpine
  23 +pytest-3.10:
  24 + extends: .pytest
  25 + image: python:3.10-alpine
  26 +pytest-3.11:
  27 + extends: .pytest
  28 + image: python:3.11-alpine
  29 +pytest-3.12:
  30 + extends: .pytest
  31 + image: python:3.12-alpine
... ...
  1 +# OpenAPI Generator Ignore
  2 +# Generated by openapi-generator https://github.com/openapitools/openapi-generator
  3 +
  4 +# Use this file to prevent files from being overwritten by the generator.
  5 +# The patterns follow closely to .gitignore or .dockerignore.
  6 +
  7 +# As an example, the C# client generator defines ApiClient.cs.
  8 +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
  9 +#ApiClient.cs
  10 +
  11 +# You can match any string of characters against a directory, file or extension with a single asterisk (*):
  12 +#foo/*/qux
  13 +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
  14 +
  15 +# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
  16 +#foo/**/qux
  17 +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
  18 +
  19 +# You can also negate patterns with an exclamation (!).
  20 +# For example, you can ignore all files in a docs folder with the file extension .md:
  21 +#docs/*.md
  22 +# Then explicitly reverse the ignore rule for a single file:
  23 +#!docs/README.md
... ...
  1 +.github/workflows/python.yml
  2 +.gitignore
  3 +.gitlab-ci.yml
  4 +.openapi-generator-ignore
  5 +.travis.yml
  6 +README.md
  7 +docs/DashboardDataApi.md
  8 +docs/DatasetDetails.md
  9 +docs/DatasetEntityDetails.md
  10 +docs/DatasetManagementApi.md
  11 +docs/DeleteDatasetEntities.md
  12 +docs/EntityFileDetails.md
  13 +docs/ForgotPassword.md
  14 +docs/HTTPValidationError.md
  15 +docs/LocationDetails.md
  16 +docs/LocationManagementApi.md
  17 +docs/NewDataset.md
  18 +docs/NewDatasetEntity.md
  19 +docs/NewLocation.md
  20 +docs/NewSession.md
  21 +docs/NewStudent.md
  22 +docs/ResetPassword.md
  23 +docs/SessionManagementApi.md
  24 +docs/StudentDetails.md
  25 +docs/UpdateDatasetEntity.md
  26 +docs/UpdateLocation.md
  27 +docs/UpdateUser.md
  28 +docs/UserDetails.md
  29 +docs/UsersManagementApi.md
  30 +docs/ValidationError.md
  31 +docs/ValidationErrorLocInner.md
  32 +git_push.sh
  33 +openapi_client/__init__.py
  34 +openapi_client/api/__init__.py
  35 +openapi_client/api/dashboard_data_api.py
  36 +openapi_client/api/dataset_management_api.py
  37 +openapi_client/api/location_management_api.py
  38 +openapi_client/api/session_management_api.py
  39 +openapi_client/api/users_management_api.py
  40 +openapi_client/api_client.py
  41 +openapi_client/api_response.py
  42 +openapi_client/configuration.py
  43 +openapi_client/exceptions.py
  44 +openapi_client/models/__init__.py
  45 +openapi_client/models/dataset_details.py
  46 +openapi_client/models/dataset_entity_details.py
  47 +openapi_client/models/delete_dataset_entities.py
  48 +openapi_client/models/entity_file_details.py
  49 +openapi_client/models/forgot_password.py
  50 +openapi_client/models/http_validation_error.py
  51 +openapi_client/models/location_details.py
  52 +openapi_client/models/new_dataset.py
  53 +openapi_client/models/new_dataset_entity.py
  54 +openapi_client/models/new_location.py
  55 +openapi_client/models/new_session.py
  56 +openapi_client/models/new_student.py
  57 +openapi_client/models/reset_password.py
  58 +openapi_client/models/student_details.py
  59 +openapi_client/models/update_dataset_entity.py
  60 +openapi_client/models/update_location.py
  61 +openapi_client/models/update_user.py
  62 +openapi_client/models/user_details.py
  63 +openapi_client/models/validation_error.py
  64 +openapi_client/models/validation_error_loc_inner.py
  65 +openapi_client/py.typed
  66 +openapi_client/rest.py
  67 +pyproject.toml
  68 +requirements.txt
  69 +setup.cfg
  70 +setup.py
  71 +test-requirements.txt
  72 +test/__init__.py
  73 +test/test_dashboard_data_api.py
  74 +test/test_dataset_details.py
  75 +test/test_dataset_entity_details.py
  76 +test/test_dataset_management_api.py
  77 +test/test_delete_dataset_entities.py
  78 +test/test_entity_file_details.py
  79 +test/test_forgot_password.py
  80 +test/test_http_validation_error.py
  81 +test/test_location_details.py
  82 +test/test_location_management_api.py
  83 +test/test_new_dataset.py
  84 +test/test_new_dataset_entity.py
  85 +test/test_new_location.py
  86 +test/test_new_session.py
  87 +test/test_new_student.py
  88 +test/test_reset_password.py
  89 +test/test_session_management_api.py
  90 +test/test_student_details.py
  91 +test/test_update_dataset_entity.py
  92 +test/test_update_location.py
  93 +test/test_update_user.py
  94 +test/test_user_details.py
  95 +test/test_users_management_api.py
  96 +test/test_validation_error.py
  97 +test/test_validation_error_loc_inner.py
  98 +tox.ini
... ...
  1 +7.11.0-SNAPSHOT
... ...
  1 +# ref: https://docs.travis-ci.com/user/languages/python
  2 +language: python
  3 +python:
  4 + - "3.8"
  5 + - "3.9"
  6 + - "3.10"
  7 + - "3.11"
  8 + - "3.12"
  9 + # uncomment the following if needed
  10 + #- "3.12-dev" # 3.12 development branch
  11 + #- "nightly" # nightly build
  12 +# command to install dependencies
  13 +install:
  14 + - "pip install -r requirements.txt"
  15 + - "pip install -r test-requirements.txt"
  16 +# command to run tests
  17 +script: pytest --cov=openapi_client
... ...
  1 +# openapi-client
  2 +No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  3 +
  4 +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
  5 +
  6 +- API version: 0.1.0
  7 +- Package version: 1.0.0
  8 +- Generator version: 7.11.0-SNAPSHOT
  9 +- Build package: org.openapitools.codegen.languages.PythonClientCodegen
  10 +
  11 +## Requirements.
  12 +
  13 +Python 3.8+
  14 +
  15 +## Installation & Usage
  16 +### pip install
  17 +
  18 +If the python package is hosted on a repository, you can install directly using:
  19 +
  20 +```sh
  21 +pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
  22 +```
  23 +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
  24 +
  25 +Then import the package:
  26 +```python
  27 +import openapi_client
  28 +```
  29 +
  30 +### Setuptools
  31 +
  32 +Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
  33 +
  34 +```sh
  35 +python setup.py install --user
  36 +```
  37 +(or `sudo python setup.py install` to install the package for all users)
  38 +
  39 +Then import the package:
  40 +```python
  41 +import openapi_client
  42 +```
  43 +
  44 +### Tests
  45 +
  46 +Execute `pytest` to run the tests.
  47 +
  48 +## Getting Started
  49 +
  50 +Please follow the [installation procedure](#installation--usage) and then run the following:
  51 +
  52 +```python
  53 +
  54 +import openapi_client
  55 +from openapi_client.rest import ApiException
  56 +from pprint import pprint
  57 +
  58 +# Defining the host is optional and defaults to http://localhost
  59 +# See configuration.py for a list of all supported configuration parameters.
  60 +configuration = openapi_client.Configuration(
  61 + host = "http://localhost"
  62 +)
  63 +
  64 +
  65 +
  66 +# Enter a context with an instance of the API client
  67 +with openapi_client.ApiClient(configuration) as api_client:
  68 + # Create an instance of the API class
  69 + api_instance = openapi_client.DashboardDataApi(api_client)
  70 + user_id = 56 # int |
  71 + user_type_id = 56 # int |
  72 +
  73 + try:
  74 + # Get Dashboard Data
  75 + api_response = api_instance.get_dashboard_data_dashboard_user_id_user_type_id_get(user_id, user_type_id)
  76 + print("The response of DashboardDataApi->get_dashboard_data_dashboard_user_id_user_type_id_get:\n")
  77 + pprint(api_response)
  78 + except ApiException as e:
  79 + print("Exception when calling DashboardDataApi->get_dashboard_data_dashboard_user_id_user_type_id_get: %s\n" % e)
  80 +
  81 +```
  82 +
  83 +## Documentation for API Endpoints
  84 +
  85 +All URIs are relative to *http://localhost*
  86 +
  87 +Class | Method | HTTP request | Description
  88 +------------ | ------------- | ------------- | -------------
  89 +*DashboardDataApi* | [**get_dashboard_data_dashboard_user_id_user_type_id_get**](docs/DashboardDataApi.md#get_dashboard_data_dashboard_user_id_user_type_id_get) | **GET** /dashboard/{user_id}/{user_type_id} | Get Dashboard Data
  90 +*DatasetManagementApi* | [**delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete**](docs/DatasetManagementApi.md#delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete) | **DELETE** /datasets/datasetEntities/{user_id}/{user_type_id} | Delete Dataset Entities
  91 +*DatasetManagementApi* | [**delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete**](docs/DatasetManagementApi.md#delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete) | **DELETE** /datasets/datasetEntities/files/{user_id}/{user_type_id} | Delete Entity Files
  92 +*DatasetManagementApi* | [**get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get**](docs/DatasetManagementApi.md#get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get) | **GET** /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id} | Get Dataset Entities
  93 +*DatasetManagementApi* | [**get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get**](docs/DatasetManagementApi.md#get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get) | **GET** /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}/{dataset_entity_id} | Get Dataset Item
  94 +*DatasetManagementApi* | [**get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get**](docs/DatasetManagementApi.md#get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get) | **GET** /datasets/datasetEntities/files/{user_id}/{user_type_id}/{dataset_id}/{file_id} | Get Entity File
  95 +*DatasetManagementApi* | [**get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get**](docs/DatasetManagementApi.md#get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get) | **GET** /datasets/datasetEntities/thumbnail/{user_id}/{user_type_id}/{dataset_id}/{file_id} | Get Thumbnail
  96 +*DatasetManagementApi* | [**get_user_datasets_datasets_user_id_user_type_id_get**](docs/DatasetManagementApi.md#get_user_datasets_datasets_user_id_user_type_id_get) | **GET** /datasets/{user_id}/{user_type_id} | Get User Datasets
  97 +*DatasetManagementApi* | [**new_dataset_datasets_user_id_user_type_id_post**](docs/DatasetManagementApi.md#new_dataset_datasets_user_id_user_type_id_post) | **POST** /datasets/{user_id}/{user_type_id} | New Dataset
  98 +*DatasetManagementApi* | [**new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post**](docs/DatasetManagementApi.md#new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post) | **POST** /datasets/datasetEntities/{user_id}/{user_type_id} | New Dataset Entity
  99 +*DatasetManagementApi* | [**recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post**](docs/DatasetManagementApi.md#recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post) | **POST** /datasets/datasetEntities/recover/{user_id}/{user_type_id} | Recover Dataset Entities
  100 +*DatasetManagementApi* | [**update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put**](docs/DatasetManagementApi.md#update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put) | **PUT** /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}/{dataset_entity_id} | Update Dataset Entity
  101 +*LocationManagementApi* | [**delete_location_locations_user_id_user_type_id_location_id_delete**](docs/LocationManagementApi.md#delete_location_locations_user_id_user_type_id_location_id_delete) | **DELETE** /locations/{user_id}/{user_type_id}/{location_id} | Delete Location
  102 +*LocationManagementApi* | [**get_user_locations_locations_user_id_user_type_id_get**](docs/LocationManagementApi.md#get_user_locations_locations_user_id_user_type_id_get) | **GET** /locations/{user_id}/{user_type_id} | Get User Locations
  103 +*LocationManagementApi* | [**new_location_locations_user_id_user_type_id_post**](docs/LocationManagementApi.md#new_location_locations_user_id_user_type_id_post) | **POST** /locations/{user_id}/{user_type_id} | New Location
  104 +*LocationManagementApi* | [**recover_location_locations_user_id_user_type_id_location_id_put**](docs/LocationManagementApi.md#recover_location_locations_user_id_user_type_id_location_id_put) | **PUT** /locations/{user_id}/{user_type_id}/{location_id} | Recover Location
  105 +*LocationManagementApi* | [**update_location_locations_user_id_user_type_id_put**](docs/LocationManagementApi.md#update_location_locations_user_id_user_type_id_put) | **PUT** /locations/{user_id}/{user_type_id} | Update Location
  106 +*SessionManagementApi* | [**delete_session_session_logout_user_id_user_type_id_delete**](docs/SessionManagementApi.md#delete_session_session_logout_user_id_user_type_id_delete) | **DELETE** /session/logout/{user_id}/{user_type_id} | Delete Session
  107 +*SessionManagementApi* | [**new_session_session_login_post**](docs/SessionManagementApi.md#new_session_session_login_post) | **POST** /session/login | New Session
  108 +*UsersManagementApi* | [**forgot_password_users_forgot_password_post**](docs/UsersManagementApi.md#forgot_password_users_forgot_password_post) | **POST** /users/forgotPassword | Forgot Password
  109 +*UsersManagementApi* | [**get_profile_picture_users_profile_pic_user_id_user_type_id_get**](docs/UsersManagementApi.md#get_profile_picture_users_profile_pic_user_id_user_type_id_get) | **GET** /users/profilePic/{user_id}/{user_type_id} | Get Profile Picture
  110 +*UsersManagementApi* | [**get_user_locations_users_students_user_id_user_type_id_get**](docs/UsersManagementApi.md#get_user_locations_users_students_user_id_user_type_id_get) | **GET** /users/students/{user_id}/{user_type_id} | Get User Locations
  111 +*UsersManagementApi* | [**new_student_users_students_user_id_user_type_id_post**](docs/UsersManagementApi.md#new_student_users_students_user_id_user_type_id_post) | **POST** /users/students/{user_id}/{user_type_id} | New Student
  112 +*UsersManagementApi* | [**reset_password_users_reset_password_post**](docs/UsersManagementApi.md#reset_password_users_reset_password_post) | **POST** /users/resetPassword | Reset Password
  113 +*UsersManagementApi* | [**update_profile_picture_users_profile_pic_user_id_user_type_id_post**](docs/UsersManagementApi.md#update_profile_picture_users_profile_pic_user_id_user_type_id_post) | **POST** /users/profilePic/{user_id}/{user_type_id} | Update Profile Picture
  114 +*UsersManagementApi* | [**update_user_profile_users_user_id_user_type_id_put**](docs/UsersManagementApi.md#update_user_profile_users_user_id_user_type_id_put) | **PUT** /users/{user_id}/{user_type_id} | Update User Profile
  115 +*UsersManagementApi* | [**validate_user_sign_up_users_validate_user_id_user_type_id_post**](docs/UsersManagementApi.md#validate_user_sign_up_users_validate_user_id_user_type_id_post) | **POST** /users/validate/{user_id}/{user_type_id} | Validate User Sign Up
  116 +
  117 +
  118 +## Documentation For Models
  119 +
  120 + - [DatasetDetails](docs/DatasetDetails.md)
  121 + - [DatasetEntityDetails](docs/DatasetEntityDetails.md)
  122 + - [DeleteDatasetEntities](docs/DeleteDatasetEntities.md)
  123 + - [EntityFileDetails](docs/EntityFileDetails.md)
  124 + - [ForgotPassword](docs/ForgotPassword.md)
  125 + - [HTTPValidationError](docs/HTTPValidationError.md)
  126 + - [LocationDetails](docs/LocationDetails.md)
  127 + - [NewDataset](docs/NewDataset.md)
  128 + - [NewDatasetEntity](docs/NewDatasetEntity.md)
  129 + - [NewLocation](docs/NewLocation.md)
  130 + - [NewSession](docs/NewSession.md)
  131 + - [NewStudent](docs/NewStudent.md)
  132 + - [ResetPassword](docs/ResetPassword.md)
  133 + - [StudentDetails](docs/StudentDetails.md)
  134 + - [UpdateDatasetEntity](docs/UpdateDatasetEntity.md)
  135 + - [UpdateLocation](docs/UpdateLocation.md)
  136 + - [UpdateUser](docs/UpdateUser.md)
  137 + - [UserDetails](docs/UserDetails.md)
  138 + - [ValidationError](docs/ValidationError.md)
  139 + - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
  140 +
  141 +
  142 +<a id="documentation-for-authorization"></a>
  143 +## Documentation For Authorization
  144 +
  145 +Endpoints do not require authorization.
  146 +
  147 +
  148 +## Author
  149 +
  150 +
  151 +
  152 +
... ...
  1 +# openapi_client.DashboardDataApi
  2 +
  3 +All URIs are relative to *http://localhost*
  4 +
  5 +Method | HTTP request | Description
  6 +------------- | ------------- | -------------
  7 +[**get_dashboard_data_dashboard_user_id_user_type_id_get**](DashboardDataApi.md#get_dashboard_data_dashboard_user_id_user_type_id_get) | **GET** /dashboard/{user_id}/{user_type_id} | Get Dashboard Data
  8 +
  9 +
  10 +# **get_dashboard_data_dashboard_user_id_user_type_id_get**
  11 +> object get_dashboard_data_dashboard_user_id_user_type_id_get(user_id, user_type_id)
  12 +
  13 +Get Dashboard Data
  14 +
  15 +### Example
  16 +
  17 +
  18 +```python
  19 +import openapi_client
  20 +from openapi_client.rest import ApiException
  21 +from pprint import pprint
  22 +
  23 +# Defining the host is optional and defaults to http://localhost
  24 +# See configuration.py for a list of all supported configuration parameters.
  25 +configuration = openapi_client.Configuration(
  26 + host = "http://localhost"
  27 +)
  28 +
  29 +
  30 +# Enter a context with an instance of the API client
  31 +with openapi_client.ApiClient(configuration) as api_client:
  32 + # Create an instance of the API class
  33 + api_instance = openapi_client.DashboardDataApi(api_client)
  34 + user_id = 56 # int |
  35 + user_type_id = 56 # int |
  36 +
  37 + try:
  38 + # Get Dashboard Data
  39 + api_response = api_instance.get_dashboard_data_dashboard_user_id_user_type_id_get(user_id, user_type_id)
  40 + print("The response of DashboardDataApi->get_dashboard_data_dashboard_user_id_user_type_id_get:\n")
  41 + pprint(api_response)
  42 + except Exception as e:
  43 + print("Exception when calling DashboardDataApi->get_dashboard_data_dashboard_user_id_user_type_id_get: %s\n" % e)
  44 +```
  45 +
  46 +
  47 +
  48 +### Parameters
  49 +
  50 +
  51 +Name | Type | Description | Notes
  52 +------------- | ------------- | ------------- | -------------
  53 + **user_id** | **int**| |
  54 + **user_type_id** | **int**| |
  55 +
  56 +### Return type
  57 +
  58 +**object**
  59 +
  60 +### Authorization
  61 +
  62 +No authorization required
  63 +
  64 +### HTTP request headers
  65 +
  66 + - **Content-Type**: Not defined
  67 + - **Accept**: application/json
  68 +
  69 +### HTTP response details
  70 +
  71 +| Status code | Description | Response headers |
  72 +|-------------|-------------|------------------|
  73 +**200** | Successful Response | - |
  74 +**422** | Validation Error | - |
  75 +
  76 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  77 +
... ...
  1 +# DatasetDetails
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**user_id** | **int** | | [optional] [default to 0]
  9 +**dataset_name** | **str** | |
  10 +**dataset_type** | **int** | | [optional]
  11 +**dataset_short_info** | **str** | | [optional]
  12 +**dataset_tags** | **str** | | [optional]
  13 +**dataset_id** | **int** | |
  14 +**dataset_type_interp** | **str** | | [optional]
  15 +**dataset_status** | **int** | |
  16 +**dataset_status_interp** | **str** | | [optional]
  17 +**created_on** | **datetime** | |
  18 +**modified_on** | **datetime** | |
  19 +
  20 +## Example
  21 +
  22 +```python
  23 +from openapi_client.models.dataset_details import DatasetDetails
  24 +
  25 +# TODO update the JSON string below
  26 +json = "{}"
  27 +# create an instance of DatasetDetails from a JSON string
  28 +dataset_details_instance = DatasetDetails.from_json(json)
  29 +# print the JSON string representation of the object
  30 +print(DatasetDetails.to_json())
  31 +
  32 +# convert the object into a dict
  33 +dataset_details_dict = dataset_details_instance.to_dict()
  34 +# create an instance of DatasetDetails from a dict
  35 +dataset_details_from_dict = DatasetDetails.from_dict(dataset_details_dict)
  36 +```
  37 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  38 +
  39 +
... ...
  1 +# DatasetEntityDetails
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**dataset_id** | **int** | | [optional]
  9 +**user_id** | **int** | | [optional]
  10 +**ds_entity_name** | **str** | |
  11 +**entity_source** | **str** | |
  12 +**collected_on** | **datetime** | |
  13 +**labeling_algo** | **str** | |
  14 +**ds_entity_info** | **object** | |
  15 +**location_id** | **int** | |
  16 +**ds_entity_id** | **str** | |
  17 +**ds_entity_status** | **int** | |
  18 +**entity_status_intrep** | **str** | | [optional]
  19 +**entity_verification_status** | **int** | |
  20 +**verification_status_interp** | **str** | | [optional]
  21 +**created_on** | **datetime** | |
  22 +**modified_on** | **datetime** | |
  23 +**location_details** | [**LocationDetails**](LocationDetails.md) | |
  24 +**files** | [**List[EntityFileDetails]**](EntityFileDetails.md) | | [optional]
  25 +
  26 +## Example
  27 +
  28 +```python
  29 +from openapi_client.models.dataset_entity_details import DatasetEntityDetails
  30 +
  31 +# TODO update the JSON string below
  32 +json = "{}"
  33 +# create an instance of DatasetEntityDetails from a JSON string
  34 +dataset_entity_details_instance = DatasetEntityDetails.from_json(json)
  35 +# print the JSON string representation of the object
  36 +print(DatasetEntityDetails.to_json())
  37 +
  38 +# convert the object into a dict
  39 +dataset_entity_details_dict = dataset_entity_details_instance.to_dict()
  40 +# create an instance of DatasetEntityDetails from a dict
  41 +dataset_entity_details_from_dict = DatasetEntityDetails.from_dict(dataset_entity_details_dict)
  42 +```
  43 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  44 +
  45 +
... ...
  1 +# openapi_client.DatasetManagementApi
  2 +
  3 +All URIs are relative to *http://localhost*
  4 +
  5 +Method | HTTP request | Description
  6 +------------- | ------------- | -------------
  7 +[**delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete**](DatasetManagementApi.md#delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete) | **DELETE** /datasets/datasetEntities/{user_id}/{user_type_id} | Delete Dataset Entities
  8 +[**delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete**](DatasetManagementApi.md#delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete) | **DELETE** /datasets/datasetEntities/files/{user_id}/{user_type_id} | Delete Entity Files
  9 +[**get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get**](DatasetManagementApi.md#get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get) | **GET** /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id} | Get Dataset Entities
  10 +[**get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get**](DatasetManagementApi.md#get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get) | **GET** /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}/{dataset_entity_id} | Get Dataset Item
  11 +[**get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get**](DatasetManagementApi.md#get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get) | **GET** /datasets/datasetEntities/files/{user_id}/{user_type_id}/{dataset_id}/{file_id} | Get Entity File
  12 +[**get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get**](DatasetManagementApi.md#get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get) | **GET** /datasets/datasetEntities/thumbnail/{user_id}/{user_type_id}/{dataset_id}/{file_id} | Get Thumbnail
  13 +[**get_user_datasets_datasets_user_id_user_type_id_get**](DatasetManagementApi.md#get_user_datasets_datasets_user_id_user_type_id_get) | **GET** /datasets/{user_id}/{user_type_id} | Get User Datasets
  14 +[**new_dataset_datasets_user_id_user_type_id_post**](DatasetManagementApi.md#new_dataset_datasets_user_id_user_type_id_post) | **POST** /datasets/{user_id}/{user_type_id} | New Dataset
  15 +[**new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post**](DatasetManagementApi.md#new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post) | **POST** /datasets/datasetEntities/{user_id}/{user_type_id} | New Dataset Entity
  16 +[**recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post**](DatasetManagementApi.md#recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post) | **POST** /datasets/datasetEntities/recover/{user_id}/{user_type_id} | Recover Dataset Entities
  17 +[**update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put**](DatasetManagementApi.md#update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put) | **PUT** /datasets/datasetEntities/{user_id}/{user_type_id}/{dataset_id}/{dataset_entity_id} | Update Dataset Entity
  18 +
  19 +
  20 +# **delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete**
  21 +> object delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete(user_id, user_type_id, delete_dataset_entities)
  22 +
  23 +Delete Dataset Entities
  24 +
  25 +### Example
  26 +
  27 +
  28 +```python
  29 +import openapi_client
  30 +from openapi_client.models.delete_dataset_entities import DeleteDatasetEntities
  31 +from openapi_client.rest import ApiException
  32 +from pprint import pprint
  33 +
  34 +# Defining the host is optional and defaults to http://localhost
  35 +# See configuration.py for a list of all supported configuration parameters.
  36 +configuration = openapi_client.Configuration(
  37 + host = "http://localhost"
  38 +)
  39 +
  40 +
  41 +# Enter a context with an instance of the API client
  42 +with openapi_client.ApiClient(configuration) as api_client:
  43 + # Create an instance of the API class
  44 + api_instance = openapi_client.DatasetManagementApi(api_client)
  45 + user_id = 56 # int |
  46 + user_type_id = 56 # int |
  47 + delete_dataset_entities = openapi_client.DeleteDatasetEntities() # DeleteDatasetEntities |
  48 +
  49 + try:
  50 + # Delete Dataset Entities
  51 + api_response = api_instance.delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete(user_id, user_type_id, delete_dataset_entities)
  52 + print("The response of DatasetManagementApi->delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete:\n")
  53 + pprint(api_response)
  54 + except Exception as e:
  55 + print("Exception when calling DatasetManagementApi->delete_dataset_entities_datasets_dataset_entities_user_id_user_type_id_delete: %s\n" % e)
  56 +```
  57 +
  58 +
  59 +
  60 +### Parameters
  61 +
  62 +
  63 +Name | Type | Description | Notes
  64 +------------- | ------------- | ------------- | -------------
  65 + **user_id** | **int**| |
  66 + **user_type_id** | **int**| |
  67 + **delete_dataset_entities** | [**DeleteDatasetEntities**](DeleteDatasetEntities.md)| |
  68 +
  69 +### Return type
  70 +
  71 +**object**
  72 +
  73 +### Authorization
  74 +
  75 +No authorization required
  76 +
  77 +### HTTP request headers
  78 +
  79 + - **Content-Type**: application/json
  80 + - **Accept**: application/json
  81 +
  82 +### HTTP response details
  83 +
  84 +| Status code | Description | Response headers |
  85 +|-------------|-------------|------------------|
  86 +**200** | Successful Response | - |
  87 +**422** | Validation Error | - |
  88 +
  89 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  90 +
  91 +# **delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete**
  92 +> object delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete(user_id, user_type_id, request_body)
  93 +
  94 +Delete Entity Files
  95 +
  96 +### Example
  97 +
  98 +
  99 +```python
  100 +import openapi_client
  101 +from openapi_client.rest import ApiException
  102 +from pprint import pprint
  103 +
  104 +# Defining the host is optional and defaults to http://localhost
  105 +# See configuration.py for a list of all supported configuration parameters.
  106 +configuration = openapi_client.Configuration(
  107 + host = "http://localhost"
  108 +)
  109 +
  110 +
  111 +# Enter a context with an instance of the API client
  112 +with openapi_client.ApiClient(configuration) as api_client:
  113 + # Create an instance of the API class
  114 + api_instance = openapi_client.DatasetManagementApi(api_client)
  115 + user_id = 56 # int |
  116 + user_type_id = 56 # int |
  117 + request_body = ['request_body_example'] # List[str] |
  118 +
  119 + try:
  120 + # Delete Entity Files
  121 + api_response = api_instance.delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete(user_id, user_type_id, request_body)
  122 + print("The response of DatasetManagementApi->delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete:\n")
  123 + pprint(api_response)
  124 + except Exception as e:
  125 + print("Exception when calling DatasetManagementApi->delete_entity_files_datasets_dataset_entities_files_user_id_user_type_id_delete: %s\n" % e)
  126 +```
  127 +
  128 +
  129 +
  130 +### Parameters
  131 +
  132 +
  133 +Name | Type | Description | Notes
  134 +------------- | ------------- | ------------- | -------------
  135 + **user_id** | **int**| |
  136 + **user_type_id** | **int**| |
  137 + **request_body** | [**List[str]**](str.md)| |
  138 +
  139 +### Return type
  140 +
  141 +**object**
  142 +
  143 +### Authorization
  144 +
  145 +No authorization required
  146 +
  147 +### HTTP request headers
  148 +
  149 + - **Content-Type**: application/json
  150 + - **Accept**: application/json
  151 +
  152 +### HTTP response details
  153 +
  154 +| Status code | Description | Response headers |
  155 +|-------------|-------------|------------------|
  156 +**200** | Successful Response | - |
  157 +**422** | Validation Error | - |
  158 +
  159 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  160 +
  161 +# **get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get**
  162 +> List[DatasetEntityDetails] get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get(user_id, user_type_id, dataset_id)
  163 +
  164 +Get Dataset Entities
  165 +
  166 +### Example
  167 +
  168 +
  169 +```python
  170 +import openapi_client
  171 +from openapi_client.models.dataset_entity_details import DatasetEntityDetails
  172 +from openapi_client.rest import ApiException
  173 +from pprint import pprint
  174 +
  175 +# Defining the host is optional and defaults to http://localhost
  176 +# See configuration.py for a list of all supported configuration parameters.
  177 +configuration = openapi_client.Configuration(
  178 + host = "http://localhost"
  179 +)
  180 +
  181 +
  182 +# Enter a context with an instance of the API client
  183 +with openapi_client.ApiClient(configuration) as api_client:
  184 + # Create an instance of the API class
  185 + api_instance = openapi_client.DatasetManagementApi(api_client)
  186 + user_id = 56 # int |
  187 + user_type_id = 56 # int |
  188 + dataset_id = 56 # int |
  189 +
  190 + try:
  191 + # Get Dataset Entities
  192 + api_response = api_instance.get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get(user_id, user_type_id, dataset_id)
  193 + print("The response of DatasetManagementApi->get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get:\n")
  194 + pprint(api_response)
  195 + except Exception as e:
  196 + print("Exception when calling DatasetManagementApi->get_dataset_entities_datasets_dataset_entities_user_id_user_type_id_dataset_id_get: %s\n" % e)
  197 +```
  198 +
  199 +
  200 +
  201 +### Parameters
  202 +
  203 +
  204 +Name | Type | Description | Notes
  205 +------------- | ------------- | ------------- | -------------
  206 + **user_id** | **int**| |
  207 + **user_type_id** | **int**| |
  208 + **dataset_id** | **int**| |
  209 +
  210 +### Return type
  211 +
  212 +[**List[DatasetEntityDetails]**](DatasetEntityDetails.md)
  213 +
  214 +### Authorization
  215 +
  216 +No authorization required
  217 +
  218 +### HTTP request headers
  219 +
  220 + - **Content-Type**: Not defined
  221 + - **Accept**: application/json
  222 +
  223 +### HTTP response details
  224 +
  225 +| Status code | Description | Response headers |
  226 +|-------------|-------------|------------------|
  227 +**200** | Successful Response | - |
  228 +**422** | Validation Error | - |
  229 +
  230 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  231 +
  232 +# **get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get**
  233 +> DatasetEntityDetails get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get(user_id, user_type_id, dataset_id, dataset_entity_id)
  234 +
  235 +Get Dataset Item
  236 +
  237 +### Example
  238 +
  239 +
  240 +```python
  241 +import openapi_client
  242 +from openapi_client.models.dataset_entity_details import DatasetEntityDetails
  243 +from openapi_client.rest import ApiException
  244 +from pprint import pprint
  245 +
  246 +# Defining the host is optional and defaults to http://localhost
  247 +# See configuration.py for a list of all supported configuration parameters.
  248 +configuration = openapi_client.Configuration(
  249 + host = "http://localhost"
  250 +)
  251 +
  252 +
  253 +# Enter a context with an instance of the API client
  254 +with openapi_client.ApiClient(configuration) as api_client:
  255 + # Create an instance of the API class
  256 + api_instance = openapi_client.DatasetManagementApi(api_client)
  257 + user_id = 56 # int |
  258 + user_type_id = 56 # int |
  259 + dataset_id = 56 # int |
  260 + dataset_entity_id = 'dataset_entity_id_example' # str |
  261 +
  262 + try:
  263 + # Get Dataset Item
  264 + api_response = api_instance.get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get(user_id, user_type_id, dataset_id, dataset_entity_id)
  265 + print("The response of DatasetManagementApi->get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get:\n")
  266 + pprint(api_response)
  267 + except Exception as e:
  268 + print("Exception when calling DatasetManagementApi->get_dataset_item_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_get: %s\n" % e)
  269 +```
  270 +
  271 +
  272 +
  273 +### Parameters
  274 +
  275 +
  276 +Name | Type | Description | Notes
  277 +------------- | ------------- | ------------- | -------------
  278 + **user_id** | **int**| |
  279 + **user_type_id** | **int**| |
  280 + **dataset_id** | **int**| |
  281 + **dataset_entity_id** | **str**| |
  282 +
  283 +### Return type
  284 +
  285 +[**DatasetEntityDetails**](DatasetEntityDetails.md)
  286 +
  287 +### Authorization
  288 +
  289 +No authorization required
  290 +
  291 +### HTTP request headers
  292 +
  293 + - **Content-Type**: Not defined
  294 + - **Accept**: application/json
  295 +
  296 +### HTTP response details
  297 +
  298 +| Status code | Description | Response headers |
  299 +|-------------|-------------|------------------|
  300 +**200** | Successful Response | - |
  301 +**422** | Validation Error | - |
  302 +
  303 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  304 +
  305 +# **get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get**
  306 +> object get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get(user_id, user_type_id, dataset_id, file_id)
  307 +
  308 +Get Entity File
  309 +
  310 +### Example
  311 +
  312 +
  313 +```python
  314 +import openapi_client
  315 +from openapi_client.rest import ApiException
  316 +from pprint import pprint
  317 +
  318 +# Defining the host is optional and defaults to http://localhost
  319 +# See configuration.py for a list of all supported configuration parameters.
  320 +configuration = openapi_client.Configuration(
  321 + host = "http://localhost"
  322 +)
  323 +
  324 +
  325 +# Enter a context with an instance of the API client
  326 +with openapi_client.ApiClient(configuration) as api_client:
  327 + # Create an instance of the API class
  328 + api_instance = openapi_client.DatasetManagementApi(api_client)
  329 + user_id = 56 # int |
  330 + user_type_id = 56 # int |
  331 + dataset_id = 56 # int |
  332 + file_id = 'file_id_example' # str |
  333 +
  334 + try:
  335 + # Get Entity File
  336 + api_response = api_instance.get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get(user_id, user_type_id, dataset_id, file_id)
  337 + print("The response of DatasetManagementApi->get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get:\n")
  338 + pprint(api_response)
  339 + except Exception as e:
  340 + print("Exception when calling DatasetManagementApi->get_entity_file_datasets_dataset_entities_files_user_id_user_type_id_dataset_id_file_id_get: %s\n" % e)
  341 +```
  342 +
  343 +
  344 +
  345 +### Parameters
  346 +
  347 +
  348 +Name | Type | Description | Notes
  349 +------------- | ------------- | ------------- | -------------
  350 + **user_id** | **int**| |
  351 + **user_type_id** | **int**| |
  352 + **dataset_id** | **int**| |
  353 + **file_id** | **str**| |
  354 +
  355 +### Return type
  356 +
  357 +**object**
  358 +
  359 +### Authorization
  360 +
  361 +No authorization required
  362 +
  363 +### HTTP request headers
  364 +
  365 + - **Content-Type**: Not defined
  366 + - **Accept**: application/json
  367 +
  368 +### HTTP response details
  369 +
  370 +| Status code | Description | Response headers |
  371 +|-------------|-------------|------------------|
  372 +**200** | Successful Response | - |
  373 +**422** | Validation Error | - |
  374 +
  375 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  376 +
  377 +# **get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get**
  378 +> object get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get(user_id, user_type_id, dataset_id, file_id)
  379 +
  380 +Get Thumbnail
  381 +
  382 +### Example
  383 +
  384 +
  385 +```python
  386 +import openapi_client
  387 +from openapi_client.rest import ApiException
  388 +from pprint import pprint
  389 +
  390 +# Defining the host is optional and defaults to http://localhost
  391 +# See configuration.py for a list of all supported configuration parameters.
  392 +configuration = openapi_client.Configuration(
  393 + host = "http://localhost"
  394 +)
  395 +
  396 +
  397 +# Enter a context with an instance of the API client
  398 +with openapi_client.ApiClient(configuration) as api_client:
  399 + # Create an instance of the API class
  400 + api_instance = openapi_client.DatasetManagementApi(api_client)
  401 + user_id = 56 # int |
  402 + user_type_id = 56 # int |
  403 + dataset_id = 56 # int |
  404 + file_id = 'file_id_example' # str |
  405 +
  406 + try:
  407 + # Get Thumbnail
  408 + api_response = api_instance.get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get(user_id, user_type_id, dataset_id, file_id)
  409 + print("The response of DatasetManagementApi->get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get:\n")
  410 + pprint(api_response)
  411 + except Exception as e:
  412 + print("Exception when calling DatasetManagementApi->get_thumbnail_datasets_dataset_entities_thumbnail_user_id_user_type_id_dataset_id_file_id_get: %s\n" % e)
  413 +```
  414 +
  415 +
  416 +
  417 +### Parameters
  418 +
  419 +
  420 +Name | Type | Description | Notes
  421 +------------- | ------------- | ------------- | -------------
  422 + **user_id** | **int**| |
  423 + **user_type_id** | **int**| |
  424 + **dataset_id** | **int**| |
  425 + **file_id** | **str**| |
  426 +
  427 +### Return type
  428 +
  429 +**object**
  430 +
  431 +### Authorization
  432 +
  433 +No authorization required
  434 +
  435 +### HTTP request headers
  436 +
  437 + - **Content-Type**: Not defined
  438 + - **Accept**: application/json
  439 +
  440 +### HTTP response details
  441 +
  442 +| Status code | Description | Response headers |
  443 +|-------------|-------------|------------------|
  444 +**200** | Successful Response | - |
  445 +**422** | Validation Error | - |
  446 +
  447 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  448 +
  449 +# **get_user_datasets_datasets_user_id_user_type_id_get**
  450 +> List[DatasetDetails] get_user_datasets_datasets_user_id_user_type_id_get(user_id, user_type_id)
  451 +
  452 +Get User Datasets
  453 +
  454 +### Example
  455 +
  456 +
  457 +```python
  458 +import openapi_client
  459 +from openapi_client.models.dataset_details import DatasetDetails
  460 +from openapi_client.rest import ApiException
  461 +from pprint import pprint
  462 +
  463 +# Defining the host is optional and defaults to http://localhost
  464 +# See configuration.py for a list of all supported configuration parameters.
  465 +configuration = openapi_client.Configuration(
  466 + host = "http://localhost"
  467 +)
  468 +
  469 +
  470 +# Enter a context with an instance of the API client
  471 +with openapi_client.ApiClient(configuration) as api_client:
  472 + # Create an instance of the API class
  473 + api_instance = openapi_client.DatasetManagementApi(api_client)
  474 + user_id = 56 # int |
  475 + user_type_id = 56 # int |
  476 +
  477 + try:
  478 + # Get User Datasets
  479 + api_response = api_instance.get_user_datasets_datasets_user_id_user_type_id_get(user_id, user_type_id)
  480 + print("The response of DatasetManagementApi->get_user_datasets_datasets_user_id_user_type_id_get:\n")
  481 + pprint(api_response)
  482 + except Exception as e:
  483 + print("Exception when calling DatasetManagementApi->get_user_datasets_datasets_user_id_user_type_id_get: %s\n" % e)
  484 +```
  485 +
  486 +
  487 +
  488 +### Parameters
  489 +
  490 +
  491 +Name | Type | Description | Notes
  492 +------------- | ------------- | ------------- | -------------
  493 + **user_id** | **int**| |
  494 + **user_type_id** | **int**| |
  495 +
  496 +### Return type
  497 +
  498 +[**List[DatasetDetails]**](DatasetDetails.md)
  499 +
  500 +### Authorization
  501 +
  502 +No authorization required
  503 +
  504 +### HTTP request headers
  505 +
  506 + - **Content-Type**: Not defined
  507 + - **Accept**: application/json
  508 +
  509 +### HTTP response details
  510 +
  511 +| Status code | Description | Response headers |
  512 +|-------------|-------------|------------------|
  513 +**200** | Successful Response | - |
  514 +**422** | Validation Error | - |
  515 +
  516 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  517 +
  518 +# **new_dataset_datasets_user_id_user_type_id_post**
  519 +> object new_dataset_datasets_user_id_user_type_id_post(user_id, user_type_id, new_dataset)
  520 +
  521 +New Dataset
  522 +
  523 +### Example
  524 +
  525 +
  526 +```python
  527 +import openapi_client
  528 +from openapi_client.models.new_dataset import NewDataset
  529 +from openapi_client.rest import ApiException
  530 +from pprint import pprint
  531 +
  532 +# Defining the host is optional and defaults to http://localhost
  533 +# See configuration.py for a list of all supported configuration parameters.
  534 +configuration = openapi_client.Configuration(
  535 + host = "http://localhost"
  536 +)
  537 +
  538 +
  539 +# Enter a context with an instance of the API client
  540 +with openapi_client.ApiClient(configuration) as api_client:
  541 + # Create an instance of the API class
  542 + api_instance = openapi_client.DatasetManagementApi(api_client)
  543 + user_id = 56 # int |
  544 + user_type_id = 56 # int |
  545 + new_dataset = openapi_client.NewDataset() # NewDataset |
  546 +
  547 + try:
  548 + # New Dataset
  549 + api_response = api_instance.new_dataset_datasets_user_id_user_type_id_post(user_id, user_type_id, new_dataset)
  550 + print("The response of DatasetManagementApi->new_dataset_datasets_user_id_user_type_id_post:\n")
  551 + pprint(api_response)
  552 + except Exception as e:
  553 + print("Exception when calling DatasetManagementApi->new_dataset_datasets_user_id_user_type_id_post: %s\n" % e)
  554 +```
  555 +
  556 +
  557 +
  558 +### Parameters
  559 +
  560 +
  561 +Name | Type | Description | Notes
  562 +------------- | ------------- | ------------- | -------------
  563 + **user_id** | **int**| |
  564 + **user_type_id** | **int**| |
  565 + **new_dataset** | [**NewDataset**](NewDataset.md)| |
  566 +
  567 +### Return type
  568 +
  569 +**object**
  570 +
  571 +### Authorization
  572 +
  573 +No authorization required
  574 +
  575 +### HTTP request headers
  576 +
  577 + - **Content-Type**: application/json
  578 + - **Accept**: application/json
  579 +
  580 +### HTTP response details
  581 +
  582 +| Status code | Description | Response headers |
  583 +|-------------|-------------|------------------|
  584 +**200** | Successful Response | - |
  585 +**422** | Validation Error | - |
  586 +
  587 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  588 +
  589 +# **new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post**
  590 +> object new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post(user_id, user_type_id, new_dataset_entity, files)
  591 +
  592 +New Dataset Entity
  593 +
  594 +### Example
  595 +
  596 +
  597 +```python
  598 +import openapi_client
  599 +from openapi_client.models.new_dataset_entity import NewDatasetEntity
  600 +from openapi_client.rest import ApiException
  601 +from pprint import pprint
  602 +
  603 +# Defining the host is optional and defaults to http://localhost
  604 +# See configuration.py for a list of all supported configuration parameters.
  605 +configuration = openapi_client.Configuration(
  606 + host = "http://localhost"
  607 +)
  608 +
  609 +
  610 +# Enter a context with an instance of the API client
  611 +with openapi_client.ApiClient(configuration) as api_client:
  612 + # Create an instance of the API class
  613 + api_instance = openapi_client.DatasetManagementApi(api_client)
  614 + user_id = 56 # int |
  615 + user_type_id = 56 # int |
  616 + new_dataset_entity = openapi_client.NewDatasetEntity() # NewDatasetEntity |
  617 + files = None # List[bytearray] |
  618 +
  619 + try:
  620 + # New Dataset Entity
  621 + api_response = api_instance.new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post(user_id, user_type_id, new_dataset_entity, files)
  622 + print("The response of DatasetManagementApi->new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post:\n")
  623 + pprint(api_response)
  624 + except Exception as e:
  625 + print("Exception when calling DatasetManagementApi->new_dataset_entity_datasets_dataset_entities_user_id_user_type_id_post: %s\n" % e)
  626 +```
  627 +
  628 +
  629 +
  630 +### Parameters
  631 +
  632 +
  633 +Name | Type | Description | Notes
  634 +------------- | ------------- | ------------- | -------------
  635 + **user_id** | **int**| |
  636 + **user_type_id** | **int**| |
  637 + **new_dataset_entity** | [**NewDatasetEntity**](NewDatasetEntity.md)| |
  638 + **files** | **List[bytearray]**| |
  639 +
  640 +### Return type
  641 +
  642 +**object**
  643 +
  644 +### Authorization
  645 +
  646 +No authorization required
  647 +
  648 +### HTTP request headers
  649 +
  650 + - **Content-Type**: multipart/form-data
  651 + - **Accept**: application/json
  652 +
  653 +### HTTP response details
  654 +
  655 +| Status code | Description | Response headers |
  656 +|-------------|-------------|------------------|
  657 +**200** | Successful Response | - |
  658 +**422** | Validation Error | - |
  659 +
  660 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  661 +
  662 +# **recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post**
  663 +> object recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post(user_id, user_type_id, request_body)
  664 +
  665 +Recover Dataset Entities
  666 +
  667 +### Example
  668 +
  669 +
  670 +```python
  671 +import openapi_client
  672 +from openapi_client.rest import ApiException
  673 +from pprint import pprint
  674 +
  675 +# Defining the host is optional and defaults to http://localhost
  676 +# See configuration.py for a list of all supported configuration parameters.
  677 +configuration = openapi_client.Configuration(
  678 + host = "http://localhost"
  679 +)
  680 +
  681 +
  682 +# Enter a context with an instance of the API client
  683 +with openapi_client.ApiClient(configuration) as api_client:
  684 + # Create an instance of the API class
  685 + api_instance = openapi_client.DatasetManagementApi(api_client)
  686 + user_id = 56 # int |
  687 + user_type_id = 56 # int |
  688 + request_body = ['request_body_example'] # List[str] |
  689 +
  690 + try:
  691 + # Recover Dataset Entities
  692 + api_response = api_instance.recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post(user_id, user_type_id, request_body)
  693 + print("The response of DatasetManagementApi->recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post:\n")
  694 + pprint(api_response)
  695 + except Exception as e:
  696 + print("Exception when calling DatasetManagementApi->recover_dataset_entities_datasets_dataset_entities_recover_user_id_user_type_id_post: %s\n" % e)
  697 +```
  698 +
  699 +
  700 +
  701 +### Parameters
  702 +
  703 +
  704 +Name | Type | Description | Notes
  705 +------------- | ------------- | ------------- | -------------
  706 + **user_id** | **int**| |
  707 + **user_type_id** | **int**| |
  708 + **request_body** | [**List[str]**](str.md)| |
  709 +
  710 +### Return type
  711 +
  712 +**object**
  713 +
  714 +### Authorization
  715 +
  716 +No authorization required
  717 +
  718 +### HTTP request headers
  719 +
  720 + - **Content-Type**: application/json
  721 + - **Accept**: application/json
  722 +
  723 +### HTTP response details
  724 +
  725 +| Status code | Description | Response headers |
  726 +|-------------|-------------|------------------|
  727 +**200** | Successful Response | - |
  728 +**422** | Validation Error | - |
  729 +
  730 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  731 +
  732 +# **update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put**
  733 +> object update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put(user_id, user_type_id, dataset_id, dataset_entity_id, update_dataset_entity, files)
  734 +
  735 +Update Dataset Entity
  736 +
  737 +### Example
  738 +
  739 +
  740 +```python
  741 +import openapi_client
  742 +from openapi_client.models.update_dataset_entity import UpdateDatasetEntity
  743 +from openapi_client.rest import ApiException
  744 +from pprint import pprint
  745 +
  746 +# Defining the host is optional and defaults to http://localhost
  747 +# See configuration.py for a list of all supported configuration parameters.
  748 +configuration = openapi_client.Configuration(
  749 + host = "http://localhost"
  750 +)
  751 +
  752 +
  753 +# Enter a context with an instance of the API client
  754 +with openapi_client.ApiClient(configuration) as api_client:
  755 + # Create an instance of the API class
  756 + api_instance = openapi_client.DatasetManagementApi(api_client)
  757 + user_id = 56 # int |
  758 + user_type_id = 56 # int |
  759 + dataset_id = 56 # int |
  760 + dataset_entity_id = 'dataset_entity_id_example' # str |
  761 + update_dataset_entity = openapi_client.UpdateDatasetEntity() # UpdateDatasetEntity |
  762 + files = None # List[bytearray] |
  763 +
  764 + try:
  765 + # Update Dataset Entity
  766 + api_response = api_instance.update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put(user_id, user_type_id, dataset_id, dataset_entity_id, update_dataset_entity, files)
  767 + print("The response of DatasetManagementApi->update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put:\n")
  768 + pprint(api_response)
  769 + except Exception as e:
  770 + print("Exception when calling DatasetManagementApi->update_dataset_entity_datasets_dataset_entities_user_id_user_type_id_dataset_id_dataset_entity_id_put: %s\n" % e)
  771 +```
  772 +
  773 +
  774 +
  775 +### Parameters
  776 +
  777 +
  778 +Name | Type | Description | Notes
  779 +------------- | ------------- | ------------- | -------------
  780 + **user_id** | **int**| |
  781 + **user_type_id** | **int**| |
  782 + **dataset_id** | **int**| |
  783 + **dataset_entity_id** | **str**| |
  784 + **update_dataset_entity** | [**UpdateDatasetEntity**](UpdateDatasetEntity.md)| |
  785 + **files** | **List[bytearray]**| |
  786 +
  787 +### Return type
  788 +
  789 +**object**
  790 +
  791 +### Authorization
  792 +
  793 +No authorization required
  794 +
  795 +### HTTP request headers
  796 +
  797 + - **Content-Type**: multipart/form-data
  798 + - **Accept**: application/json
  799 +
  800 +### HTTP response details
  801 +
  802 +| Status code | Description | Response headers |
  803 +|-------------|-------------|------------------|
  804 +**200** | Successful Response | - |
  805 +**422** | Validation Error | - |
  806 +
  807 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  808 +
... ...
  1 +# DeleteDatasetEntities
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**dataset_entity_ids** | **List[str]** | |
  9 +**remark** | **str** | |
  10 +
  11 +## Example
  12 +
  13 +```python
  14 +from openapi_client.models.delete_dataset_entities import DeleteDatasetEntities
  15 +
  16 +# TODO update the JSON string below
  17 +json = "{}"
  18 +# create an instance of DeleteDatasetEntities from a JSON string
  19 +delete_dataset_entities_instance = DeleteDatasetEntities.from_json(json)
  20 +# print the JSON string representation of the object
  21 +print(DeleteDatasetEntities.to_json())
  22 +
  23 +# convert the object into a dict
  24 +delete_dataset_entities_dict = delete_dataset_entities_instance.to_dict()
  25 +# create an instance of DeleteDatasetEntities from a dict
  26 +delete_dataset_entities_from_dict = DeleteDatasetEntities.from_dict(delete_dataset_entities_dict)
  27 +```
  28 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  29 +
  30 +
... ...
  1 +# EntityFileDetails
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**file_id** | **str** | |
  9 +**file_name** | **str** | |
  10 +**content_type** | **str** | |
  11 +**thumbnail_file** | **str** | |
  12 +
  13 +## Example
  14 +
  15 +```python
  16 +from openapi_client.models.entity_file_details import EntityFileDetails
  17 +
  18 +# TODO update the JSON string below
  19 +json = "{}"
  20 +# create an instance of EntityFileDetails from a JSON string
  21 +entity_file_details_instance = EntityFileDetails.from_json(json)
  22 +# print the JSON string representation of the object
  23 +print(EntityFileDetails.to_json())
  24 +
  25 +# convert the object into a dict
  26 +entity_file_details_dict = entity_file_details_instance.to_dict()
  27 +# create an instance of EntityFileDetails from a dict
  28 +entity_file_details_from_dict = EntityFileDetails.from_dict(entity_file_details_dict)
  29 +```
  30 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  31 +
  32 +
... ...
  1 +# ForgotPassword
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**login_id** | **str** | |
  9 +
  10 +## Example
  11 +
  12 +```python
  13 +from openapi_client.models.forgot_password import ForgotPassword
  14 +
  15 +# TODO update the JSON string below
  16 +json = "{}"
  17 +# create an instance of ForgotPassword from a JSON string
  18 +forgot_password_instance = ForgotPassword.from_json(json)
  19 +# print the JSON string representation of the object
  20 +print(ForgotPassword.to_json())
  21 +
  22 +# convert the object into a dict
  23 +forgot_password_dict = forgot_password_instance.to_dict()
  24 +# create an instance of ForgotPassword from a dict
  25 +forgot_password_from_dict = ForgotPassword.from_dict(forgot_password_dict)
  26 +```
  27 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  28 +
  29 +
... ...
  1 +# HTTPValidationError
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**detail** | [**List[ValidationError]**](ValidationError.md) | | [optional]
  9 +
  10 +## Example
  11 +
  12 +```python
  13 +from openapi_client.models.http_validation_error import HTTPValidationError
  14 +
  15 +# TODO update the JSON string below
  16 +json = "{}"
  17 +# create an instance of HTTPValidationError from a JSON string
  18 +http_validation_error_instance = HTTPValidationError.from_json(json)
  19 +# print the JSON string representation of the object
  20 +print(HTTPValidationError.to_json())
  21 +
  22 +# convert the object into a dict
  23 +http_validation_error_dict = http_validation_error_instance.to_dict()
  24 +# create an instance of HTTPValidationError from a dict
  25 +http_validation_error_from_dict = HTTPValidationError.from_dict(http_validation_error_dict)
  26 +```
  27 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  28 +
  29 +
... ...
  1 +# LocationDetails
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**location_name** | **str** | |
  9 +**user_id** | **int** | | [optional]
  10 +**lat** | **float** | |
  11 +**long** | **float** | |
  12 +**details** | **object** | |
  13 +**location_id** | **int** | |
  14 +
  15 +## Example
  16 +
  17 +```python
  18 +from openapi_client.models.location_details import LocationDetails
  19 +
  20 +# TODO update the JSON string below
  21 +json = "{}"
  22 +# create an instance of LocationDetails from a JSON string
  23 +location_details_instance = LocationDetails.from_json(json)
  24 +# print the JSON string representation of the object
  25 +print(LocationDetails.to_json())
  26 +
  27 +# convert the object into a dict
  28 +location_details_dict = location_details_instance.to_dict()
  29 +# create an instance of LocationDetails from a dict
  30 +location_details_from_dict = LocationDetails.from_dict(location_details_dict)
  31 +```
  32 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  33 +
  34 +
... ...
  1 +# openapi_client.LocationManagementApi
  2 +
  3 +All URIs are relative to *http://localhost*
  4 +
  5 +Method | HTTP request | Description
  6 +------------- | ------------- | -------------
  7 +[**delete_location_locations_user_id_user_type_id_location_id_delete**](LocationManagementApi.md#delete_location_locations_user_id_user_type_id_location_id_delete) | **DELETE** /locations/{user_id}/{user_type_id}/{location_id} | Delete Location
  8 +[**get_user_locations_locations_user_id_user_type_id_get**](LocationManagementApi.md#get_user_locations_locations_user_id_user_type_id_get) | **GET** /locations/{user_id}/{user_type_id} | Get User Locations
  9 +[**new_location_locations_user_id_user_type_id_post**](LocationManagementApi.md#new_location_locations_user_id_user_type_id_post) | **POST** /locations/{user_id}/{user_type_id} | New Location
  10 +[**recover_location_locations_user_id_user_type_id_location_id_put**](LocationManagementApi.md#recover_location_locations_user_id_user_type_id_location_id_put) | **PUT** /locations/{user_id}/{user_type_id}/{location_id} | Recover Location
  11 +[**update_location_locations_user_id_user_type_id_put**](LocationManagementApi.md#update_location_locations_user_id_user_type_id_put) | **PUT** /locations/{user_id}/{user_type_id} | Update Location
  12 +
  13 +
  14 +# **delete_location_locations_user_id_user_type_id_location_id_delete**
  15 +> object delete_location_locations_user_id_user_type_id_location_id_delete(user_id, user_type_id, location_id)
  16 +
  17 +Delete Location
  18 +
  19 +### Example
  20 +
  21 +
  22 +```python
  23 +import openapi_client
  24 +from openapi_client.rest import ApiException
  25 +from pprint import pprint
  26 +
  27 +# Defining the host is optional and defaults to http://localhost
  28 +# See configuration.py for a list of all supported configuration parameters.
  29 +configuration = openapi_client.Configuration(
  30 + host = "http://localhost"
  31 +)
  32 +
  33 +
  34 +# Enter a context with an instance of the API client
  35 +with openapi_client.ApiClient(configuration) as api_client:
  36 + # Create an instance of the API class
  37 + api_instance = openapi_client.LocationManagementApi(api_client)
  38 + user_id = 56 # int |
  39 + user_type_id = 56 # int |
  40 + location_id = 56 # int |
  41 +
  42 + try:
  43 + # Delete Location
  44 + api_response = api_instance.delete_location_locations_user_id_user_type_id_location_id_delete(user_id, user_type_id, location_id)
  45 + print("The response of LocationManagementApi->delete_location_locations_user_id_user_type_id_location_id_delete:\n")
  46 + pprint(api_response)
  47 + except Exception as e:
  48 + print("Exception when calling LocationManagementApi->delete_location_locations_user_id_user_type_id_location_id_delete: %s\n" % e)
  49 +```
  50 +
  51 +
  52 +
  53 +### Parameters
  54 +
  55 +
  56 +Name | Type | Description | Notes
  57 +------------- | ------------- | ------------- | -------------
  58 + **user_id** | **int**| |
  59 + **user_type_id** | **int**| |
  60 + **location_id** | **int**| |
  61 +
  62 +### Return type
  63 +
  64 +**object**
  65 +
  66 +### Authorization
  67 +
  68 +No authorization required
  69 +
  70 +### HTTP request headers
  71 +
  72 + - **Content-Type**: Not defined
  73 + - **Accept**: application/json
  74 +
  75 +### HTTP response details
  76 +
  77 +| Status code | Description | Response headers |
  78 +|-------------|-------------|------------------|
  79 +**200** | Successful Response | - |
  80 +**422** | Validation Error | - |
  81 +
  82 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  83 +
  84 +# **get_user_locations_locations_user_id_user_type_id_get**
  85 +> List[LocationDetails] get_user_locations_locations_user_id_user_type_id_get(user_id, user_type_id)
  86 +
  87 +Get User Locations
  88 +
  89 +### Example
  90 +
  91 +
  92 +```python
  93 +import openapi_client
  94 +from openapi_client.models.location_details import LocationDetails
  95 +from openapi_client.rest import ApiException
  96 +from pprint import pprint
  97 +
  98 +# Defining the host is optional and defaults to http://localhost
  99 +# See configuration.py for a list of all supported configuration parameters.
  100 +configuration = openapi_client.Configuration(
  101 + host = "http://localhost"
  102 +)
  103 +
  104 +
  105 +# Enter a context with an instance of the API client
  106 +with openapi_client.ApiClient(configuration) as api_client:
  107 + # Create an instance of the API class
  108 + api_instance = openapi_client.LocationManagementApi(api_client)
  109 + user_id = 56 # int |
  110 + user_type_id = 56 # int |
  111 +
  112 + try:
  113 + # Get User Locations
  114 + api_response = api_instance.get_user_locations_locations_user_id_user_type_id_get(user_id, user_type_id)
  115 + print("The response of LocationManagementApi->get_user_locations_locations_user_id_user_type_id_get:\n")
  116 + pprint(api_response)
  117 + except Exception as e:
  118 + print("Exception when calling LocationManagementApi->get_user_locations_locations_user_id_user_type_id_get: %s\n" % e)
  119 +```
  120 +
  121 +
  122 +
  123 +### Parameters
  124 +
  125 +
  126 +Name | Type | Description | Notes
  127 +------------- | ------------- | ------------- | -------------
  128 + **user_id** | **int**| |
  129 + **user_type_id** | **int**| |
  130 +
  131 +### Return type
  132 +
  133 +[**List[LocationDetails]**](LocationDetails.md)
  134 +
  135 +### Authorization
  136 +
  137 +No authorization required
  138 +
  139 +### HTTP request headers
  140 +
  141 + - **Content-Type**: Not defined
  142 + - **Accept**: application/json
  143 +
  144 +### HTTP response details
  145 +
  146 +| Status code | Description | Response headers |
  147 +|-------------|-------------|------------------|
  148 +**200** | Successful Response | - |
  149 +**422** | Validation Error | - |
  150 +
  151 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  152 +
  153 +# **new_location_locations_user_id_user_type_id_post**
  154 +> object new_location_locations_user_id_user_type_id_post(user_id, user_type_id, new_location)
  155 +
  156 +New Location
  157 +
  158 +### Example
  159 +
  160 +
  161 +```python
  162 +import openapi_client
  163 +from openapi_client.models.new_location import NewLocation
  164 +from openapi_client.rest import ApiException
  165 +from pprint import pprint
  166 +
  167 +# Defining the host is optional and defaults to http://localhost
  168 +# See configuration.py for a list of all supported configuration parameters.
  169 +configuration = openapi_client.Configuration(
  170 + host = "http://localhost"
  171 +)
  172 +
  173 +
  174 +# Enter a context with an instance of the API client
  175 +with openapi_client.ApiClient(configuration) as api_client:
  176 + # Create an instance of the API class
  177 + api_instance = openapi_client.LocationManagementApi(api_client)
  178 + user_id = 56 # int |
  179 + user_type_id = 56 # int |
  180 + new_location = openapi_client.NewLocation() # NewLocation |
  181 +
  182 + try:
  183 + # New Location
  184 + api_response = api_instance.new_location_locations_user_id_user_type_id_post(user_id, user_type_id, new_location)
  185 + print("The response of LocationManagementApi->new_location_locations_user_id_user_type_id_post:\n")
  186 + pprint(api_response)
  187 + except Exception as e:
  188 + print("Exception when calling LocationManagementApi->new_location_locations_user_id_user_type_id_post: %s\n" % e)
  189 +```
  190 +
  191 +
  192 +
  193 +### Parameters
  194 +
  195 +
  196 +Name | Type | Description | Notes
  197 +------------- | ------------- | ------------- | -------------
  198 + **user_id** | **int**| |
  199 + **user_type_id** | **int**| |
  200 + **new_location** | [**NewLocation**](NewLocation.md)| |
  201 +
  202 +### Return type
  203 +
  204 +**object**
  205 +
  206 +### Authorization
  207 +
  208 +No authorization required
  209 +
  210 +### HTTP request headers
  211 +
  212 + - **Content-Type**: application/json
  213 + - **Accept**: application/json
  214 +
  215 +### HTTP response details
  216 +
  217 +| Status code | Description | Response headers |
  218 +|-------------|-------------|------------------|
  219 +**200** | Successful Response | - |
  220 +**422** | Validation Error | - |
  221 +
  222 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  223 +
  224 +# **recover_location_locations_user_id_user_type_id_location_id_put**
  225 +> object recover_location_locations_user_id_user_type_id_location_id_put(user_id, user_type_id, location_id)
  226 +
  227 +Recover Location
  228 +
  229 +### Example
  230 +
  231 +
  232 +```python
  233 +import openapi_client
  234 +from openapi_client.rest import ApiException
  235 +from pprint import pprint
  236 +
  237 +# Defining the host is optional and defaults to http://localhost
  238 +# See configuration.py for a list of all supported configuration parameters.
  239 +configuration = openapi_client.Configuration(
  240 + host = "http://localhost"
  241 +)
  242 +
  243 +
  244 +# Enter a context with an instance of the API client
  245 +with openapi_client.ApiClient(configuration) as api_client:
  246 + # Create an instance of the API class
  247 + api_instance = openapi_client.LocationManagementApi(api_client)
  248 + user_id = 56 # int |
  249 + user_type_id = 56 # int |
  250 + location_id = 56 # int |
  251 +
  252 + try:
  253 + # Recover Location
  254 + api_response = api_instance.recover_location_locations_user_id_user_type_id_location_id_put(user_id, user_type_id, location_id)
  255 + print("The response of LocationManagementApi->recover_location_locations_user_id_user_type_id_location_id_put:\n")
  256 + pprint(api_response)
  257 + except Exception as e:
  258 + print("Exception when calling LocationManagementApi->recover_location_locations_user_id_user_type_id_location_id_put: %s\n" % e)
  259 +```
  260 +
  261 +
  262 +
  263 +### Parameters
  264 +
  265 +
  266 +Name | Type | Description | Notes
  267 +------------- | ------------- | ------------- | -------------
  268 + **user_id** | **int**| |
  269 + **user_type_id** | **int**| |
  270 + **location_id** | **int**| |
  271 +
  272 +### Return type
  273 +
  274 +**object**
  275 +
  276 +### Authorization
  277 +
  278 +No authorization required
  279 +
  280 +### HTTP request headers
  281 +
  282 + - **Content-Type**: Not defined
  283 + - **Accept**: application/json
  284 +
  285 +### HTTP response details
  286 +
  287 +| Status code | Description | Response headers |
  288 +|-------------|-------------|------------------|
  289 +**200** | Successful Response | - |
  290 +**422** | Validation Error | - |
  291 +
  292 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  293 +
  294 +# **update_location_locations_user_id_user_type_id_put**
  295 +> object update_location_locations_user_id_user_type_id_put(user_id, user_type_id, update_location)
  296 +
  297 +Update Location
  298 +
  299 +### Example
  300 +
  301 +
  302 +```python
  303 +import openapi_client
  304 +from openapi_client.models.update_location import UpdateLocation
  305 +from openapi_client.rest import ApiException
  306 +from pprint import pprint
  307 +
  308 +# Defining the host is optional and defaults to http://localhost
  309 +# See configuration.py for a list of all supported configuration parameters.
  310 +configuration = openapi_client.Configuration(
  311 + host = "http://localhost"
  312 +)
  313 +
  314 +
  315 +# Enter a context with an instance of the API client
  316 +with openapi_client.ApiClient(configuration) as api_client:
  317 + # Create an instance of the API class
  318 + api_instance = openapi_client.LocationManagementApi(api_client)
  319 + user_id = 56 # int |
  320 + user_type_id = 56 # int |
  321 + update_location = openapi_client.UpdateLocation() # UpdateLocation |
  322 +
  323 + try:
  324 + # Update Location
  325 + api_response = api_instance.update_location_locations_user_id_user_type_id_put(user_id, user_type_id, update_location)
  326 + print("The response of LocationManagementApi->update_location_locations_user_id_user_type_id_put:\n")
  327 + pprint(api_response)
  328 + except Exception as e:
  329 + print("Exception when calling LocationManagementApi->update_location_locations_user_id_user_type_id_put: %s\n" % e)
  330 +```
  331 +
  332 +
  333 +
  334 +### Parameters
  335 +
  336 +
  337 +Name | Type | Description | Notes
  338 +------------- | ------------- | ------------- | -------------
  339 + **user_id** | **int**| |
  340 + **user_type_id** | **int**| |
  341 + **update_location** | [**UpdateLocation**](UpdateLocation.md)| |
  342 +
  343 +### Return type
  344 +
  345 +**object**
  346 +
  347 +### Authorization
  348 +
  349 +No authorization required
  350 +
  351 +### HTTP request headers
  352 +
  353 + - **Content-Type**: application/json
  354 + - **Accept**: application/json
  355 +
  356 +### HTTP response details
  357 +
  358 +| Status code | Description | Response headers |
  359 +|-------------|-------------|------------------|
  360 +**200** | Successful Response | - |
  361 +**422** | Validation Error | - |
  362 +
  363 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  364 +
... ...
  1 +# NewDataset
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**user_id** | **int** | | [optional] [default to 0]
  9 +**dataset_name** | **str** | |
  10 +**dataset_type** | **int** | | [optional]
  11 +**dataset_short_info** | **str** | | [optional]
  12 +**dataset_tags** | **str** | | [optional]
  13 +
  14 +## Example
  15 +
  16 +```python
  17 +from openapi_client.models.new_dataset import NewDataset
  18 +
  19 +# TODO update the JSON string below
  20 +json = "{}"
  21 +# create an instance of NewDataset from a JSON string
  22 +new_dataset_instance = NewDataset.from_json(json)
  23 +# print the JSON string representation of the object
  24 +print(NewDataset.to_json())
  25 +
  26 +# convert the object into a dict
  27 +new_dataset_dict = new_dataset_instance.to_dict()
  28 +# create an instance of NewDataset from a dict
  29 +new_dataset_from_dict = NewDataset.from_dict(new_dataset_dict)
  30 +```
  31 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  32 +
  33 +
... ...
  1 +# NewDatasetEntity
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**dataset_id** | **int** | |
  9 +**user_id** | **int** | |
  10 +**ds_entity_name** | **str** | |
  11 +**entity_source** | **str** | | [optional]
  12 +**collected_on** | **datetime** | |
  13 +**labeling_algo** | **str** | | [optional]
  14 +**ds_entity_info** | **object** | |
  15 +**location_id** | **int** | |
  16 +
  17 +## Example
  18 +
  19 +```python
  20 +from openapi_client.models.new_dataset_entity import NewDatasetEntity
  21 +
  22 +# TODO update the JSON string below
  23 +json = "{}"
  24 +# create an instance of NewDatasetEntity from a JSON string
  25 +new_dataset_entity_instance = NewDatasetEntity.from_json(json)
  26 +# print the JSON string representation of the object
  27 +print(NewDatasetEntity.to_json())
  28 +
  29 +# convert the object into a dict
  30 +new_dataset_entity_dict = new_dataset_entity_instance.to_dict()
  31 +# create an instance of NewDatasetEntity from a dict
  32 +new_dataset_entity_from_dict = NewDatasetEntity.from_dict(new_dataset_entity_dict)
  33 +```
  34 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  35 +
  36 +
... ...
  1 +# NewLocation
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**location_name** | **str** | |
  9 +**user_id** | **int** | | [optional]
  10 +**lat** | **float** | |
  11 +**long** | **float** | |
  12 +**details** | **object** | |
  13 +
  14 +## Example
  15 +
  16 +```python
  17 +from openapi_client.models.new_location import NewLocation
  18 +
  19 +# TODO update the JSON string below
  20 +json = "{}"
  21 +# create an instance of NewLocation from a JSON string
  22 +new_location_instance = NewLocation.from_json(json)
  23 +# print the JSON string representation of the object
  24 +print(NewLocation.to_json())
  25 +
  26 +# convert the object into a dict
  27 +new_location_dict = new_location_instance.to_dict()
  28 +# create an instance of NewLocation from a dict
  29 +new_location_from_dict = NewLocation.from_dict(new_location_dict)
  30 +```
  31 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  32 +
  33 +
... ...
  1 +# NewSession
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**login_id** | **str** | |
  9 +**passwd** | **str** | |
  10 +**ip_address** | **str** | | [optional] [default to '127.0.0.1']
  11 +
  12 +## Example
  13 +
  14 +```python
  15 +from openapi_client.models.new_session import NewSession
  16 +
  17 +# TODO update the JSON string below
  18 +json = "{}"
  19 +# create an instance of NewSession from a JSON string
  20 +new_session_instance = NewSession.from_json(json)
  21 +# print the JSON string representation of the object
  22 +print(NewSession.to_json())
  23 +
  24 +# convert the object into a dict
  25 +new_session_dict = new_session_instance.to_dict()
  26 +# create an instance of NewSession from a dict
  27 +new_session_from_dict = NewSession.from_dict(new_session_dict)
  28 +```
  29 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  30 +
  31 +
... ...
  1 +# NewStudent
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**first_name** | **str** | |
  9 +**middle_name** | **str** | |
  10 +**last_name** | **str** | |
  11 +**email** | **str** | |
  12 +
  13 +## Example
  14 +
  15 +```python
  16 +from openapi_client.models.new_student import NewStudent
  17 +
  18 +# TODO update the JSON string below
  19 +json = "{}"
  20 +# create an instance of NewStudent from a JSON string
  21 +new_student_instance = NewStudent.from_json(json)
  22 +# print the JSON string representation of the object
  23 +print(NewStudent.to_json())
  24 +
  25 +# convert the object into a dict
  26 +new_student_dict = new_student_instance.to_dict()
  27 +# create an instance of NewStudent from a dict
  28 +new_student_from_dict = NewStudent.from_dict(new_student_dict)
  29 +```
  30 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  31 +
  32 +
... ...
  1 +# ResetPassword
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**login_id** | **str** | |
  9 +**otp** | **str** | |
  10 +**new_password** | **str** | |
  11 +
  12 +## Example
  13 +
  14 +```python
  15 +from openapi_client.models.reset_password import ResetPassword
  16 +
  17 +# TODO update the JSON string below
  18 +json = "{}"
  19 +# create an instance of ResetPassword from a JSON string
  20 +reset_password_instance = ResetPassword.from_json(json)
  21 +# print the JSON string representation of the object
  22 +print(ResetPassword.to_json())
  23 +
  24 +# convert the object into a dict
  25 +reset_password_dict = reset_password_instance.to_dict()
  26 +# create an instance of ResetPassword from a dict
  27 +reset_password_from_dict = ResetPassword.from_dict(reset_password_dict)
  28 +```
  29 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  30 +
  31 +
... ...
  1 +# openapi_client.SessionManagementApi
  2 +
  3 +All URIs are relative to *http://localhost*
  4 +
  5 +Method | HTTP request | Description
  6 +------------- | ------------- | -------------
  7 +[**delete_session_session_logout_user_id_user_type_id_delete**](SessionManagementApi.md#delete_session_session_logout_user_id_user_type_id_delete) | **DELETE** /session/logout/{user_id}/{user_type_id} | Delete Session
  8 +[**new_session_session_login_post**](SessionManagementApi.md#new_session_session_login_post) | **POST** /session/login | New Session
  9 +
  10 +
  11 +# **delete_session_session_logout_user_id_user_type_id_delete**
  12 +> object delete_session_session_logout_user_id_user_type_id_delete(user_id, user_type_id)
  13 +
  14 +Delete Session
  15 +
  16 +### Example
  17 +
  18 +
  19 +```python
  20 +import openapi_client
  21 +from openapi_client.rest import ApiException
  22 +from pprint import pprint
  23 +
  24 +# Defining the host is optional and defaults to http://localhost
  25 +# See configuration.py for a list of all supported configuration parameters.
  26 +configuration = openapi_client.Configuration(
  27 + host = "http://localhost"
  28 +)
  29 +
  30 +
  31 +# Enter a context with an instance of the API client
  32 +with openapi_client.ApiClient(configuration) as api_client:
  33 + # Create an instance of the API class
  34 + api_instance = openapi_client.SessionManagementApi(api_client)
  35 + user_id = 56 # int |
  36 + user_type_id = 56 # int |
  37 +
  38 + try:
  39 + # Delete Session
  40 + api_response = api_instance.delete_session_session_logout_user_id_user_type_id_delete(user_id, user_type_id)
  41 + print("The response of SessionManagementApi->delete_session_session_logout_user_id_user_type_id_delete:\n")
  42 + pprint(api_response)
  43 + except Exception as e:
  44 + print("Exception when calling SessionManagementApi->delete_session_session_logout_user_id_user_type_id_delete: %s\n" % e)
  45 +```
  46 +
  47 +
  48 +
  49 +### Parameters
  50 +
  51 +
  52 +Name | Type | Description | Notes
  53 +------------- | ------------- | ------------- | -------------
  54 + **user_id** | **int**| |
  55 + **user_type_id** | **int**| |
  56 +
  57 +### Return type
  58 +
  59 +**object**
  60 +
  61 +### Authorization
  62 +
  63 +No authorization required
  64 +
  65 +### HTTP request headers
  66 +
  67 + - **Content-Type**: Not defined
  68 + - **Accept**: application/json
  69 +
  70 +### HTTP response details
  71 +
  72 +| Status code | Description | Response headers |
  73 +|-------------|-------------|------------------|
  74 +**200** | Successful Response | - |
  75 +**422** | Validation Error | - |
  76 +
  77 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  78 +
  79 +# **new_session_session_login_post**
  80 +> UserDetails new_session_session_login_post(new_session)
  81 +
  82 +New Session
  83 +
  84 +### Example
  85 +
  86 +
  87 +```python
  88 +import openapi_client
  89 +from openapi_client.models.new_session import NewSession
  90 +from openapi_client.models.user_details import UserDetails
  91 +from openapi_client.rest import ApiException
  92 +from pprint import pprint
  93 +
  94 +# Defining the host is optional and defaults to http://localhost
  95 +# See configuration.py for a list of all supported configuration parameters.
  96 +configuration = openapi_client.Configuration(
  97 + host = "http://localhost"
  98 +)
  99 +
  100 +
  101 +# Enter a context with an instance of the API client
  102 +with openapi_client.ApiClient(configuration) as api_client:
  103 + # Create an instance of the API class
  104 + api_instance = openapi_client.SessionManagementApi(api_client)
  105 + new_session = openapi_client.NewSession() # NewSession |
  106 +
  107 + try:
  108 + # New Session
  109 + api_response = api_instance.new_session_session_login_post(new_session)
  110 + print("The response of SessionManagementApi->new_session_session_login_post:\n")
  111 + pprint(api_response)
  112 + except Exception as e:
  113 + print("Exception when calling SessionManagementApi->new_session_session_login_post: %s\n" % e)
  114 +```
  115 +
  116 +
  117 +
  118 +### Parameters
  119 +
  120 +
  121 +Name | Type | Description | Notes
  122 +------------- | ------------- | ------------- | -------------
  123 + **new_session** | [**NewSession**](NewSession.md)| |
  124 +
  125 +### Return type
  126 +
  127 +[**UserDetails**](UserDetails.md)
  128 +
  129 +### Authorization
  130 +
  131 +No authorization required
  132 +
  133 +### HTTP request headers
  134 +
  135 + - **Content-Type**: application/json
  136 + - **Accept**: application/json
  137 +
  138 +### HTTP response details
  139 +
  140 +| Status code | Description | Response headers |
  141 +|-------------|-------------|------------------|
  142 +**200** | Successful Response | - |
  143 +**422** | Validation Error | - |
  144 +
  145 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  146 +
... ...
  1 +# StudentDetails
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**student_id** | **int** | |
  9 +**student_name** | **str** | |
  10 +
  11 +## Example
  12 +
  13 +```python
  14 +from openapi_client.models.student_details import StudentDetails
  15 +
  16 +# TODO update the JSON string below
  17 +json = "{}"
  18 +# create an instance of StudentDetails from a JSON string
  19 +student_details_instance = StudentDetails.from_json(json)
  20 +# print the JSON string representation of the object
  21 +print(StudentDetails.to_json())
  22 +
  23 +# convert the object into a dict
  24 +student_details_dict = student_details_instance.to_dict()
  25 +# create an instance of StudentDetails from a dict
  26 +student_details_from_dict = StudentDetails.from_dict(student_details_dict)
  27 +```
  28 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  29 +
  30 +
... ...
  1 +# UpdateDatasetEntity
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**ds_entity_name** | **str** | | [optional]
  9 +**entity_source** | **str** | | [optional]
  10 +**collected_on** | **datetime** | | [optional]
  11 +**labeling_algo** | **str** | | [optional]
  12 +**ds_entity_info** | **object** | | [optional]
  13 +**location_id** | **int** | | [optional]
  14 +**remark** | **str** | |
  15 +
  16 +## Example
  17 +
  18 +```python
  19 +from openapi_client.models.update_dataset_entity import UpdateDatasetEntity
  20 +
  21 +# TODO update the JSON string below
  22 +json = "{}"
  23 +# create an instance of UpdateDatasetEntity from a JSON string
  24 +update_dataset_entity_instance = UpdateDatasetEntity.from_json(json)
  25 +# print the JSON string representation of the object
  26 +print(UpdateDatasetEntity.to_json())
  27 +
  28 +# convert the object into a dict
  29 +update_dataset_entity_dict = update_dataset_entity_instance.to_dict()
  30 +# create an instance of UpdateDatasetEntity from a dict
  31 +update_dataset_entity_from_dict = UpdateDatasetEntity.from_dict(update_dataset_entity_dict)
  32 +```
  33 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  34 +
  35 +
... ...
  1 +# UpdateLocation
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**location_id** | **int** | |
  9 +**lat** | **float** | | [optional]
  10 +**long** | **float** | | [optional]
  11 +**details** | **object** | | [optional]
  12 +
  13 +## Example
  14 +
  15 +```python
  16 +from openapi_client.models.update_location import UpdateLocation
  17 +
  18 +# TODO update the JSON string below
  19 +json = "{}"
  20 +# create an instance of UpdateLocation from a JSON string
  21 +update_location_instance = UpdateLocation.from_json(json)
  22 +# print the JSON string representation of the object
  23 +print(UpdateLocation.to_json())
  24 +
  25 +# convert the object into a dict
  26 +update_location_dict = update_location_instance.to_dict()
  27 +# create an instance of UpdateLocation from a dict
  28 +update_location_from_dict = UpdateLocation.from_dict(update_location_dict)
  29 +```
  30 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  31 +
  32 +
... ...
  1 +# UpdateUser
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**first_name** | **str** | | [optional]
  9 +**middle_name** | **str** | | [optional]
  10 +**last_name** | **str** | | [optional]
  11 +**passwd** | **str** | | [optional]
  12 +**org_id** | **int** | | [optional]
  13 +
  14 +## Example
  15 +
  16 +```python
  17 +from openapi_client.models.update_user import UpdateUser
  18 +
  19 +# TODO update the JSON string below
  20 +json = "{}"
  21 +# create an instance of UpdateUser from a JSON string
  22 +update_user_instance = UpdateUser.from_json(json)
  23 +# print the JSON string representation of the object
  24 +print(UpdateUser.to_json())
  25 +
  26 +# convert the object into a dict
  27 +update_user_dict = update_user_instance.to_dict()
  28 +# create an instance of UpdateUser from a dict
  29 +update_user_from_dict = UpdateUser.from_dict(update_user_dict)
  30 +```
  31 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  32 +
  33 +
... ...
  1 +# UserDetails
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**user_name** | **str** | |
  9 +**first_name** | **str** | |
  10 +**middle_name** | **str** | |
  11 +**last_name** | **str** | |
  12 +**email** | **str** | |
  13 +**user_type_id** | **int** | |
  14 +**org_id** | **int** | |
  15 +**user_id** | **int** | |
  16 +**user_type** | **str** | | [optional]
  17 +**org_name** | **str** | | [optional]
  18 +**token** | **str** | | [optional]
  19 +**token_expiry_at** | **str** | | [optional]
  20 +**profile_pic** | **str** | | [optional]
  21 +
  22 +## Example
  23 +
  24 +```python
  25 +from openapi_client.models.user_details import UserDetails
  26 +
  27 +# TODO update the JSON string below
  28 +json = "{}"
  29 +# create an instance of UserDetails from a JSON string
  30 +user_details_instance = UserDetails.from_json(json)
  31 +# print the JSON string representation of the object
  32 +print(UserDetails.to_json())
  33 +
  34 +# convert the object into a dict
  35 +user_details_dict = user_details_instance.to_dict()
  36 +# create an instance of UserDetails from a dict
  37 +user_details_from_dict = UserDetails.from_dict(user_details_dict)
  38 +```
  39 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  40 +
  41 +
... ...
  1 +# openapi_client.UsersManagementApi
  2 +
  3 +All URIs are relative to *http://localhost*
  4 +
  5 +Method | HTTP request | Description
  6 +------------- | ------------- | -------------
  7 +[**forgot_password_users_forgot_password_post**](UsersManagementApi.md#forgot_password_users_forgot_password_post) | **POST** /users/forgotPassword | Forgot Password
  8 +[**get_profile_picture_users_profile_pic_user_id_user_type_id_get**](UsersManagementApi.md#get_profile_picture_users_profile_pic_user_id_user_type_id_get) | **GET** /users/profilePic/{user_id}/{user_type_id} | Get Profile Picture
  9 +[**get_user_locations_users_students_user_id_user_type_id_get**](UsersManagementApi.md#get_user_locations_users_students_user_id_user_type_id_get) | **GET** /users/students/{user_id}/{user_type_id} | Get User Locations
  10 +[**new_student_users_students_user_id_user_type_id_post**](UsersManagementApi.md#new_student_users_students_user_id_user_type_id_post) | **POST** /users/students/{user_id}/{user_type_id} | New Student
  11 +[**reset_password_users_reset_password_post**](UsersManagementApi.md#reset_password_users_reset_password_post) | **POST** /users/resetPassword | Reset Password
  12 +[**update_profile_picture_users_profile_pic_user_id_user_type_id_post**](UsersManagementApi.md#update_profile_picture_users_profile_pic_user_id_user_type_id_post) | **POST** /users/profilePic/{user_id}/{user_type_id} | Update Profile Picture
  13 +[**update_user_profile_users_user_id_user_type_id_put**](UsersManagementApi.md#update_user_profile_users_user_id_user_type_id_put) | **PUT** /users/{user_id}/{user_type_id} | Update User Profile
  14 +[**validate_user_sign_up_users_validate_user_id_user_type_id_post**](UsersManagementApi.md#validate_user_sign_up_users_validate_user_id_user_type_id_post) | **POST** /users/validate/{user_id}/{user_type_id} | Validate User Sign Up
  15 +
  16 +
  17 +# **forgot_password_users_forgot_password_post**
  18 +> object forgot_password_users_forgot_password_post(forgot_password)
  19 +
  20 +Forgot Password
  21 +
  22 +### Example
  23 +
  24 +
  25 +```python
  26 +import openapi_client
  27 +from openapi_client.models.forgot_password import ForgotPassword
  28 +from openapi_client.rest import ApiException
  29 +from pprint import pprint
  30 +
  31 +# Defining the host is optional and defaults to http://localhost
  32 +# See configuration.py for a list of all supported configuration parameters.
  33 +configuration = openapi_client.Configuration(
  34 + host = "http://localhost"
  35 +)
  36 +
  37 +
  38 +# Enter a context with an instance of the API client
  39 +with openapi_client.ApiClient(configuration) as api_client:
  40 + # Create an instance of the API class
  41 + api_instance = openapi_client.UsersManagementApi(api_client)
  42 + forgot_password = openapi_client.ForgotPassword() # ForgotPassword |
  43 +
  44 + try:
  45 + # Forgot Password
  46 + api_response = api_instance.forgot_password_users_forgot_password_post(forgot_password)
  47 + print("The response of UsersManagementApi->forgot_password_users_forgot_password_post:\n")
  48 + pprint(api_response)
  49 + except Exception as e:
  50 + print("Exception when calling UsersManagementApi->forgot_password_users_forgot_password_post: %s\n" % e)
  51 +```
  52 +
  53 +
  54 +
  55 +### Parameters
  56 +
  57 +
  58 +Name | Type | Description | Notes
  59 +------------- | ------------- | ------------- | -------------
  60 + **forgot_password** | [**ForgotPassword**](ForgotPassword.md)| |
  61 +
  62 +### Return type
  63 +
  64 +**object**
  65 +
  66 +### Authorization
  67 +
  68 +No authorization required
  69 +
  70 +### HTTP request headers
  71 +
  72 + - **Content-Type**: application/json
  73 + - **Accept**: application/json
  74 +
  75 +### HTTP response details
  76 +
  77 +| Status code | Description | Response headers |
  78 +|-------------|-------------|------------------|
  79 +**200** | Successful Response | - |
  80 +**422** | Validation Error | - |
  81 +
  82 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  83 +
  84 +# **get_profile_picture_users_profile_pic_user_id_user_type_id_get**
  85 +> object get_profile_picture_users_profile_pic_user_id_user_type_id_get(user_id, user_type_id)
  86 +
  87 +Get Profile Picture
  88 +
  89 +### Example
  90 +
  91 +
  92 +```python
  93 +import openapi_client
  94 +from openapi_client.rest import ApiException
  95 +from pprint import pprint
  96 +
  97 +# Defining the host is optional and defaults to http://localhost
  98 +# See configuration.py for a list of all supported configuration parameters.
  99 +configuration = openapi_client.Configuration(
  100 + host = "http://localhost"
  101 +)
  102 +
  103 +
  104 +# Enter a context with an instance of the API client
  105 +with openapi_client.ApiClient(configuration) as api_client:
  106 + # Create an instance of the API class
  107 + api_instance = openapi_client.UsersManagementApi(api_client)
  108 + user_id = 56 # int |
  109 + user_type_id = 56 # int |
  110 +
  111 + try:
  112 + # Get Profile Picture
  113 + api_response = api_instance.get_profile_picture_users_profile_pic_user_id_user_type_id_get(user_id, user_type_id)
  114 + print("The response of UsersManagementApi->get_profile_picture_users_profile_pic_user_id_user_type_id_get:\n")
  115 + pprint(api_response)
  116 + except Exception as e:
  117 + print("Exception when calling UsersManagementApi->get_profile_picture_users_profile_pic_user_id_user_type_id_get: %s\n" % e)
  118 +```
  119 +
  120 +
  121 +
  122 +### Parameters
  123 +
  124 +
  125 +Name | Type | Description | Notes
  126 +------------- | ------------- | ------------- | -------------
  127 + **user_id** | **int**| |
  128 + **user_type_id** | **int**| |
  129 +
  130 +### Return type
  131 +
  132 +**object**
  133 +
  134 +### Authorization
  135 +
  136 +No authorization required
  137 +
  138 +### HTTP request headers
  139 +
  140 + - **Content-Type**: Not defined
  141 + - **Accept**: application/json
  142 +
  143 +### HTTP response details
  144 +
  145 +| Status code | Description | Response headers |
  146 +|-------------|-------------|------------------|
  147 +**200** | Successful Response | - |
  148 +**422** | Validation Error | - |
  149 +
  150 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  151 +
  152 +# **get_user_locations_users_students_user_id_user_type_id_get**
  153 +> List[StudentDetails] get_user_locations_users_students_user_id_user_type_id_get(user_id, user_type_id)
  154 +
  155 +Get User Locations
  156 +
  157 +### Example
  158 +
  159 +
  160 +```python
  161 +import openapi_client
  162 +from openapi_client.models.student_details import StudentDetails
  163 +from openapi_client.rest import ApiException
  164 +from pprint import pprint
  165 +
  166 +# Defining the host is optional and defaults to http://localhost
  167 +# See configuration.py for a list of all supported configuration parameters.
  168 +configuration = openapi_client.Configuration(
  169 + host = "http://localhost"
  170 +)
  171 +
  172 +
  173 +# Enter a context with an instance of the API client
  174 +with openapi_client.ApiClient(configuration) as api_client:
  175 + # Create an instance of the API class
  176 + api_instance = openapi_client.UsersManagementApi(api_client)
  177 + user_id = 56 # int |
  178 + user_type_id = 56 # int |
  179 +
  180 + try:
  181 + # Get User Locations
  182 + api_response = api_instance.get_user_locations_users_students_user_id_user_type_id_get(user_id, user_type_id)
  183 + print("The response of UsersManagementApi->get_user_locations_users_students_user_id_user_type_id_get:\n")
  184 + pprint(api_response)
  185 + except Exception as e:
  186 + print("Exception when calling UsersManagementApi->get_user_locations_users_students_user_id_user_type_id_get: %s\n" % e)
  187 +```
  188 +
  189 +
  190 +
  191 +### Parameters
  192 +
  193 +
  194 +Name | Type | Description | Notes
  195 +------------- | ------------- | ------------- | -------------
  196 + **user_id** | **int**| |
  197 + **user_type_id** | **int**| |
  198 +
  199 +### Return type
  200 +
  201 +[**List[StudentDetails]**](StudentDetails.md)
  202 +
  203 +### Authorization
  204 +
  205 +No authorization required
  206 +
  207 +### HTTP request headers
  208 +
  209 + - **Content-Type**: Not defined
  210 + - **Accept**: application/json
  211 +
  212 +### HTTP response details
  213 +
  214 +| Status code | Description | Response headers |
  215 +|-------------|-------------|------------------|
  216 +**200** | Successful Response | - |
  217 +**422** | Validation Error | - |
  218 +
  219 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  220 +
  221 +# **new_student_users_students_user_id_user_type_id_post**
  222 +> object new_student_users_students_user_id_user_type_id_post(user_id, user_type_id, new_student)
  223 +
  224 +New Student
  225 +
  226 +### Example
  227 +
  228 +
  229 +```python
  230 +import openapi_client
  231 +from openapi_client.models.new_student import NewStudent
  232 +from openapi_client.rest import ApiException
  233 +from pprint import pprint
  234 +
  235 +# Defining the host is optional and defaults to http://localhost
  236 +# See configuration.py for a list of all supported configuration parameters.
  237 +configuration = openapi_client.Configuration(
  238 + host = "http://localhost"
  239 +)
  240 +
  241 +
  242 +# Enter a context with an instance of the API client
  243 +with openapi_client.ApiClient(configuration) as api_client:
  244 + # Create an instance of the API class
  245 + api_instance = openapi_client.UsersManagementApi(api_client)
  246 + user_id = 56 # int |
  247 + user_type_id = 56 # int |
  248 + new_student = openapi_client.NewStudent() # NewStudent |
  249 +
  250 + try:
  251 + # New Student
  252 + api_response = api_instance.new_student_users_students_user_id_user_type_id_post(user_id, user_type_id, new_student)
  253 + print("The response of UsersManagementApi->new_student_users_students_user_id_user_type_id_post:\n")
  254 + pprint(api_response)
  255 + except Exception as e:
  256 + print("Exception when calling UsersManagementApi->new_student_users_students_user_id_user_type_id_post: %s\n" % e)
  257 +```
  258 +
  259 +
  260 +
  261 +### Parameters
  262 +
  263 +
  264 +Name | Type | Description | Notes
  265 +------------- | ------------- | ------------- | -------------
  266 + **user_id** | **int**| |
  267 + **user_type_id** | **int**| |
  268 + **new_student** | [**NewStudent**](NewStudent.md)| |
  269 +
  270 +### Return type
  271 +
  272 +**object**
  273 +
  274 +### Authorization
  275 +
  276 +No authorization required
  277 +
  278 +### HTTP request headers
  279 +
  280 + - **Content-Type**: application/json
  281 + - **Accept**: application/json
  282 +
  283 +### HTTP response details
  284 +
  285 +| Status code | Description | Response headers |
  286 +|-------------|-------------|------------------|
  287 +**200** | Successful Response | - |
  288 +**422** | Validation Error | - |
  289 +
  290 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  291 +
  292 +# **reset_password_users_reset_password_post**
  293 +> object reset_password_users_reset_password_post(reset_password)
  294 +
  295 +Reset Password
  296 +
  297 +### Example
  298 +
  299 +
  300 +```python
  301 +import openapi_client
  302 +from openapi_client.models.reset_password import ResetPassword
  303 +from openapi_client.rest import ApiException
  304 +from pprint import pprint
  305 +
  306 +# Defining the host is optional and defaults to http://localhost
  307 +# See configuration.py for a list of all supported configuration parameters.
  308 +configuration = openapi_client.Configuration(
  309 + host = "http://localhost"
  310 +)
  311 +
  312 +
  313 +# Enter a context with an instance of the API client
  314 +with openapi_client.ApiClient(configuration) as api_client:
  315 + # Create an instance of the API class
  316 + api_instance = openapi_client.UsersManagementApi(api_client)
  317 + reset_password = openapi_client.ResetPassword() # ResetPassword |
  318 +
  319 + try:
  320 + # Reset Password
  321 + api_response = api_instance.reset_password_users_reset_password_post(reset_password)
  322 + print("The response of UsersManagementApi->reset_password_users_reset_password_post:\n")
  323 + pprint(api_response)
  324 + except Exception as e:
  325 + print("Exception when calling UsersManagementApi->reset_password_users_reset_password_post: %s\n" % e)
  326 +```
  327 +
  328 +
  329 +
  330 +### Parameters
  331 +
  332 +
  333 +Name | Type | Description | Notes
  334 +------------- | ------------- | ------------- | -------------
  335 + **reset_password** | [**ResetPassword**](ResetPassword.md)| |
  336 +
  337 +### Return type
  338 +
  339 +**object**
  340 +
  341 +### Authorization
  342 +
  343 +No authorization required
  344 +
  345 +### HTTP request headers
  346 +
  347 + - **Content-Type**: application/json
  348 + - **Accept**: application/json
  349 +
  350 +### HTTP response details
  351 +
  352 +| Status code | Description | Response headers |
  353 +|-------------|-------------|------------------|
  354 +**200** | Successful Response | - |
  355 +**422** | Validation Error | - |
  356 +
  357 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  358 +
  359 +# **update_profile_picture_users_profile_pic_user_id_user_type_id_post**
  360 +> object update_profile_picture_users_profile_pic_user_id_user_type_id_post(user_id, user_type_id, pic)
  361 +
  362 +Update Profile Picture
  363 +
  364 +### Example
  365 +
  366 +
  367 +```python
  368 +import openapi_client
  369 +from openapi_client.rest import ApiException
  370 +from pprint import pprint
  371 +
  372 +# Defining the host is optional and defaults to http://localhost
  373 +# See configuration.py for a list of all supported configuration parameters.
  374 +configuration = openapi_client.Configuration(
  375 + host = "http://localhost"
  376 +)
  377 +
  378 +
  379 +# Enter a context with an instance of the API client
  380 +with openapi_client.ApiClient(configuration) as api_client:
  381 + # Create an instance of the API class
  382 + api_instance = openapi_client.UsersManagementApi(api_client)
  383 + user_id = 56 # int |
  384 + user_type_id = 56 # int |
  385 + pic = None # bytearray |
  386 +
  387 + try:
  388 + # Update Profile Picture
  389 + api_response = api_instance.update_profile_picture_users_profile_pic_user_id_user_type_id_post(user_id, user_type_id, pic)
  390 + print("The response of UsersManagementApi->update_profile_picture_users_profile_pic_user_id_user_type_id_post:\n")
  391 + pprint(api_response)
  392 + except Exception as e:
  393 + print("Exception when calling UsersManagementApi->update_profile_picture_users_profile_pic_user_id_user_type_id_post: %s\n" % e)
  394 +```
  395 +
  396 +
  397 +
  398 +### Parameters
  399 +
  400 +
  401 +Name | Type | Description | Notes
  402 +------------- | ------------- | ------------- | -------------
  403 + **user_id** | **int**| |
  404 + **user_type_id** | **int**| |
  405 + **pic** | **bytearray**| |
  406 +
  407 +### Return type
  408 +
  409 +**object**
  410 +
  411 +### Authorization
  412 +
  413 +No authorization required
  414 +
  415 +### HTTP request headers
  416 +
  417 + - **Content-Type**: multipart/form-data
  418 + - **Accept**: application/json
  419 +
  420 +### HTTP response details
  421 +
  422 +| Status code | Description | Response headers |
  423 +|-------------|-------------|------------------|
  424 +**200** | Successful Response | - |
  425 +**422** | Validation Error | - |
  426 +
  427 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  428 +
  429 +# **update_user_profile_users_user_id_user_type_id_put**
  430 +> object update_user_profile_users_user_id_user_type_id_put(user_id, user_type_id, update_user)
  431 +
  432 +Update User Profile
  433 +
  434 +### Example
  435 +
  436 +
  437 +```python
  438 +import openapi_client
  439 +from openapi_client.models.update_user import UpdateUser
  440 +from openapi_client.rest import ApiException
  441 +from pprint import pprint
  442 +
  443 +# Defining the host is optional and defaults to http://localhost
  444 +# See configuration.py for a list of all supported configuration parameters.
  445 +configuration = openapi_client.Configuration(
  446 + host = "http://localhost"
  447 +)
  448 +
  449 +
  450 +# Enter a context with an instance of the API client
  451 +with openapi_client.ApiClient(configuration) as api_client:
  452 + # Create an instance of the API class
  453 + api_instance = openapi_client.UsersManagementApi(api_client)
  454 + user_id = 56 # int |
  455 + user_type_id = 56 # int |
  456 + update_user = openapi_client.UpdateUser() # UpdateUser |
  457 +
  458 + try:
  459 + # Update User Profile
  460 + api_response = api_instance.update_user_profile_users_user_id_user_type_id_put(user_id, user_type_id, update_user)
  461 + print("The response of UsersManagementApi->update_user_profile_users_user_id_user_type_id_put:\n")
  462 + pprint(api_response)
  463 + except Exception as e:
  464 + print("Exception when calling UsersManagementApi->update_user_profile_users_user_id_user_type_id_put: %s\n" % e)
  465 +```
  466 +
  467 +
  468 +
  469 +### Parameters
  470 +
  471 +
  472 +Name | Type | Description | Notes
  473 +------------- | ------------- | ------------- | -------------
  474 + **user_id** | **int**| |
  475 + **user_type_id** | **int**| |
  476 + **update_user** | [**UpdateUser**](UpdateUser.md)| |
  477 +
  478 +### Return type
  479 +
  480 +**object**
  481 +
  482 +### Authorization
  483 +
  484 +No authorization required
  485 +
  486 +### HTTP request headers
  487 +
  488 + - **Content-Type**: application/json
  489 + - **Accept**: application/json
  490 +
  491 +### HTTP response details
  492 +
  493 +| Status code | Description | Response headers |
  494 +|-------------|-------------|------------------|
  495 +**200** | Successful Response | - |
  496 +**422** | Validation Error | - |
  497 +
  498 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  499 +
  500 +# **validate_user_sign_up_users_validate_user_id_user_type_id_post**
  501 +> object validate_user_sign_up_users_validate_user_id_user_type_id_post(user_id, user_type_id)
  502 +
  503 +Validate User Sign Up
  504 +
  505 +### Example
  506 +
  507 +
  508 +```python
  509 +import openapi_client
  510 +from openapi_client.rest import ApiException
  511 +from pprint import pprint
  512 +
  513 +# Defining the host is optional and defaults to http://localhost
  514 +# See configuration.py for a list of all supported configuration parameters.
  515 +configuration = openapi_client.Configuration(
  516 + host = "http://localhost"
  517 +)
  518 +
  519 +
  520 +# Enter a context with an instance of the API client
  521 +with openapi_client.ApiClient(configuration) as api_client:
  522 + # Create an instance of the API class
  523 + api_instance = openapi_client.UsersManagementApi(api_client)
  524 + user_id = 56 # int |
  525 + user_type_id = 56 # int |
  526 +
  527 + try:
  528 + # Validate User Sign Up
  529 + api_response = api_instance.validate_user_sign_up_users_validate_user_id_user_type_id_post(user_id, user_type_id)
  530 + print("The response of UsersManagementApi->validate_user_sign_up_users_validate_user_id_user_type_id_post:\n")
  531 + pprint(api_response)
  532 + except Exception as e:
  533 + print("Exception when calling UsersManagementApi->validate_user_sign_up_users_validate_user_id_user_type_id_post: %s\n" % e)
  534 +```
  535 +
  536 +
  537 +
  538 +### Parameters
  539 +
  540 +
  541 +Name | Type | Description | Notes
  542 +------------- | ------------- | ------------- | -------------
  543 + **user_id** | **int**| |
  544 + **user_type_id** | **int**| |
  545 +
  546 +### Return type
  547 +
  548 +**object**
  549 +
  550 +### Authorization
  551 +
  552 +No authorization required
  553 +
  554 +### HTTP request headers
  555 +
  556 + - **Content-Type**: Not defined
  557 + - **Accept**: application/json
  558 +
  559 +### HTTP response details
  560 +
  561 +| Status code | Description | Response headers |
  562 +|-------------|-------------|------------------|
  563 +**200** | Successful Response | - |
  564 +**422** | Validation Error | - |
  565 +
  566 +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
  567 +
... ...
  1 +# ValidationError
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +**loc** | [**List[ValidationErrorLocInner]**](ValidationErrorLocInner.md) | |
  9 +**msg** | **str** | |
  10 +**type** | **str** | |
  11 +
  12 +## Example
  13 +
  14 +```python
  15 +from openapi_client.models.validation_error import ValidationError
  16 +
  17 +# TODO update the JSON string below
  18 +json = "{}"
  19 +# create an instance of ValidationError from a JSON string
  20 +validation_error_instance = ValidationError.from_json(json)
  21 +# print the JSON string representation of the object
  22 +print(ValidationError.to_json())
  23 +
  24 +# convert the object into a dict
  25 +validation_error_dict = validation_error_instance.to_dict()
  26 +# create an instance of ValidationError from a dict
  27 +validation_error_from_dict = ValidationError.from_dict(validation_error_dict)
  28 +```
  29 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  30 +
  31 +
... ...
  1 +# ValidationErrorLocInner
  2 +
  3 +
  4 +## Properties
  5 +
  6 +Name | Type | Description | Notes
  7 +------------ | ------------- | ------------- | -------------
  8 +
  9 +## Example
  10 +
  11 +```python
  12 +from openapi_client.models.validation_error_loc_inner import ValidationErrorLocInner
  13 +
  14 +# TODO update the JSON string below
  15 +json = "{}"
  16 +# create an instance of ValidationErrorLocInner from a JSON string
  17 +validation_error_loc_inner_instance = ValidationErrorLocInner.from_json(json)
  18 +# print the JSON string representation of the object
  19 +print(ValidationErrorLocInner.to_json())
  20 +
  21 +# convert the object into a dict
  22 +validation_error_loc_inner_dict = validation_error_loc_inner_instance.to_dict()
  23 +# create an instance of ValidationErrorLocInner from a dict
  24 +validation_error_loc_inner_from_dict = ValidationErrorLocInner.from_dict(validation_error_loc_inner_dict)
  25 +```
  26 +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
  27 +
  28 +
... ...
  1 +#!/bin/sh
  2 +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
  3 +#
  4 +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
  5 +
  6 +git_user_id=$1
  7 +git_repo_id=$2
  8 +release_note=$3
  9 +git_host=$4
  10 +
  11 +if [ "$git_host" = "" ]; then
  12 + git_host="github.com"
  13 + echo "[INFO] No command line input provided. Set \$git_host to $git_host"
  14 +fi
  15 +
  16 +if [ "$git_user_id" = "" ]; then
  17 + git_user_id="GIT_USER_ID"
  18 + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
  19 +fi
  20 +
  21 +if [ "$git_repo_id" = "" ]; then
  22 + git_repo_id="GIT_REPO_ID"
  23 + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
  24 +fi
  25 +
  26 +if [ "$release_note" = "" ]; then
  27 + release_note="Minor update"
  28 + echo "[INFO] No command line input provided. Set \$release_note to $release_note"
  29 +fi
  30 +
  31 +# Initialize the local directory as a Git repository
  32 +git init
  33 +
  34 +# Adds the files in the local repository and stages them for commit.
  35 +git add .
  36 +
  37 +# Commits the tracked changes and prepares them to be pushed to a remote repository.
  38 +git commit -m "$release_note"
  39 +
  40 +# Sets the new remote
  41 +git_remote=$(git remote)
  42 +if [ "$git_remote" = "" ]; then # git remote not defined
  43 +
  44 + if [ "$GIT_TOKEN" = "" ]; then
  45 + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
  46 + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
  47 + else
  48 + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
  49 + fi
  50 +
  51 +fi
  52 +
  53 +git pull origin master
  54 +
  55 +# Pushes (Forces) the changes in the local repository up to the remote repository
  56 +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
  57 +git push origin master 2>&1 | grep -v 'To https'
... ...
  1 +# coding: utf-8
  2 +
  3 +# flake8: noqa
  4 +
  5 +"""
  6 + FastAPI
  7 +
  8 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  9 +
  10 + The version of the OpenAPI document: 0.1.0
  11 + Generated by OpenAPI Generator (https://openapi-generator.tech)
  12 +
  13 + Do not edit the class manually.
  14 +""" # noqa: E501
  15 +
  16 +
  17 +__version__ = "1.0.0"
  18 +
  19 +# import apis into sdk package
  20 +from openapi_client.api.dashboard_data_api import DashboardDataApi
  21 +from openapi_client.api.dataset_management_api import DatasetManagementApi
  22 +from openapi_client.api.location_management_api import LocationManagementApi
  23 +from openapi_client.api.session_management_api import SessionManagementApi
  24 +from openapi_client.api.users_management_api import UsersManagementApi
  25 +
  26 +# import ApiClient
  27 +from openapi_client.api_response import ApiResponse
  28 +from openapi_client.api_client import ApiClient
  29 +from openapi_client.configuration import Configuration
  30 +from openapi_client.exceptions import OpenApiException
  31 +from openapi_client.exceptions import ApiTypeError
  32 +from openapi_client.exceptions import ApiValueError
  33 +from openapi_client.exceptions import ApiKeyError
  34 +from openapi_client.exceptions import ApiAttributeError
  35 +from openapi_client.exceptions import ApiException
  36 +
  37 +# import models into sdk package
  38 +from openapi_client.models.dataset_details import DatasetDetails
  39 +from openapi_client.models.dataset_entity_details import DatasetEntityDetails
  40 +from openapi_client.models.delete_dataset_entities import DeleteDatasetEntities
  41 +from openapi_client.models.entity_file_details import EntityFileDetails
  42 +from openapi_client.models.forgot_password import ForgotPassword
  43 +from openapi_client.models.http_validation_error import HTTPValidationError
  44 +from openapi_client.models.location_details import LocationDetails
  45 +from openapi_client.models.new_dataset import NewDataset
  46 +from openapi_client.models.new_dataset_entity import NewDatasetEntity
  47 +from openapi_client.models.new_location import NewLocation
  48 +from openapi_client.models.new_session import NewSession
  49 +from openapi_client.models.new_student import NewStudent
  50 +from openapi_client.models.reset_password import ResetPassword
  51 +from openapi_client.models.student_details import StudentDetails
  52 +from openapi_client.models.update_dataset_entity import UpdateDatasetEntity
  53 +from openapi_client.models.update_location import UpdateLocation
  54 +from openapi_client.models.update_user import UpdateUser
  55 +from openapi_client.models.user_details import UserDetails
  56 +from openapi_client.models.validation_error import ValidationError
  57 +from openapi_client.models.validation_error_loc_inner import ValidationErrorLocInner
... ...
  1 +# flake8: noqa
  2 +
  3 +# import apis into api package
  4 +from openapi_client.api.dashboard_data_api import DashboardDataApi
  5 +from openapi_client.api.dataset_management_api import DatasetManagementApi
  6 +from openapi_client.api.location_management_api import LocationManagementApi
  7 +from openapi_client.api.session_management_api import SessionManagementApi
  8 +from openapi_client.api.users_management_api import UsersManagementApi
  9 +
... ...
  1 +# coding: utf-8
  2 +
  3 +"""
  4 + FastAPI
  5 +
  6 + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  7 +
  8 + The version of the OpenAPI document: 0.1.0
  9 + Generated by OpenAPI Generator (https://openapi-generator.tech)
  10 +
  11 + Do not edit the class manually.
  12 +""" # noqa: E501
  13 +
  14 +import warnings
  15 +from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
  16 +from typing import Any, Dict, List, Optional, Tuple, Union
  17 +from typing_extensions import Annotated
  18 +
  19 +from pydantic import StrictInt
  20 +from typing import Any
  21 +
  22 +from openapi_client.api_client import ApiClient, RequestSerialized
  23 +from openapi_client.api_response import ApiResponse
  24 +from openapi_client.rest import RESTResponseType
  25 +
  26 +
  27 +class DashboardDataApi:
  28 + """NOTE: This class is auto generated by OpenAPI Generator
  29 + Ref: https://openapi-generator.tech
  30 +
  31 + Do not edit the class manually.
  32 + """
  33 +
  34 + def __init__(self, api_client=None) -> None:
  35 + if api_client is None:
  36 + api_client = ApiClient.get_default()
  37 + self.api_client = api_client
  38 +
  39 +
  40 + @validate_call
  41 + def get_dashboard_data_dashboard_user_id_user_type_id_get(
  42 + self,
  43 + user_id: StrictInt,
  44 + user_type_id: StrictInt,
  45 + _request_timeout: Union[
  46 + None,
  47 + Annotated[StrictFloat, Field(gt=0)],
  48 + Tuple[
  49 + Annotated[StrictFloat, Field(gt=0)],
  50 + Annotated[StrictFloat, Field(gt=0)]
  51 + ]
  52 + ] = None,
  53 + _request_auth: Optional[Dict[StrictStr, Any]] = None,
  54 + _content_type: Optional[StrictStr] = None,
  55 + _headers: Optional[Dict[StrictStr, Any]] = None,
  56 + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
  57 + ) -> object:
  58 + """Get Dashboard Data
  59 +
  60 +
  61 + :param user_id: (required)
  62 + :type user_id: int
  63 + :param user_type_id: (required)
  64 + :type user_type_id: int
  65 + :param _request_timeout: timeout setting for this request. If one
  66 + number provided, it will be total request
  67 + timeout. It can also be a pair (tuple) of
  68 + (connection, read) timeouts.
  69 + :type _request_timeout: int, tuple(int, int), optional
  70 + :param _request_auth: set to override the auth_settings for an a single
  71 + request; this effectively ignores the
  72 + authentication in the spec for a single request.
  73 + :type _request_auth: dict, optional
  74 + :param _content_type: force content-type for the request.
  75 + :type _content_type: str, Optional
  76 + :param _headers: set to override the headers for a single
  77 + request; this effectively ignores the headers
  78 + in the spec for a single request.
  79 + :type _headers: dict, optional
  80 + :param _host_index: set to override the host_index for a single
  81 + request; this effectively ignores the host_index
  82 + in the spec for a single request.
  83 + :type _host_index: int, optional
  84 + :return: Returns the result object.
  85 + """ # noqa: E501
  86 +
  87 + _param = self._get_dashboard_data_dashboard_user_id_user_type_id_get_serialize(
  88 + user_id=user_id,
  89 + user_type_id=user_type_id,
  90 + _request_auth=_request_auth,
  91 + _content_type=_content_type,
  92 + _headers=_headers,
  93 + _host_index=_host_index
  94 + )
  95 +
  96 + _response_types_map: Dict[str, Optional[str]] = {
  97 + '200': "object",
  98 + '422': "HTTPValidationError",
  99 + }
  100 + response_data = self.api_client.call_api(
  101 + *_param,
  102 + _request_timeout=_request_timeout
  103 + )
  104 + response_data.read()
  105 + return self.api_client.response_deserialize(
  106 + response_data=response_data,
  107 + response_types_map=_response_types_map,
  108 + ).data
  109 +
  110 +
  111 + @validate_call
  112 + def get_dashboard_data_dashboard_user_id_user_type_id_get_with_http_info(
  113 + self,
  114 + user_id: StrictInt,
  115 + user_type_id: StrictInt,
  116 + _request_timeout: Union[
  117 + None,
  118 + Annotated[StrictFloat, Field(gt=0)],
  119 + Tuple[
  120 + Annotated[StrictFloat, Field(gt=0)],
  121 + Annotated[StrictFloat, Field(gt=0)]
  122 + ]
  123 + ] = None,
  124 + _request_auth: Optional[Dict[StrictStr, Any]] = None,
  125 + _content_type: Optional[StrictStr] = None,
  126 + _headers: Optional[Dict[StrictStr, Any]] = None,
  127 + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
  128 + ) -> ApiResponse[object]:
  129 + """Get Dashboard Data
  130 +
  131 +
  132 + :param user_id: (required)
  133 + :type user_id: int
  134 + :param user_type_id: (required)
  135 + :type user_type_id: int
  136 + :param _request_timeout: timeout setting for this request. If one
  137 + number provided, it will be total request
  138 + timeout. It can also be a pair (tuple) of
  139 + (connection, read) timeouts.
  140 + :type _request_timeout: int, tuple(int, int), optional
  141 + :param _request_auth: set to override the auth_settings for an a single
  142 + request; this effectively ignores the
  143 + authentication in the spec for a single request.
  144 + :type _request_auth: dict, optional
  145 + :param _content_type: force content-type for the request.
  146 + :type _content_type: str, Optional
  147 + :param _headers: set to override the headers for a single
  148 + request; this effectively ignores the headers
  149 + in the spec for a single request.
  150 + :type _headers: dict, optional
  151 + :param _host_index: set to override the host_index for a single
  152 + request; this effectively ignores the host_index
  153 + in the spec for a single request.
  154 + :type _host_index: int, optional
  155 + :return: Returns the result object.
  156 + """ # noqa: E501
  157 +
  158 + _param = self._get_dashboard_data_dashboard_user_id_user_type_id_get_serialize(
  159 + user_id=user_id,
  160 + user_type_id=user_type_id,
  161 + _request_auth=_request_auth,
  162 + _content_type=_content_type,
  163 + _headers=_headers,
  164 + _host_index=_host_index
  165 + )
  166 +
  167 + _response_types_map: Dict[str, Optional[str]] = {
  168 + '200': "object",
  169 + '422': "HTTPValidationError",
  170 + }
  171 + response_data = self.api_client.call_api(
  172 + *_param,
  173 + _request_timeout=_request_timeout
  174 + )
  175 + response_data.read()
  176 + return self.api_client.response_deserialize(
  177 + response_data=response_data,
  178 + response_types_map=_response_types_map,
  179 + )
  180 +
  181 +
  182 + @validate_call
  183 + def get_dashboard_data_dashboard_user_id_user_type_id_get_without_preload_content(
  184 + self,
  185 + user_id: StrictInt,
  186 + user_type_id: StrictInt,
  187 + _request_timeout: Union[
  188 + None,
  189 + Annotated[StrictFloat, Field(gt=0)],
  190 + Tuple[
  191 + Annotated[StrictFloat, Field(gt=0)],
  192 + Annotated[StrictFloat, Field(gt=0)]
  193 + ]
  194 + ] = None,
  195 + _request_auth: Optional[Dict[StrictStr, Any]] = None,
  196 + _content_type: Optional[StrictStr] = None,
  197 + _headers: Optional[Dict[StrictStr, Any]] = None,
  198 + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
  199 + ) -> RESTResponseType:
  200 + """Get Dashboard Data
  201 +
  202 +
  203 + :param user_id: (required)
  204 + :type user_id: int
  205 + :param user_type_id: (required)
  206 + :type user_type_id: int
  207 + :param _request_timeout: timeout setting for this request. If one
  208 + number provided, it will be total request
  209 + timeout. It can also be a pair (tuple) of
  210 + (connection, read) timeouts.
  211 + :type _request_timeout: int, tuple(int, int), optional
  212 + :param _request_auth: set to override the auth_settings for an a single
  213 + request; this effectively ignores the
  214 + authentication in the spec for a single request.
  215 + :type _request_auth: dict, optional
  216 + :param _content_type: force content-type for the request.
  217 + :type _content_type: str, Optional
  218 + :param _headers: set to override the headers for a single
  219 + request; this effectively ignores the headers
  220 + in the spec for a single request.
  221 + :type _headers: dict, optional
  222 + :param _host_index: set to override the host_index for a single
  223 + request; this effectively ignores the host_index
  224 + in the spec for a single request.
  225 + :type _host_index: int, optional
  226 + :return: Returns the result object.
  227 + """ # noqa: E501
  228 +
  229 + _param = self._get_dashboard_data_dashboard_user_id_user_type_id_get_serialize(
  230 + user_id=user_id,
  231 + user_type_id=user_type_id,
  232 + _request_auth=_request_auth,
  233 + _content_type=_content_type,
  234 + _headers=_headers,
  235 + _host_index=_host_index
  236 + )
  237 +
  238 + _response_types_map: Dict[str, Optional[str]] = {
  239 + '200': "object",
  240 + '422': "HTTPValidationError",
  241 + }
  242 + response_data = self.api_client.call_api(
  243 + *_param,
  244 + _request_timeout=_request_timeout
  245 + )
  246 + return response_data.response
  247 +
  248 +
  249 + def _get_dashboard_data_dashboard_user_id_user_type_id_get_serialize(
  250 + self,
  251 + user_id,
  252 + user_type_id,
  253 + _request_auth,
  254 + _content_type,
  255 + _headers,
  256 + _host_index,
  257 + ) -> RequestSerialized:
  258 +
  259 + _host = None
  260 +
  261 + _collection_formats: Dict[str, str] = {
  262 + }
  263 +
  264 + _path_params: Dict[str, str] = {}
  265 + _query_params: List[Tuple[str, str]] = []
  266 + _header_params: Dict[str, Optional[str]] = _headers or {}
  267 + _form_params: List[Tuple[str, str]] = []
  268 + _files: Dict[
  269 + str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
  270 + ] = {}
  271 + _body_params: Optional[bytes] = None
  272 +
  273 + # process the path parameters
  274 + if user_id is not None:
  275 + _path_params['user_id'] = user_id
  276 + if user_type_id is not None:
  277 + _path_params['user_type_id'] = user_type_id
  278 + # process the query parameters
  279 + # process the header parameters
  280 + # process the form parameters
  281 + # process the body parameter
  282 +
  283 +
  284 + # set the HTTP header `Accept`
  285 + if 'Accept' not in _header_params:
  286 + _header_params['Accept'] = self.api_client.select_header_accept(
  287 + [
  288 + 'application/json'
  289 + ]
  290 + )
  291 +
  292 +
  293 + # authentication setting
  294 + _auth_settings: List[str] = [
  295 + ]
  296 +
  297 + return self.api_client.param_serialize(
  298 + method='GET',
  299 + resource_path='/dashboard/{user_id}/{user_type_id}',
  300 + path_params=_path_params,
  301 + query_params=_query_params,
  302 + header_params=_header_params,
  303 + body=_body_params,
  304 + post_params=_form_params,
  305 + files=_files,
  306 + auth_settings=_auth_settings,
  307 + collection_formats=_collection_formats,
  308 + _host=_host,
  309 + _request_auth=_request_auth
  310 + )
  311 +
  312 +
... ...
This diff could not be displayed because it is too large.
Please register or login to post a comment