SIMANDOU API Structures

Structure de l'API avec schémas de validation

66

Total Routes

20

Avec Query Schema

46

Avec Body Schema

POST /api/users
▶
Corps de la requĂȘte (createUserSchema)
Champ Type Optionnel
firstName string Non
lastName string Non
email string Non
password string Non
roleId number Non
ministryId number Non
phoneNumber string Oui
fonction string Oui
createdBy number Oui
GET /api/users/:id
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
roleId number Oui
isActive unknown Oui
PATCH /api/users/:id
▶
Corps de la requĂȘte (patchUserSchema)
Champ Type Optionnel
firstName string Oui
lastName string Oui
email string Oui
phoneNumber string Oui
roleId number Oui
ministryId number Oui
POST /api/roles
▶
Corps de la requĂȘte (createRoleSchema)
Champ Type Optionnel
code enum(SYSTEM_ADMIN, DELEGUE_GENERAL, DIRECTEUR_PILIER, COORDO_GENERAL, CHEF_PROJET, RESPONSABLE_PROJET, RESPONSABLE_SUIVIS, GUEST_VIP) Non
name string Non
description string Oui
createdBy number Oui
permissions array[object] Non
GET /api/roles/:id
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
isActive unknown Oui
PATCH /api/roles/:id
▶
Corps de la requĂȘte (patchRolePermissionsSchema)
Champ Type Optionnel
permissions array[object] Non
PATCH /api/roles/:id
▶
Corps de la requĂȘte (patchRoleSchema)
Champ Type Optionnel
code enum(SYSTEM_ADMIN, DELEGUE_GENERAL, DIRECTEUR_PILIER, COORDO_GENERAL, CHEF_PROJET, RESPONSABLE_PROJET, RESPONSABLE_SUIVIS, GUEST_VIP) Oui
name string Oui
description string Oui
PATCH /api/config/:id
▶
Corps de la requĂȘte (patchGeneralSchema)
Champ Type Optionnel
systemSigle string Oui
systemName string Oui
structureSigle string Oui
structureName string Oui
structureLogo string Oui
structureAddress string Oui
structureEmail string Oui
structureWhatsAppNumber string Oui
structurePhoneNumber string Oui
localCurrencySigle string Oui
mainCurrencySigle string Oui
mainCurrencyRate unknown Oui
isMaintenance boolean Oui
delayUpdateSecond unknown Oui
PATCH /api/config/:id
▶
Corps de la requĂȘte (patchNotificationsSchema)
Champ Type Optionnel
notifEmailUser string Oui
notifEmailPassword string Oui
notifEmailSmtpHost string Oui
notifEmailSmtpPort number Oui
notifEmailSmtpEncryption enum(tls, ssl, none) Oui
notifEmailFromName string Oui
PATCH /api/config/:id
▶
Corps de la requĂȘte (patchParentApiSchema)
Champ Type Optionnel
parentApiUrl string Oui
parentApiKey string Oui
parentApiSecret string Oui
parentApiTimeoutSeconds number Oui
PATCH /api/config/:id
▶
Corps de la requĂȘte (patchSecuritySchema)
Champ Type Optionnel
inactivityMinute number Oui
maxSessions number Oui
maxLoginAttempts number Oui
otpValidityMinute number Oui
passwordExpiryMonth number Oui
PATCH /api/config/:id
▶
Corps de la requĂȘte (patchWhatsAppSchema)
Champ Type Optionnel
whatsAppInstance string Oui
whatsAppApiKey string Oui
whatsAppNumberId string Oui
POST /api/zones
▶
Corps de la requĂȘte (createZoneSchema)
Champ Type Optionnel
code string Oui
name string Non
type enum(REGION, PREFECTURE, COMMUNE, SOUS_PREFECTURE, DISTRICT, LOCALITE) Non
parentId number Oui
latitude number Oui
longitude number Oui
shapefile string Oui
description string Oui
createdBy number Oui
GET /api/zones/:id
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
type enum(REGION, PREFECTURE, COMMUNE, SOUS_PREFECTURE, DISTRICT, LOCALITE) Oui
parentId number Oui
PATCH /api/zones/:id
▶
Corps de la requĂȘte (patchZoneSchema)
Champ Type Optionnel
code string Oui
name string Oui
type enum(REGION, PREFECTURE, COMMUNE, SOUS_PREFECTURE, DISTRICT, LOCALITE) Oui
parentId number Oui
latitude number Oui
longitude number Oui
shapefile string Oui
description string Oui
POST /api/ministries
▶
Corps de la requĂȘte (createMinistrySchema)
Champ Type Optionnel
name string Non
code string Non
description string Oui
createdBy number Oui
GET /api/ministries
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
code string Oui
PATCH /api/ministries/:id
▶
Corps de la requĂȘte (patchMinistrySchema)
Champ Type Optionnel
name string Oui
code string Oui
description string Oui
GET /api/cellules
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
ministryId string Oui
coordinatorId string Oui
POST /api/cellules
▶
Corps de la requĂȘte (createCelluleSchema)
Champ Type Optionnel
ministryId number Non
coordinatorId number Oui
name string Non
memberIds array[number] Non
createdBy number Oui
PATCH /api/cellules/:id
▶
Corps de la requĂȘte (patchCelluleSchema)
Champ Type Optionnel
ministryId number Oui
coordinatorId number Oui
name string Oui
POST /api/sectors
▶
Corps de la requĂȘte (createSectorSchema)
Champ Type Optionnel
name string Non
description string Oui
createdBy number Oui
PATCH /api/sectors/:id
▶
Corps de la requĂȘte (patchSectorSchema)
Champ Type Optionnel
name string Oui
description string Oui
GET /api/sectors
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
POST /api/pillars
▶
Corps de la requĂȘte (createPillarSchema)
Champ Type Optionnel
code string Non
name string Non
description string Oui
directorId number Oui
order number Oui
createdBy number Oui
PATCH /api/pillars/:id
▶
Corps de la requĂȘte (patchPillarSchema)
Champ Type Optionnel
code string Oui
name string Oui
description string Oui
directorId number Oui
order number Oui
GET /api/pillars
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
directorId string Oui
POST /api/mega-projects
▶
Corps de la requĂȘte (createMegaProjectSchema)
Champ Type Optionnel
pillarId number Non
code string Non
name string Non
description string Non
objectives string Oui
impacts string Oui
location array[number] Oui
responsibleId number Oui
startDate string Oui
endDate string Oui
status enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
createdBy number Oui
GET /api/mega-projects
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
pillarId string Oui
responsibleId string Oui
status string Oui
PATCH /api/mega-projects/:id
▶
Corps de la requĂȘte (patchMegaProjectSchema)
Champ Type Optionnel
pillarId number Oui
code string Oui
name string Oui
description string Oui
objectives string Oui
impacts string Oui
location array[number] Oui
responsibleId number Oui
startDate string Oui
endDate string Oui
status enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
POST /api/projects
▶
Corps de la requĂȘte (createProjectSchema)
Champ Type Optionnel
ministryId number Non
pillarId number Non
megaProjectId number Non
sectorId number Non
code string Non
name string Non
description string Non
objectives string Oui
impacts string Oui
wave string Oui
nature enum(PROJECT, REFORM) Oui
startDate string Oui
endDate string Oui
totalBudget number Oui
amountToMobilizeWave number Oui
financingStatus enum(NOT_OBTAINED, PENDING, PARTIALLY_OBTAINED, OBTAINED) Oui
globalStatus enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
executionStatus enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
existingSheet boolean Oui
feasibilityStudy enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
aps enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
apd enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
delegatOwner number Oui
delegatManager number Oui
responsibleId number Oui
createdBy number Oui
location array[number] Oui
file unknown Oui
PATCH /api/projects/:id
▶
Corps de la requĂȘte (patchProjectSchema)
Champ Type Optionnel
ministryId number Oui
pillarId number Oui
megaProjectId number Oui
sectorId number Oui
code string Oui
name string Oui
description string Oui
objectives string Oui
impacts string Oui
wave string Oui
nature enum(PROJECT, REFORM) Oui
startDate string Oui
endDate string Oui
totalBudget number Oui
amountToMobilizeWave number Oui
financingStatus enum(NOT_OBTAINED, PENDING, PARTIALLY_OBTAINED, OBTAINED) Oui
globalStatus enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
executionStatus enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
existingSheet boolean Oui
feasibilityStudy enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
aps enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
apd enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
delegatOwner number Oui
delegatManager number Oui
responsibleId number Oui
location array[number] Oui
file unknown Oui
GET /api/projects
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
ministryId number Oui
pillarId number Oui
megaProjectId number Oui
sectorId number Oui
delegatOwner number Oui
delegatManager number Oui
responsibleId number Oui
globalStatus enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
executionStatus enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
financingStatus enum(NOT_OBTAINED, PENDING, PARTIALLY_OBTAINED, OBTAINED) Oui
POST /api/reforms
▶
Corps de la requĂȘte (createReformSchema)
Champ Type Optionnel
pillarId number Non
ministryId number Non
code string Non
name string Non
description string Non
objectives string Oui
impacts string Oui
sectorId number Oui
location array[number] Oui
wave string Oui
startDate string Oui
endDate string Oui
existingSheet boolean Oui
summaryStudy enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
detailedWriting enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
financingStudy enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
draftingAdoption enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
progress number Oui
globalStatus enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
executionStatus enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
responsibleId number Oui
createdBy number Oui
PATCH /api/reforms/:id
▶
Corps de la requĂȘte (patchReformSchema)
Champ Type Optionnel
pillarId number Oui
ministryId number Oui
code string Oui
name string Oui
description string Oui
objectives string Oui
impacts string Oui
sectorId number Oui
location array[number] Oui
wave string Oui
startDate string Oui
endDate string Oui
existingSheet boolean Oui
summaryStudy enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
detailedWriting enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
financingStudy enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
draftingAdoption enum(TO_PLAN, PLANNED, PROGRESS, COMPLETED, NA) Oui
progress number Oui
globalStatus enum(ON_TRACK, POTENTIAL_DELAY, CONFIRMED_DELAY) Oui
executionStatus enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
responsibleId number Oui
GET /api/reforms
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
pillarId string Oui
ministryId string Oui
sectorId string Oui
responsibleId string Oui
globalStatus string Oui
executionStatus string Oui
POST /api/project-components
▶
Corps de la requĂȘte (createProjectComponentSchema)
Champ Type Optionnel
projectId number Non
name string Non
description string Oui
startDate string Oui
endDate string Oui
order number Oui
createdBy number Oui
PATCH /api/project-components/:id
▶
Corps de la requĂȘte (patchProjectComponentSchema)
Champ Type Optionnel
projectId number Oui
name string Oui
description string Oui
startDate string Oui
endDate string Oui
order number Oui
GET /api/project-components
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId string Oui
search string Oui
GET /api/component-activities
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
componentId string Oui
responsibleId string Oui
status string Oui
search string Oui
POST /api/component-activities
▶
Corps de la requĂȘte (createComponentActivitySchema)
Champ Type Optionnel
componentId number Non
name string Non
description string Oui
startDate string Oui
endDate string Oui
progress number Oui
responsibleId number Oui
status enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
order number Oui
createdBy number Oui
PATCH /api/component-activities/:id
▶
Corps de la requĂȘte (patchComponentActivitySchema)
Champ Type Optionnel
componentId number Oui
name string Oui
description string Oui
startDate string Oui
endDate string Oui
progress number Oui
responsibleId number Oui
status enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
order number Oui
POST /api/project-indicateurs
▶
Corps de la requĂȘte (createProjectIndicateurSchema)
Champ Type Optionnel
projectId number Non
name string Non
unite string Oui
baselineValue number Oui
targetValue number Oui
currentValue number Oui
frequency enum(DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, YEARLY) Oui
createdBy number Oui
PATCH /api/project-indicateurs/:id
▶
Corps de la requĂȘte (patchProjectIndicateurSchema)
Champ Type Optionnel
projectId number Oui
name string Oui
unite string Oui
baselineValue number Oui
targetValue number Oui
currentValue number Oui
frequency enum(DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMIANNUAL, YEARLY) Oui
GET /api/project-indicateurs
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId string Oui
search string Oui
POST /api/project-milestones
▶
Corps de la requĂȘte (createProjectMilestoneSchema)
Champ Type Optionnel
projectId number Non
name string Non
description string Oui
dueDate string Oui
completedAt string Oui
status enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
createdBy number Oui
PATCH /api/project-milestones/:id
▶
Corps de la requĂȘte (patchProjectMilestoneSchema)
Champ Type Optionnel
projectId number Oui
name string Oui
description string Oui
dueDate string Oui
completedAt string Oui
status enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
GET /api/project-milestones
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId string Oui
status string Oui
search string Oui
GET /api/activity-suivis
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
activityId string Oui
responsableId string Oui
status string Oui
reportDate string Oui
POST /api/activity-suivis
▶
Corps de la requĂȘte (createActivitySuiviSchema)
Champ Type Optionnel
activityId number Non
responsableId number Oui
progress number Oui
status enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
achievements string Oui
difficulties string Oui
nextActions string Oui
deliverables string Oui
reportDate string Oui
createdBy number Oui
PATCH /api/activity-suivis/:id
▶
Corps de la requĂȘte (patchActivitySuiviSchema)
Champ Type Optionnel
activityId number Oui
responsableId number Oui
progress number Oui
status enum(NOT_STARTED, PROGRESS, PENDING, COMPLETED, CANCELLED) Oui
achievements string Oui
difficulties string Oui
nextActions string Oui
deliverables string Oui
reportDate string Oui
POST /api/project-financing
▶
Corps de la requĂȘte (createProjectFinancingSchema)
Champ Type Optionnel
projectId number Non
donorId number Non
source enum(STATE, PRIVATE, PTF, FSG) Oui
amount number Non
amountYear number Non
disbursed boolean Oui
disbursedAt string Oui
createdBy number Oui
PATCH /api/project-financing/:id
▶
Corps de la requĂȘte (patchProjectFinancingSchema)
Champ Type Optionnel
projectId number Oui
donorId number Oui
source enum(STATE, PRIVATE, PTF, FSG) Oui
amount number Oui
amountYear number Oui
disbursed boolean Oui
disbursedAt string Oui
GET /api/project-financing
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId string Oui
donorId string Oui
source string Oui
amountYear string Oui
disbursed string Oui
POST /api/project-disburses
▶
Corps de la requĂȘte (createProjectDisburseSchema)
Champ Type Optionnel
projectId number Non
componentId number Non
financingId number Non
amount number Non
disburseDate string Non
description string Oui
createdBy number Oui
PATCH /api/project-disburses/:id
▶
Corps de la requĂȘte (patchProjectDisburseSchema)
Champ Type Optionnel
projectId number Oui
componentId number Oui
financingId number Oui
amount number Oui
disburseDate string Oui
description string Oui
GET /api/project-disburses
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId string Oui
componentId string Oui
financingId string Oui
disburseDate string Oui
POST /api/project-projections
▶
Corps de la requĂȘte (createProjectProjectionSchema)
Champ Type Optionnel
projectId number Non
componentId number Oui
projectionDate string Non
plannedProgress number Non
plannedBudget number Oui
plannedDisbursed number Oui
version number Oui
comment string Oui
createdBy number Oui
PATCH /api/project-projections/:id
▶
Corps de la requĂȘte (patchProjectProjectionSchema)
Champ Type Optionnel
projectId number Oui
componentId number Oui
projectionDate string Oui
plannedProgress number Oui
plannedBudget number Oui
plannedDisbursed number Oui
version number Oui
comment string Oui
GET /api/project-projections
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId string Oui
componentId string Oui
projectionDate string Oui
version string Oui
POST /api/donors
▶
Corps de la requĂȘte (createDonorSchema)
Champ Type Optionnel
code string Non
name string Non
description string Oui
website string | [""] Non
isActive boolean Oui
createdBy number Oui
GET /api/donors
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
search string Oui
isActive string Oui
PATCH /api/donors/:id
▶
Corps de la requĂȘte (patchDonorSchema)
Champ Type Optionnel
code string Oui
name string Oui
description string Oui
website string | [""] Non
isActive boolean Oui
POST /api/documents
▶
Corps de la requĂȘte (createDocumentSchema)
Champ Type Optionnel
projectId number Oui
reformId number Oui
fileName string Non
filePath string Non
fileType string Non
fileSize number Oui
category string Oui
GET /api/documents/:id
▶
ParamĂštres de requĂȘte
Champ Type Optionnel
projectId number Oui
reformId number Oui
category string Oui
fileType string Oui
PATCH /api/documents/:id
▶
Corps de la requĂȘte (patchDocumentSchema)
Champ Type Optionnel
projectId number Oui
reformId number Oui
fileName string Oui
filePath string Oui
fileType string Oui
fileSize number Oui
category string Oui
← Retour à l'Accueil