diff --git a/docs/ecolyo/project_architecture/doctypes.md b/docs/ecolyo/project_architecture/doctypes.md index ecd2c8e402ae7e98b1ba598dc9e160793b41f28f..bbbf9b7413174a70dc42a331eb3d92292d6a70e1 100644 --- a/docs/ecolyo/project_architecture/doctypes.md +++ b/docs/ecolyo/project_architecture/doctypes.md @@ -437,11 +437,35 @@ This doctype is used to store all explorations. ### Structure -| Field | Type | Description | -| ----------- | -------------------- | ---------------------------------------------------------------------------------------------------------------- | -| \_id | string | exploration id - respect the format _EXPLORATION00X_ | -| state | UserExplorationState | State of the exploration<br><br>UserExplorationState enum<br>- _UNLOCKED = 0_<br>- _ONGOING = 1_<br>- _DONE = 2_ | -| description | string | description of the exploration | +| Field | Type | Description | +| --------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| \_id | string | exploration id - respect the format _EXPLORATION00X_ | +| state | UserExplorationState | State of the exploration<br><br>UserExplorationState enum<br>- _UNLOCKED = 0_<br>- _ONGOING = 1_<br>- _DONE = 2_ | +| description | string | description of the exploration | +| target | number | number of stars required to unlock an exploration | +| type | UserExplorationType | type of the exploration<br><br>UserExplorationType enum<br>- _DECLARATIVE = 0_<br>- _ACTION = 1_<br>- _CONSUMPTION = 2_<br>- _ECOGESTURE = 3_ | +| date | string or null | date of the exploration | +| ecogesture_id | string | ecogesture's id | +| fluid_condition | FluidType[] | Array of fluid type on which an exploration can have an impact<br><br>_FluidType enum:_<br>- _ELECTRICITY = 0_<br>- _WATER = 1_<br>- _GAS = 2_<br>- _MULTIFLUID = 3_ | +| priority_by_condition | number | priority order | +| message_success | string | message when exploration is done | + +### Example + +``` + { + "_id": "EXPLORATION001", + "description": "Consultez l'écogeste Chat échaudé", + "target": 1, + "type": 3, + "date": null, + "ecogesture_id": "0032", + "fluid_condition": [], + "priority_by_condition": 1, + "message_success": "Vous avez consulté l'écogeste Chat échaudé", + "state": 0, + } +``` ## Duel