manager-app/lib/api/swagger.yaml
2024-02-28 12:01:25 +01:00

2542 lines
58 KiB
YAML

x-generator: NSwag v13.10.8.0 (NJsonSchema v10.3.11.0 (Newtonsoft.Json v10.0.0.0))
openapi: 3.0.0
info:
title: Manager Service
description: API Manager Service
version: Version Alpha
servers:
- url: https://api.myinfomate.be
paths:
/api/Configuration:
get:
tags:
- Configuration
operationId: Configuration_Get
parameters:
- name: instanceId
in: query
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigurationDTO'
'500':
description: ''
content:
application/json:
schema:
type: string
post:
tags:
- Configuration
operationId: Configuration_Create
requestBody:
x-name: newConfiguration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
put:
tags:
- Configuration
operationId: Configuration_Update
requestBody:
x-name: updatedConfiguration
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Configuration/byPin:
get:
tags:
- Configuration
operationId: Configuration_GetConfigurationsByPinCode
parameters:
- name: pinCode
in: query
schema:
type: integer
format: int32
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ConfigurationDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Configuration/{id}:
get:
tags:
- Configuration
operationId: Configuration_GetDetail
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
delete:
tags:
- Configuration
operationId: Configuration_Delete
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Configuration/{id}/export:
get:
tags:
- Configuration
operationId: Configuration_Export
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
- name: language
in: query
schema:
type: string
nullable: true
x-position: 2
responses:
'200':
description: ''
content:
application/octet-stream:
schema:
type: string
format: binary
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Configuration/import:
post:
tags:
- Configuration
operationId: Configuration_Import
requestBody:
x-name: exportConfiguration
content:
application/json:
schema:
$ref: '#/components/schemas/ExportConfigurationDTO'
required: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Device:
get:
tags:
- Device
operationId: Device_Get
parameters:
- name: instanceId
in: query
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DeviceDTO'
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
post:
tags:
- Device
operationId: Device_Create
requestBody:
x-name: newDevice
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
put:
tags:
- Device
operationId: Device_Update
requestBody:
x-name: updatedDevice
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Device/{id}/detail:
get:
tags:
- Device
operationId: Device_GetDetail
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDetailDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Device/mainInfos:
put:
tags:
- Device
operationId: Device_UpdateMainInfos
requestBody:
x-name: deviceIn
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Device/{id}:
delete:
tags:
- Device
operationId: Device_Delete
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Instance:
get:
tags:
- Instance
operationId: Instance_Get
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Instance'
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
post:
tags:
- Instance
operationId: Instance_CreateInstance
requestBody:
x-name: newInstance
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
put:
tags:
- Instance
operationId: Instance_Updateinstance
requestBody:
x-name: updatedInstance
content:
application/json:
schema:
$ref: '#/components/schemas/Instance'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Instance/{id}:
get:
tags:
- Instance
operationId: Instance_GetDetail
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
delete:
tags:
- Instance
operationId: Instance_DeleteInstance
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Instance/byPin:
get:
tags:
- Instance
operationId: Instance_GetInstanceByPinCode
parameters:
- name: pinCode
in: query
schema:
type: integer
format: int32
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Resource:
get:
tags:
- Resource
operationId: Resource_Get
parameters:
- name: instanceId
in: query
schema:
type: string
nullable: true
x-position: 1
- name: types
in: query
style: form
explode: true
schema:
type: array
nullable: true
items:
$ref: '#/components/schemas/ResourceType'
x-position: 2
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ResourceDTO'
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
post:
tags:
- Resource
operationId: Resource_Create
requestBody:
x-name: newResource
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
put:
tags:
- Resource
operationId: Resource_Update
requestBody:
x-name: updatedResource
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Resource/{id}/detail:
get:
tags:
- Resource
operationId: Resource_GetDetail
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Resource/{id}:
get:
tags:
- Resource
operationId: Resource_Show
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
delete:
tags:
- Resource
operationId: Resource_Delete
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Resource/upload:
post:
tags:
- Resource
operationId: Resource_Upload
requestBody:
content:
multipart/form-data:
schema:
properties:
label:
type: string
nullable: true
type:
type: string
nullable: true
instanceId:
type: string
nullable: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Section:
get:
tags:
- Section
operationId: Section_Get
parameters:
- name: instanceId
in: query
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SectionDTO'
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
post:
tags:
- Section
operationId: Section_Create
requestBody:
x-name: newSection
content:
application/json:
schema:
$ref: '#/components/schemas/SectionDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SectionDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
put:
tags:
- Section
operationId: Section_Update
requestBody:
x-name: updatedSection
content:
application/json:
schema:
$ref: '#/components/schemas/SectionDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SectionDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Section/configuration/{id}:
get:
tags:
- Section
operationId: Section_GetFromConfiguration
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SectionDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
delete:
tags:
- Section
operationId: Section_DeleteAllForConfiguration
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Section/{id}/subsections:
get:
tags:
- Section
operationId: Section_GetAllSectionSubSections
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items: {}
'400':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Section/{id}:
get:
tags:
- Section
operationId: Section_GetDetail
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SectionDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
delete:
tags:
- Section
operationId: Section_Delete
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Section/beacons/{instanceId}:
get:
tags:
- Section
operationId: Section_GetAllBeaconsForInstance
parameters:
- name: instanceId
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SectionDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Section/order:
put:
tags:
- Section
operationId: Section_UpdateOrder
requestBody:
x-name: updatedSectionsOrder
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SectionDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Section/MapDTO:
get:
tags:
- Section
operationId: Section_GetMapDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MapDTO'
security:
- bearer: []
/api/Section/SliderDTO:
get:
tags:
- Section
operationId: Section_GetSliderDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/SliderDTO'
security:
- bearer: []
/api/Section/VideoDTO:
get:
tags:
- Section
operationId: Section_GetVideoDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/VideoDTO'
security:
- bearer: []
/api/Section/WebDTO:
get:
tags:
- Section
operationId: Section_GetWebDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/WebDTO'
security:
- bearer: []
/api/Section/MenuDTO:
get:
tags:
- Section
operationId: Section_GetMenuDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MenuDTO'
security:
- bearer: []
/api/Section/PlayerMessageDTO:
get:
tags:
- Section
operationId: Section_PlayerMessageDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PlayerMessageDTO'
security:
- bearer: []
/api/Section/QuizzDTO:
get:
tags:
- Section
operationId: Section_GetQuizzDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/QuizzDTO'
security:
- bearer: []
/api/Section/ArticleDTO:
get:
tags:
- Section
operationId: Section_GetArticleDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ArticleDTO'
security:
- bearer: []
/api/Section/PdfDTO:
get:
tags:
- Section
operationId: Section_GetPdfDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PdfDTO'
security:
- bearer: []
/api/Section/PuzzleDTO:
get:
tags:
- Section
operationId: Section_GetPuzzleDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PuzzleDTO'
security:
- bearer: []
/api/Section/AgendaDTO:
get:
tags:
- Section
operationId: Section_GetAgendaDTO
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AgendaDTO'
security:
- bearer: []
/api/User:
get:
tags:
- User
operationId: User_Get
responses:
'200':
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
post:
tags:
- User
operationId: User_CreateUser
requestBody:
x-name: newUser
content:
application/json:
schema:
$ref: '#/components/schemas/User'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'409':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
put:
tags:
- User
operationId: User_UpdateUser
requestBody:
x-name: updatedUser
content:
application/json:
schema:
$ref: '#/components/schemas/User'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailDTO'
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/User/{id}:
get:
tags:
- User
operationId: User_GetDetail
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/UserDetailDTO'
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
delete:
tags:
- User
operationId: User_DeleteUser
parameters:
- name: id
in: path
required: true
schema:
type: string
nullable: true
x-position: 1
responses:
'202':
description: ''
content:
application/json:
schema:
type: string
'400':
description: ''
content:
application/json:
schema:
type: string
'404':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
security:
- bearer: []
/api/Authentication/Token:
post:
tags:
- Authentication
operationId: Authentication_AuthenticateWithForm
requestBody:
content:
multipart/form-data:
schema:
properties:
grant_type:
type: string
nullable: true
username:
type: string
nullable: true
password:
type: string
nullable: true
client_id:
type: string
nullable: true
client_secret:
type: string
nullable: true
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TokenDTO'
'401':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
/api/Authentication/Authenticate:
post:
tags:
- Authentication
operationId: Authentication_AuthenticateWithJson
requestBody:
x-name: login
content:
application/json:
schema:
$ref: '#/components/schemas/LoginDTO'
required: true
x-position: 1
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/TokenDTO'
'401':
description: ''
content:
application/json:
schema:
type: string
'500':
description: ''
content:
application/json:
schema:
type: string
components:
schemas:
ConfigurationDTO:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
label:
type: string
nullable: true
title:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
imageId:
type: string
nullable: true
imageSource:
type: string
nullable: true
primaryColor:
type: string
nullable: true
secondaryColor:
type: string
nullable: true
languages:
type: array
nullable: true
items:
type: string
dateCreation:
type: string
format: date-time
isMobile:
type: boolean
isTablet:
type: boolean
isOffline:
type: boolean
instanceId:
type: string
nullable: true
sectionIds:
type: array
nullable: true
items:
type: string
loaderImageId:
type: string
nullable: true
loaderImageUrl:
type: string
nullable: true
weatherCity:
type: string
nullable: true
weatherUpdatedDate:
type: string
format: date-time
nullable: true
weatherResult:
type: string
nullable: true
isWeather:
type: boolean
isDate:
type: boolean
isHour:
type: boolean
TranslationDTO:
type: object
additionalProperties: false
properties:
language:
type: string
nullable: true
value:
type: string
nullable: true
ExportConfigurationDTO:
allOf:
- $ref: '#/components/schemas/ConfigurationDTO'
- type: object
additionalProperties: false
properties:
sections:
type: array
nullable: true
items:
$ref: '#/components/schemas/SectionDTO'
resources:
type: array
nullable: true
items:
$ref: '#/components/schemas/ResourceDTO'
SectionDTO:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
label:
type: string
nullable: true
title:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
description:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
imageId:
type: string
nullable: true
imageSource:
type: string
nullable: true
configurationId:
type: string
nullable: true
isSubSection:
type: boolean
parentId:
type: string
nullable: true
type:
$ref: '#/components/schemas/SectionType'
data:
type: string
nullable: true
dateCreation:
type: string
format: date-time
order:
type: integer
format: int32
nullable: true
instanceId:
type: string
nullable: true
latitude:
type: string
nullable: true
longitude:
type: string
nullable: true
meterZoneGPS:
type: integer
format: int32
nullable: true
isBeacon:
type: boolean
beaconId:
type: integer
format: int32
nullable: true
SectionType:
type: integer
description: |-
0 = Map
1 = Slider
2 = Video
3 = Web
4 = Menu
5 = Quizz
6 = Article
7 = PDF
8 = Puzzle
9 = Agenda
x-enumNames:
- Map
- Slider
- Video
- Web
- Menu
- Quizz
- Article
- PDF
- Puzzle
- Agenda
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
ResourceDTO:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
type:
$ref: '#/components/schemas/ResourceType'
label:
type: string
nullable: true
url:
type: string
nullable: true
dateCreation:
type: string
format: date-time
instanceId:
type: string
nullable: true
ResourceType:
type: integer
description: |-
0 = Image
1 = Video
2 = ImageUrl
3 = VideoUrl
4 = Audio
5 = PDF
6 = JSON
7 = JSONUrl
x-enumNames:
- Image
- Video
- ImageUrl
- VideoUrl
- Audio
- PDF
- JSON
- JSONUrl
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 6
- 7
DeviceDTO:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
identifier:
type: string
nullable: true
name:
type: string
nullable: true
ipAddressWLAN:
type: string
nullable: true
ipAddressETH:
type: string
nullable: true
configurationId:
type: string
nullable: true
configuration:
type: string
nullable: true
connected:
type: boolean
dateCreation:
type: string
format: date-time
dateUpdate:
type: string
format: date-time
instanceId:
type: string
nullable: true
DeviceDetailDTO:
allOf:
- $ref: '#/components/schemas/DeviceDTO'
- type: object
additionalProperties: false
properties:
connectionLevel:
type: string
nullable: true
lastConnectionLevel:
type: string
format: date-time
batteryLevel:
type: string
nullable: true
lastBatteryLevel:
type: string
format: date-time
Instance:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
name:
type: string
nullable: true
dateCreation:
type: string
format: date-time
pinCode:
type: integer
format: int32
nullable: true
InstanceDTO:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
name:
type: string
nullable: true
dateCreation:
type: string
format: date-time
pinCode:
type: integer
format: int32
nullable: true
MapDTO:
type: object
additionalProperties: false
properties:
zoom:
type: integer
format: int32
mapType:
$ref: '#/components/schemas/MapTypeApp'
points:
type: array
nullable: true
items:
$ref: '#/components/schemas/GeoPointDTO'
iconResourceId:
type: string
nullable: true
iconSource:
type: string
nullable: true
categories:
type: array
nullable: true
items:
$ref: '#/components/schemas/CategorieDTO'
MapTypeApp:
type: integer
description: |-
0 = none
1 = normal
2 = satellite
3 = terrain
4 = hybrid
x-enumNames:
- none
- normal
- satellite
- terrain
- hybrid
enum:
- 0
- 1
- 2
- 3
- 4
GeoPointDTO:
type: object
additionalProperties: false
properties:
id:
type: integer
format: int32
title:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
description:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
contents:
type: array
nullable: true
items:
$ref: '#/components/schemas/ContentGeoPoint'
categorie:
nullable: true
oneOf:
- $ref: '#/components/schemas/CategorieDTO'
latitude:
type: string
nullable: true
longitude:
type: string
nullable: true
ContentGeoPoint:
type: object
additionalProperties: false
properties:
resourceId:
type: string
nullable: true
resourceType:
$ref: '#/components/schemas/ResourceType'
resourceUrl:
type: string
nullable: true
resourceName:
type: string
nullable: true
CategorieDTO:
type: object
additionalProperties: false
properties:
label:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
icon:
type: string
nullable: true
iconResourceId:
type: string
nullable: true
iconUrl:
type: string
nullable: true
order:
type: integer
format: int32
nullable: true
SliderDTO:
type: object
additionalProperties: false
properties:
contents:
type: array
nullable: true
items:
$ref: '#/components/schemas/ContentDTO'
ContentDTO:
type: object
additionalProperties: false
properties:
title:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
description:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
resourceId:
type: string
nullable: true
resourceUrl:
type: string
nullable: true
order:
type: integer
format: int32
resourceType:
$ref: '#/components/schemas/ResourceType'
VideoDTO:
type: object
additionalProperties: false
properties:
source:
type: string
nullable: true
WebDTO:
type: object
additionalProperties: false
properties:
source:
type: string
nullable: true
MenuDTO:
type: object
additionalProperties: false
properties:
sections:
type: array
nullable: true
items:
$ref: '#/components/schemas/SectionDTO'
PlayerMessageDTO:
type: object
additionalProperties: false
properties:
configChanged:
type: boolean
isDeleted:
type: boolean
QuizzDTO:
type: object
additionalProperties: false
properties:
questions:
type: array
nullable: true
items:
$ref: '#/components/schemas/QuestionDTO'
bad_level:
nullable: true
oneOf:
- $ref: '#/components/schemas/LevelDTO'
medium_level:
nullable: true
oneOf:
- $ref: '#/components/schemas/LevelDTO'
good_level:
nullable: true
oneOf:
- $ref: '#/components/schemas/LevelDTO'
great_level:
nullable: true
oneOf:
- $ref: '#/components/schemas/LevelDTO'
QuestionDTO:
type: object
additionalProperties: false
properties:
label:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationAndResourceDTO'
responses:
type: array
nullable: true
items:
$ref: '#/components/schemas/ResponseDTO'
imageBackgroundResourceId:
type: string
nullable: true
imageBackgroundResourceType:
$ref: '#/components/schemas/ResourceType'
imageBackgroundResourceUrl:
type: string
nullable: true
order:
type: integer
format: int32
TranslationAndResourceDTO:
type: object
additionalProperties: false
properties:
language:
type: string
nullable: true
value:
type: string
nullable: true
resourceId:
type: string
nullable: true
resourceType:
nullable: true
oneOf:
- $ref: '#/components/schemas/ResourceType'
resourceUrl:
type: string
nullable: true
ResponseDTO:
type: object
additionalProperties: false
properties:
label:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationAndResourceDTO'
isGood:
type: boolean
order:
type: integer
format: int32
LevelDTO:
type: object
additionalProperties: false
properties:
label:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationAndResourceDTO'
ArticleDTO:
type: object
additionalProperties: false
properties:
content:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
isContentTop:
type: boolean
audioIds:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
isReadAudioAuto:
type: boolean
contents:
type: array
nullable: true
items:
$ref: '#/components/schemas/ContentDTO'
PdfDTO:
type: object
additionalProperties: false
properties:
resourceId:
type: string
nullable: true
resourceUrl:
type: string
nullable: true
PuzzleDTO:
type: object
additionalProperties: false
properties:
messageDebut:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationAndResourceDTO'
messageFin:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationAndResourceDTO'
image:
nullable: true
oneOf:
- $ref: '#/components/schemas/ContentDTO'
rows:
type: integer
format: int32
cols:
type: integer
format: int32
AgendaDTO:
type: object
additionalProperties: false
properties:
resourceIds:
type: array
nullable: true
items:
$ref: '#/components/schemas/TranslationDTO'
User:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
email:
type: string
nullable: true
password:
type: string
nullable: true
firstName:
type: string
nullable: true
lastName:
type: string
nullable: true
token:
type: string
nullable: true
dateCreation:
type: string
format: date-time
instanceId:
type: string
nullable: true
UserDetailDTO:
type: object
additionalProperties: false
properties:
id:
type: string
nullable: true
email:
type: string
nullable: true
firstName:
type: string
nullable: true
lastName:
type: string
nullable: true
TokenDTO:
type: object
additionalProperties: false
properties:
access_token:
type: string
nullable: true
refresh_token:
type: string
nullable: true
scope:
type: string
nullable: true
token_type:
type: string
nullable: true
expires_in:
type: integer
format: int32
expiration:
type: string
format: date-time
instanceId:
type: string
nullable: true
pinCode:
type: integer
format: int32
nullable: true
LoginDTO:
type: object
additionalProperties: false
properties:
email:
type: string
nullable: true
password:
type: string
nullable: true
securitySchemes:
bearer:
type: oauth2
description: Manager Authentication
flows:
password:
authorizationUrl: /authentication/Token
tokenUrl: /api/authentication/Token
scopes:
Manager-api: Manager WebAPI
security:
- bearer: []
tags:
- name: Configuration
description: Configuration management
- name: Device
description: Device management
- name: Instance
description: Instance management
- name: Resource
description: Resource management
- name: Section
description: Section management
- name: User
description: User management
- name: Authentication
description: Authentication management