184 lines
9.7 KiB
Markdown
184 lines
9.7 KiB
Markdown
# manager_api_new
|
|
API Manager Service
|
|
|
|
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: Version Alpha
|
|
- Build package: org.openapitools.codegen.languages.DartClientCodegen
|
|
|
|
## Requirements
|
|
|
|
Dart 2.12 or later
|
|
|
|
## Installation & Usage
|
|
|
|
### Github
|
|
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
|
|
```
|
|
dependencies:
|
|
manager_api_new:
|
|
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
|
|
```
|
|
|
|
### Local
|
|
To use the package in your local drive, add the following dependency to your pubspec.yaml
|
|
```
|
|
dependencies:
|
|
manager_api_new:
|
|
path: /path/to/manager_api_new
|
|
```
|
|
|
|
## Tests
|
|
|
|
TODO
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```dart
|
|
import 'package:manager_api_new/api.dart';
|
|
|
|
// TODO Configure OAuth2 access token for authorization: bearer
|
|
//defaultApiClient.getAuthentication<OAuth>('bearer').accessToken = 'YOUR_ACCESS_TOKEN';
|
|
|
|
final api_instance = AuthenticationApi();
|
|
final grantType = grantType_example; // String |
|
|
final username = username_example; // String |
|
|
final password = password_example; // String |
|
|
final clientId = clientId_example; // String |
|
|
final clientSecret = clientSecret_example; // String |
|
|
|
|
try {
|
|
final result = api_instance.authenticationAuthenticateWithForm(grantType, username, password, clientId, clientSecret);
|
|
print(result);
|
|
} catch (e) {
|
|
print('Exception when calling AuthenticationApi->authenticationAuthenticateWithForm: $e\n');
|
|
}
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost:5000*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*AuthenticationApi* | [**authenticationAuthenticateWithForm**](doc\/AuthenticationApi.md#authenticationauthenticatewithform) | **POST** /api/Authentication/Token |
|
|
*AuthenticationApi* | [**authenticationAuthenticateWithJson**](doc\/AuthenticationApi.md#authenticationauthenticatewithjson) | **POST** /api/Authentication/Authenticate |
|
|
*ConfigurationApi* | [**configurationCreate**](doc\/ConfigurationApi.md#configurationcreate) | **POST** /api/Configuration |
|
|
*ConfigurationApi* | [**configurationDelete**](doc\/ConfigurationApi.md#configurationdelete) | **DELETE** /api/Configuration/{id} |
|
|
*ConfigurationApi* | [**configurationExport**](doc\/ConfigurationApi.md#configurationexport) | **GET** /api/Configuration/{id}/export |
|
|
*ConfigurationApi* | [**configurationGet**](doc\/ConfigurationApi.md#configurationget) | **GET** /api/Configuration |
|
|
*ConfigurationApi* | [**configurationGetConfigurationsByPinCode**](doc\/ConfigurationApi.md#configurationgetconfigurationsbypincode) | **GET** /api/Configuration/byPin |
|
|
*ConfigurationApi* | [**configurationGetDetail**](doc\/ConfigurationApi.md#configurationgetdetail) | **GET** /api/Configuration/{id} |
|
|
*ConfigurationApi* | [**configurationImport**](doc\/ConfigurationApi.md#configurationimport) | **POST** /api/Configuration/import |
|
|
*ConfigurationApi* | [**configurationUpdate**](doc\/ConfigurationApi.md#configurationupdate) | **PUT** /api/Configuration |
|
|
*DeviceApi* | [**deviceCreate**](doc\/DeviceApi.md#devicecreate) | **POST** /api/Device |
|
|
*DeviceApi* | [**deviceDelete**](doc\/DeviceApi.md#devicedelete) | **DELETE** /api/Device/{id} |
|
|
*DeviceApi* | [**deviceGet**](doc\/DeviceApi.md#deviceget) | **GET** /api/Device |
|
|
*DeviceApi* | [**deviceGetDetail**](doc\/DeviceApi.md#devicegetdetail) | **GET** /api/Device/{id}/detail |
|
|
*DeviceApi* | [**deviceUpdate**](doc\/DeviceApi.md#deviceupdate) | **PUT** /api/Device |
|
|
*DeviceApi* | [**deviceUpdateMainInfos**](doc\/DeviceApi.md#deviceupdatemaininfos) | **PUT** /api/Device/mainInfos |
|
|
*InstanceApi* | [**instanceCreateInstance**](doc\/InstanceApi.md#instancecreateinstance) | **POST** /api/Instance |
|
|
*InstanceApi* | [**instanceDeleteInstance**](doc\/InstanceApi.md#instancedeleteinstance) | **DELETE** /api/Instance/{id} |
|
|
*InstanceApi* | [**instanceGet**](doc\/InstanceApi.md#instanceget) | **GET** /api/Instance |
|
|
*InstanceApi* | [**instanceGetDetail**](doc\/InstanceApi.md#instancegetdetail) | **GET** /api/Instance/{id} |
|
|
*InstanceApi* | [**instanceGetInstanceByPinCode**](doc\/InstanceApi.md#instancegetinstancebypincode) | **GET** /api/Instance/byPin |
|
|
*InstanceApi* | [**instanceUpdateinstance**](doc\/InstanceApi.md#instanceupdateinstance) | **PUT** /api/Instance |
|
|
*ResourceApi* | [**resourceCreate**](doc\/ResourceApi.md#resourcecreate) | **POST** /api/Resource |
|
|
*ResourceApi* | [**resourceDelete**](doc\/ResourceApi.md#resourcedelete) | **DELETE** /api/Resource/{id} |
|
|
*ResourceApi* | [**resourceGet**](doc\/ResourceApi.md#resourceget) | **GET** /api/Resource |
|
|
*ResourceApi* | [**resourceGetDetail**](doc\/ResourceApi.md#resourcegetdetail) | **GET** /api/Resource/{id}/detail |
|
|
*ResourceApi* | [**resourceShow**](doc\/ResourceApi.md#resourceshow) | **GET** /api/Resource/{id} |
|
|
*ResourceApi* | [**resourceUpdate**](doc\/ResourceApi.md#resourceupdate) | **PUT** /api/Resource |
|
|
*ResourceApi* | [**resourceUpload**](doc\/ResourceApi.md#resourceupload) | **POST** /api/Resource/upload |
|
|
*SectionApi* | [**sectionCreate**](doc\/SectionApi.md#sectioncreate) | **POST** /api/Section |
|
|
*SectionApi* | [**sectionDelete**](doc\/SectionApi.md#sectiondelete) | **DELETE** /api/Section/{id} |
|
|
*SectionApi* | [**sectionDeleteAllForConfiguration**](doc\/SectionApi.md#sectiondeleteallforconfiguration) | **DELETE** /api/Section/configuration/{id} |
|
|
*SectionApi* | [**sectionGet**](doc\/SectionApi.md#sectionget) | **GET** /api/Section |
|
|
*SectionApi* | [**sectionGetAgendaDTO**](doc\/SectionApi.md#sectiongetagendadto) | **GET** /api/Section/AgendaDTO |
|
|
*SectionApi* | [**sectionGetAllBeaconsForInstance**](doc\/SectionApi.md#sectiongetallbeaconsforinstance) | **GET** /api/Section/beacons/{instanceId} |
|
|
*SectionApi* | [**sectionGetAllSectionSubSections**](doc\/SectionApi.md#sectiongetallsectionsubsections) | **GET** /api/Section/{id}/subsections |
|
|
*SectionApi* | [**sectionGetArticleDTO**](doc\/SectionApi.md#sectiongetarticledto) | **GET** /api/Section/ArticleDTO |
|
|
*SectionApi* | [**sectionGetDetail**](doc\/SectionApi.md#sectiongetdetail) | **GET** /api/Section/{id} |
|
|
*SectionApi* | [**sectionGetFromConfiguration**](doc\/SectionApi.md#sectiongetfromconfiguration) | **GET** /api/Section/configuration/{id} |
|
|
*SectionApi* | [**sectionGetMapDTO**](doc\/SectionApi.md#sectiongetmapdto) | **GET** /api/Section/MapDTO |
|
|
*SectionApi* | [**sectionGetMenuDTO**](doc\/SectionApi.md#sectiongetmenudto) | **GET** /api/Section/MenuDTO |
|
|
*SectionApi* | [**sectionGetPdfDTO**](doc\/SectionApi.md#sectiongetpdfdto) | **GET** /api/Section/PdfDTO |
|
|
*SectionApi* | [**sectionGetPuzzleDTO**](doc\/SectionApi.md#sectiongetpuzzledto) | **GET** /api/Section/PuzzleDTO |
|
|
*SectionApi* | [**sectionGetQuizzDTO**](doc\/SectionApi.md#sectiongetquizzdto) | **GET** /api/Section/QuizzDTO |
|
|
*SectionApi* | [**sectionGetSliderDTO**](doc\/SectionApi.md#sectiongetsliderdto) | **GET** /api/Section/SliderDTO |
|
|
*SectionApi* | [**sectionGetVideoDTO**](doc\/SectionApi.md#sectiongetvideodto) | **GET** /api/Section/VideoDTO |
|
|
*SectionApi* | [**sectionGetWebDTO**](doc\/SectionApi.md#sectiongetwebdto) | **GET** /api/Section/WebDTO |
|
|
*SectionApi* | [**sectionPlayerMessageDTO**](doc\/SectionApi.md#sectionplayermessagedto) | **GET** /api/Section/PlayerMessageDTO |
|
|
*SectionApi* | [**sectionUpdate**](doc\/SectionApi.md#sectionupdate) | **PUT** /api/Section |
|
|
*SectionApi* | [**sectionUpdateOrder**](doc\/SectionApi.md#sectionupdateorder) | **PUT** /api/Section/order |
|
|
*UserApi* | [**userCreateUser**](doc\/UserApi.md#usercreateuser) | **POST** /api/User |
|
|
*UserApi* | [**userDeleteUser**](doc\/UserApi.md#userdeleteuser) | **DELETE** /api/User/{id} |
|
|
*UserApi* | [**userGet**](doc\/UserApi.md#userget) | **GET** /api/User |
|
|
*UserApi* | [**userGetDetail**](doc\/UserApi.md#usergetdetail) | **GET** /api/User/{id} |
|
|
*UserApi* | [**userUpdateUser**](doc\/UserApi.md#userupdateuser) | **PUT** /api/User |
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [AgendaDTO](doc\/AgendaDTO.md)
|
|
- [ArticleDTO](doc\/ArticleDTO.md)
|
|
- [CategorieDTO](doc\/CategorieDTO.md)
|
|
- [ConfigurationDTO](doc\/ConfigurationDTO.md)
|
|
- [ContentDTO](doc\/ContentDTO.md)
|
|
- [ContentGeoPoint](doc\/ContentGeoPoint.md)
|
|
- [DeviceDTO](doc\/DeviceDTO.md)
|
|
- [DeviceDetailDTO](doc\/DeviceDetailDTO.md)
|
|
- [DeviceDetailDTOAllOf](doc\/DeviceDetailDTOAllOf.md)
|
|
- [ExportConfigurationDTO](doc\/ExportConfigurationDTO.md)
|
|
- [ExportConfigurationDTOAllOf](doc\/ExportConfigurationDTOAllOf.md)
|
|
- [GeoPointDTO](doc\/GeoPointDTO.md)
|
|
- [GeoPointDTOCategorie](doc\/GeoPointDTOCategorie.md)
|
|
- [Instance](doc\/Instance.md)
|
|
- [InstanceDTO](doc\/InstanceDTO.md)
|
|
- [LevelDTO](doc\/LevelDTO.md)
|
|
- [LoginDTO](doc\/LoginDTO.md)
|
|
- [MapDTO](doc\/MapDTO.md)
|
|
- [MapTypeApp](doc\/MapTypeApp.md)
|
|
- [MenuDTO](doc\/MenuDTO.md)
|
|
- [PdfDTO](doc\/PdfDTO.md)
|
|
- [PlayerMessageDTO](doc\/PlayerMessageDTO.md)
|
|
- [PuzzleDTO](doc\/PuzzleDTO.md)
|
|
- [PuzzleDTOImage](doc\/PuzzleDTOImage.md)
|
|
- [QuestionDTO](doc\/QuestionDTO.md)
|
|
- [QuizzDTO](doc\/QuizzDTO.md)
|
|
- [QuizzDTOBadLevel](doc\/QuizzDTOBadLevel.md)
|
|
- [ResourceDTO](doc\/ResourceDTO.md)
|
|
- [ResourceType](doc\/ResourceType.md)
|
|
- [ResponseDTO](doc\/ResponseDTO.md)
|
|
- [SectionDTO](doc\/SectionDTO.md)
|
|
- [SectionType](doc\/SectionType.md)
|
|
- [SliderDTO](doc\/SliderDTO.md)
|
|
- [TokenDTO](doc\/TokenDTO.md)
|
|
- [TranslationDTO](doc\/TranslationDTO.md)
|
|
- [User](doc\/User.md)
|
|
- [UserDetailDTO](doc\/UserDetailDTO.md)
|
|
- [VideoDTO](doc\/VideoDTO.md)
|
|
- [WebDTO](doc\/WebDTO.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
### bearer
|
|
|
|
- **Type**: OAuth
|
|
- **Flow**: password
|
|
- **Authorization URL**: /authentication/Token
|
|
- **Scopes**:
|
|
- **Manager-api**: Manager WebAPI
|
|
|
|
|
|
## Author
|
|
|
|
|
|
|