openapi: 3.0.3
info:
title: 'Programmes 31 Jours - API'
description: "Documentation de l'API de l'application Programme 31 Jours"
version: 1.0.0
servers:
-
url: 'https://api-prog31jours.charisma.fr'
paths:
/api/logout:
post:
summary: 'POST /api/logout'
description: "Logout the user's session"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '01 - User Authentication'
/api/profile:
get:
summary: 'GET /api/userinfo'
description: "Get the user's information"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
name: Admin
email: admin@admin.com
firstname: Admin
birthdate: null
civilite: Mr
civil_status: null
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: null
updated_at: '2022-01-11 13:15:54'
is_active: 1
roles:
-
id: 1
title: 'Admin système'
- { }
properties:
id:
type: integer
example: 1
name:
type: string
example: Admin
email:
type: string
example: admin@admin.com
firstname:
type: string
example: Admin
birthdate:
type: string
example: null
civilite:
type: string
example: Mr
civil_status:
type: string
example: null
mobile_phone:
type: string
example: null
secteur_gf:
type: string
example: null
reseau_md:
type: string
example: null
autre_departement:
type: string
example: null
genre:
type: string
example: null
created_at:
type: string
example: null
updated_at:
type: string
example: '2022-01-11 13:15:54'
is_active:
type: integer
example: 1
roles:
type: array
example:
-
id: 1
title: 'Admin système'
- { }
items:
type: object
tags:
- '01 - User Authentication'
/api/profiles:
get:
summary: 'GET /api/profils'
description: "Get the profile's list"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
200:
description: ''
content:
application/json:
schema:
type: array
items:
type: object
example:
-
id: 76c378c8-bf14-4460-b350-fd7a0fc6da3a
name: 'Prog31 Administrateurs'
path: '/Prog31 Administrateurs'
profil_code: administrateur
profil_name: Administrateur
-
...: ...
tags:
- '01 - User Authentication'
/api/login:
post:
summary: 'POST /api/login'
description: "Request a token for a user's session after providing credentials"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
accessToken: eyJhbGciOiJSUz...O3pGQ
refreshToken: eyJhbGci...RT8
accessExpiresIn: 1800
refreshExpiresIn: 1800
tokenType: Bearer
scope: 'openid profile email'
properties:
accessToken:
type: string
example: eyJhbGciOiJSUz...O3pGQ
refreshToken:
type: string
example: eyJhbGci...RT8
accessExpiresIn:
type: integer
example: 1800
refreshExpiresIn:
type: integer
example: 1800
tokenType:
type: string
example: Bearer
scope:
type: string
example: 'openid profile email'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Invalid user credentials'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Invalid user credentials'
tags:
- '01 - User Authentication'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: "The user's email. value doit être une adresse e-mail valide."
example: admin@admin.com
password:
type: string
description: "The user's password."
example: admin
required:
- email
- password
security: []
/api/forgot-password:
post:
summary: 'POST /api/forgot-password'
description: 'Forgot password process'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- '01 - User Authentication'
security: []
/api/refresh:
post:
summary: 'Get new token from refresh token'
description: 'Get a new token from refresh token'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
accessToken: eyJhbGciOiJSUz...O3pGQ
refreshToken: null
accessExpiresIn: 1800
refreshExpiresIn: 1800
tokenType: Bearer
scope: 'openid profile email'
properties:
accessToken:
type: string
example: eyJhbGciOiJSUz...O3pGQ
refreshToken:
type: string
example: null
accessExpiresIn:
type: integer
example: 1800
refreshExpiresIn:
type: integer
example: 1800
tokenType:
type: string
example: Bearer
scope:
type: string
example: 'openid profile email'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Invalid user credentials'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Invalid user credentials'
tags:
- '01 - User Authentication'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
refresh_token:
type: string
description: ''
example: ipsa
required:
- refresh_token
security: []
/api/v1/users:
get:
summary: 'Lister les utilisateurs'
description: 'Permet de recuperer la liste des utilisateurs avec leurs roles et leur team'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '02 - Utilisateurs'
post:
summary: 'Créer un utilisateur'
description: 'Permet de créer une nouvel utilisateur'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
name: Admin
email: admin@admin.com
firstname: Admin
birthdate: null
civilite: Mr
civil_status: null
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: null
updated_at: '2022-01-11 13:15:54'
is_active: 1
roles:
-
id: 1
title: 'Admin système'
- { }
properties:
id:
type: integer
example: 1
name:
type: string
example: Admin
email:
type: string
example: admin@admin.com
firstname:
type: string
example: Admin
birthdate:
type: string
example: null
civilite:
type: string
example: Mr
civil_status:
type: string
example: null
mobile_phone:
type: string
example: null
secteur_gf:
type: string
example: null
reseau_md:
type: string
example: null
autre_departement:
type: string
example: null
genre:
type: string
example: null
created_at:
type: string
example: null
updated_at:
type: string
example: '2022-01-11 13:15:54'
is_active:
type: integer
example: 1
roles:
type: array
example:
-
id: 1
title: 'Admin système'
- { }
items:
type: object
tags:
- '02 - Utilisateurs'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: "Nom de l'utilisateur."
example: Doe
email:
type: string
description: "Email de de l'utilisateur."
example: john.doe@localhost.com
firstname:
type: string
description: "Prénom de l'utilisateur."
example: John
mobile_phone:
type: string
description: "Téléphone mobile de l'utilisateur."
example: 01-23-45-67-89
genre:
type: string
description: 'Homme ou Femme.'
example: Homme
profils:
type: array
description: 'Liste des profils à affecter.'
example:
a: 'Profil a'
b: 'profil b'
c: 'profil c'
items:
type: string
required:
- name
- email
- firstname
'/api/v1/users/{id}':
get:
summary: 'Afficher un utilisateur'
description: "Permet de récupérer les détails d'un utilisateur"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
name: Admin
email: admin@admin.com
firstname: Admin
birthdate: null
civilite: Mr
civil_status: null
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: null
updated_at: '2022-01-11 13:15:54'
is_active: 1
roles:
-
id: 1
title: 'Admin système'
- { }
properties:
id:
type: integer
example: 1
name:
type: string
example: Admin
email:
type: string
example: admin@admin.com
firstname:
type: string
example: Admin
birthdate:
type: string
example: null
civilite:
type: string
example: Mr
civil_status:
type: string
example: null
mobile_phone:
type: string
example: null
secteur_gf:
type: string
example: null
reseau_md:
type: string
example: null
autre_departement:
type: string
example: null
genre:
type: string
example: null
created_at:
type: string
example: null
updated_at:
type: string
example: '2022-01-11 13:15:54'
is_active:
type: integer
example: 1
roles:
type: array
example:
-
id: 1
title: 'Admin système'
- { }
items:
type: object
tags:
- '02 - Utilisateurs'
put:
summary: 'Modifier un utilisateur'
description: 'Permet de modifier un utilisateur'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
name: Admin
email: admin@admin.com
firstname: Admin
birthdate: null
civilite: Mr
civil_status: null
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: null
updated_at: '2022-01-11 13:15:54'
is_active: 1
roles:
-
id: 1
title: 'Admin système'
- { }
properties:
id:
type: integer
example: 1
name:
type: string
example: Admin
email:
type: string
example: admin@admin.com
firstname:
type: string
example: Admin
birthdate:
type: string
example: null
civilite:
type: string
example: Mr
civil_status:
type: string
example: null
mobile_phone:
type: string
example: null
secteur_gf:
type: string
example: null
reseau_md:
type: string
example: null
autre_departement:
type: string
example: null
genre:
type: string
example: null
created_at:
type: string
example: null
updated_at:
type: string
example: '2022-01-11 13:15:54'
is_active:
type: integer
example: 1
roles:
type: array
example:
-
id: 1
title: 'Admin système'
- { }
items:
type: object
tags:
- '02 - Utilisateurs'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: "Nom de l'utilisateur."
example: Doe
roles:
type: array
description: ''
example:
- 1
- 2
- 3
items:
type: integer
firstname:
type: string
description: "Prénom de l'utilisateur."
example: John
birthdate:
type: string
description: "Date de naissance de l'utilisateur. Must be a valid date in the format Y-m-d."
example: '2022-01-11'
mobile_phone:
type: string
description: "Téléphone mobile de l'utilisateur."
example: 01-23-45-67-89
reseau_md:
type: string
description: "Réseau de MD de l'utilisateur."
example: 'MD A'
autre_departement:
type: string
description: ''
example: modi
genre:
type: string
description: 'Homme ou Femme.'
example: Homme
civilite:
type: string
description: 'Mr, Mme ou Mlle.'
example: Mr
civil_status:
type: string
description: 'Marié(e), Célibataire, Veuf(ve), Divorc(é)....'
example: Célibataire
is_active:
type: boolean
description: 'indique si le compte est actif ou non.'
example: true
required:
- is_active
delete:
summary: 'Supprimer un utilisateur'
description: 'Permet de supprimer un utilisateur (soft delete)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '02 - Utilisateurs'
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: 1
required: true
schema:
type: integer
/api/v1/user-genres:
get:
summary: 'Listes des genres'
description: 'Permet de récupérer la liste des genres (Homme ou Femme)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '02 - Utilisateurs'
/api/v1/user-quota:
get:
summary: 'Quota par utilisateur'
description: 'Permet de recuperer le qutota de suivi par utilisateur'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '02 - Utilisateurs'
/api/v1/user-civilites:
get:
summary: 'Listes des civilités'
description: 'Permet de récupérer les civilités (Mr Mme Mlle)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '02 - Utilisateurs'
/api/v1/user-etat-civils:
get:
summary: 'Listes des états civils'
description: 'Permet de récupérer les civilités (Mr Mme Mlle)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '02 - Utilisateurs'
/api/v1/user-find:
post:
summary: 'Trouver des utilisateurs'
description: "Permet de récupérer les détails d'un utilisateur"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
id: 1
name: Admin
email: admin@admin.com
firstname: Admin
birthdate: null
civilite: Mr
civil_status: null
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: null
updated_at: '2022-01-11 13:15:54'
is_active: 1
roles:
-
id: 1
title: 'Admin système'
- { }
properties:
id:
type: integer
example: 1
name:
type: string
example: Admin
email:
type: string
example: admin@admin.com
firstname:
type: string
example: Admin
birthdate:
type: string
example: null
civilite:
type: string
example: Mr
civil_status:
type: string
example: null
mobile_phone:
type: string
example: null
secteur_gf:
type: string
example: null
reseau_md:
type: string
example: null
autre_departement:
type: string
example: null
genre:
type: string
example: null
created_at:
type: string
example: null
updated_at:
type: string
example: '2022-01-11 13:15:54'
is_active:
type: integer
example: 1
roles:
type: array
example:
-
id: 1
title: 'Admin système'
- { }
items:
type: object
tags:
- '02 - Utilisateurs'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pattern:
type: string
description: 'motif de recherche.'
example: fuga
required:
- pattern
/api/v1/contacts:
get:
summary: 'Lister les contacts'
description: 'Permet de recuperer la liste des utilisateurs avec leurs roles et leur team'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
post:
summary: 'Créer un contact'
description: 'Permet de créer une nouveau contact'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
properties:
data:
type: object
example:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
tags:
- '03 - Contacts'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
lastname:
type: string
description: ''
example: ducimus
firstname:
type: string
description: 'Prénom du contact.'
example: Jean
etat_civil:
type: string
description: 'Etat civil du contact.'
example: Marié(e)
birthdate:
type: string
description: 'Date de naissance du contact. Must be a valid date in the format Y-m-d.'
example: '2022-01-11'
metier:
type: string
description: 'Métier du contact.'
example: Agriculteur
telephone:
type: string
description: 'Téléphone mobile du contact.'
example: 01-23-45-67-89
email:
type: string
description: ''
example: aliquam
genre:
type: string
description: 'Homme ou Femme.'
example: Homme
civilite:
type: string
description: 'Mr, Mme ou Mlle.'
example: Mr
est_mineur:
type: boolean
description: ''
example: false
source_id:
type: integer
description: "Id d'origine d'inscription du contact."
example: 1
subscription_date:
type: string
description: "Date d'inscription ou de conversion. Must be a valid date in the format Y-m-d."
example: '2022-01-11'
ville:
type: string
description: 'Ville de résidence du contact.'
example: 'Le Blanc-Mesnil'
code_postal:
type: string
description: 'Code postal de résidence du contact.'
example: '93150'
secteur_gf:
type: string
description: 'Secteur de GF de résidence.'
example: 'Secteur 1'
adresse_postale:
type: string
description: 'Adresse postale du contact.'
example: '7 rue Isaac Newton'
nationalite:
type: string
description: ''
example: et
langue_parlee:
type: string
description: ''
example: ratione
autre_telephone:
type: string
description: ''
example: in
num_personne_foyer:
type: string
description: ''
example: eos
invite_par:
type: string
description: ''
example: omnis
date_conversion:
type: string
description: 'Must be a valid date in the format Y-m-d.'
example: '2025-02-21'
conseiller_nc:
type: string
description: ''
example: similique
est_candidat_prog31:
type: boolean
description: ''
example: true
est_candidat_visite:
type: boolean
description: ''
example: true
est_converti_cec:
type: boolean
description: ''
example: false
is_livre:
type: boolean
description: 'Indique si le contact a reçu le livre "31 Jours".'
example: false
observations:
type: string
description: ''
example: nulla
required:
- lastname
- firstname
- source_id
- subscription_date
'/api/v1/contacts/{id}':
get:
summary: 'Afficher un contact'
description: "Permet de récupérer les détails d'un contact"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
properties:
data:
type: object
example:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
tags:
- '03 - Contacts'
put:
summary: 'Modifier un contact'
description: 'Permet de modifier un contact'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
properties:
data:
type: object
example:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
tags:
- '03 - Contacts'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
lastname:
type: string
description: ''
example: eveniet
firstname:
type: string
description: 'Prénom du contact.'
example: Jean
etat_civil:
type: string
description: 'Etat civil du contact.'
example: Marié(e)
birthdate:
type: string
description: 'Date de naissance du contact. Must be a valid date in the format Y-m-d.'
example: '2022-01-11'
metier:
type: string
description: 'Métier du contact.'
example: Agriculteur
telephone:
type: string
description: 'Téléphone mobile du contact.'
example: 01-23-45-67-89
email:
type: string
description: ''
example: rerum
genre:
type: string
description: 'Homme ou Femme.'
example: Homme
civilite:
type: string
description: 'Mr, Mme ou Mlle.'
example: Mr
est_mineur:
type: boolean
description: ''
example: false
liste_id:
type: integer
description: 'Id de liste de suivi du contact.'
example: 1
source_id:
type: integer
description: "Id d'origine d'inscription du contact."
example: 1
subscription_date:
type: string
description: "Date d'inscription ou de conversion. Must be a valid date in the format Y-m-d."
example: '2022-01-11'
ville:
type: string
description: 'Ville de résidence du contact.'
example: 'Le Blanc-Mesnil'
code_postal:
type: string
description: 'Code postal de résidence du contact.'
example: '93150'
secteur_gf:
type: string
description: 'Secteur de GF de résidence.'
example: 'Secteur 1'
adresse_postale:
type: string
description: 'Adresse postale du contact.'
example: '7 rue Isaac Newton'
is_livre:
type: boolean
description: 'Indique si le contact a reçu le livre "31 Jours".'
example: false
required:
- lastname
- firstname
- source_id
delete:
summary: 'Supprimer un contact'
description: 'Permet de supprimer un contact (soft delete)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '03 - Contacts'
parameters:
-
in: path
name: id
description: 'The ID of the contact.'
example: 12
required: true
schema:
type: integer
/api/v1/contact-genres:
get:
summary: 'Listes des genres'
description: 'Permet de récupérer la liste des genres (Homme ou Femme)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '03 - Contacts'
/api/v1/contact-principale:
get:
summary: 'Contacts - Liste principale'
description: 'Permet de recuperer la liste des contacts de la liste principale'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-principale-adulte:
get:
summary: 'Contacts - Liste principale Adulte'
description: 'Permet de recuperer la liste des contacts adultes de la liste principale'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-principale-ado:
get:
summary: 'Contacts - Liste principale Adolescent'
description: 'Permet de recuperer la liste des contacts adolescents de la liste principale'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-mes-saisies:
get:
summary: 'Contacts - Mes saisies'
description: "Permet de recuperer la liste des contacts en attente saisis par l'utilisateur authentifié"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-perseverance:
get:
summary: 'Contacts - Liste perséverance'
description: 'Permet de recuperer la liste des contacts de la liste perseverance'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-perseverance-adulte:
get:
summary: 'Contacts - Liste perséverance Adulte'
description: 'Permet de recuperer la liste des contacts de la liste perseverance'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-perseverance-ado:
get:
summary: 'Contacts - Liste perséverance Adolescent'
description: 'Permet de recuperer la liste des contacts de la liste perseverance'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-attente:
get:
summary: 'Contacts - Liste attente attribution'
description: "Permet de recuperer la liste des contacts en attente d'attribution pour un coach"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-attente-adulte:
get:
summary: 'Contacts - Liste attente attribution adulte'
description: "Permet de recuperer la liste des contacts adultes en attente d'attribution pour un coach"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-attente-ado:
get:
summary: 'Contacts - Liste attente attribution adolescents'
description: "Permet de recuperer la liste des contacts adolescents en attente d'attribution pour un coach"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
/api/v1/contact-civilites:
get:
summary: 'Listes des civilités'
description: 'Permet de récupérer les civilités (Mr Mme Mlle)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '03 - Contacts'
/api/v1/contact-etat-civils:
get:
summary: 'Listes des états civils'
description: 'Permet de récupérer les civilités (Mr Mme Mlle)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '03 - Contacts'
/api/v1/contact-secteurs-gf:
get:
summary: 'Listes des secteurs de GF'
description: 'Permet de récupérer les secteurs de GF'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '03 - Contacts'
/api/v1/contact-villes:
get:
summary: 'Lister les Villes'
description: 'Permet de récupérer les villes avec code postal et secteur associés'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '03 - Contacts'
/api/v1/contact-find:
post:
summary: 'Trouver des contacts'
description: 'Permet de retrouver des contacts par nom, prénom, email, ou numéro de téléphone'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
properties:
data:
type: object
example:
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
birthdate: '2022-01-11'
metier: Institutrice
telephone: 01-23-45-67-89
email: est
genre: Femme
civilite: Mme
est_mineur: false
liste_id: 2
source_id: 2
updated_at: '2022-01-12 14:07:21'
created_at: '2022-01-12 14:07:21'
id: 2
subscription_date: '2023-07-24 16:05:24'
ville: null
code_postal: null
secteur_gf: null
adresse_postale: null
liste:
id: 2
libelle: Persévérance
code: PSV
description: 'Liste des contacts dont le suivi est suspendu'
source:
id: 2
libelle: Evangélisation
code: EVG
description: "Contact provenant d'une campagne d'évangélisation"
tags:
- '03 - Contacts'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
pattern:
type: string
description: 'motif de recherche.'
example: quia
required:
- pattern
'/api/v1/contact-find-secteur/{code}':
post:
summary: "Trouver le secteur GF d'une ville"
description: "Permet de retrouver le secteur GF d'une ville à partir de son code postal"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '03 - Contacts'
parameters:
-
in: path
name: code
description: ''
example: ipsum
required: true
schema:
type: string
/api/v1/suivi-contacts:
get:
summary: 'Lister les affectations de suivi'
description: 'Permet de recuperer la liste des affectations de suivi (coach / contact)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '04 - Affectations de suivi'
post:
summary: 'Créer une affectation de suivi'
description: 'Permet de créer une affectation de suivi'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
properties:
data:
type: object
example:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
tags:
- '04 - Affectations de suivi'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contact_id:
type: integer
description: 'Id du contact à suivre.'
example: 1
coach_id:
type: integer
description: 'Id du coach.'
example: 1
date_debut:
type: string
description: 'Date de début du suivi. Must be a valid date in the format Y-m-d.'
example: '2022-01-15 00:00:00'
date_fin:
type: string
description: 'Date de fin du suivi. Must be a valid date in the format Y-m-d.'
example: '2022-01-19 00:00:00'
commentaires:
type: string
description: Commentaires.
example: RAS
required:
- contact_id
- coach_id
'/api/v1/suivi-contacts/{id}':
get:
summary: 'Afficher une affection de suivi'
description: "Permet de récupérer les détails d'une affectation de suivi d'un contact"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
properties:
data:
type: object
example:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
tags:
- '04 - Affectations de suivi'
put:
summary: 'Modifier une affectation de suivi'
description: 'Permet de modifier une affectation de suivi'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
properties:
data:
type: object
example:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
tags:
- '04 - Affectations de suivi'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
date_debut:
type: string
description: 'Date de début du suivi. Must be a valid date in the format Y-m-d.'
example: '2022-01-15'
date_fin:
type: string
description: 'Date de fin du suivi. Must be a valid date in the format Y-m-d.'
example: '2022-01-19'
commentaires:
type: string
description: Commentaires.
example: RAS
delete:
summary: 'Supprimer une affectation de suivi'
description: 'Permet de supprimer une affectation de suivi (soft delete)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '04 - Affectations de suivi'
parameters:
-
in: path
name: id
description: 'The ID of the suivi contact.'
example: 13
required: true
schema:
type: integer
-
in: path
name: suivi_contact
description: "ID de l'objet suivi_contact. Exemple : 1"
example: 4
required: true
schema:
type: integer
/api/v1/mes-affectations:
get:
summary: 'Mes affectations de suivi'
description: "Permet de récupérer les contacts suivis par l'utilisateur connecté"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
properties:
data:
type: object
example:
contact_id: 2
coach_id: 2
date_debut: '2022-01-18 16:30:11'
updated_at: '2022-01-18 16:30:11'
created_at: '2022-01-18 16:30:11'
id: 3
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
created_at: '2022-01-12 14:07:21'
updated_at: '2022-01-12 14:07:21'
deleted_at: null
liste_id: 2
source_id: 2
coach:
id: 2
name: "D'ALMEIDA"
email: laurenda1fr@yahoo.fr
firstname: Laurenda
birthdate: null
civilite: Mme
civil_status: Marié(e)
mobile_phone: null
secteur_gf: null
reseau_md: null
autre_departement: null
genre: null
created_at: '2021-10-06 20:15:38'
updated_at: '2021-10-06 20:15:38'
is_active: 1
tags:
- '04 - Affectations de suivi'
/api/v1/session-bilans:
get:
summary: 'Liste des particiapations aux sessions de bilans'
description: 'Permet de recuperer la liste des participations aux sessions de bilans'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '05 - Sessions de bilans'
post:
summary: 'Enregistrer une participation à un bilan'
description: "Permet d'enregistrer la participation d'un contact à une session de bilan pour un contact"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: Toto
email: toto@localhost.com
firstname: John
mobile_phone: 01-23-45-67-89
genre: Mademoiselle
civilite: Mr
civil_status: Célibataire
updated_at: '2022-02-15 11:20:54'
created_at: '2022-02-15 11:20:54'
id: 11
roles:
-
id: 1
title: 'Admin système'
team: null
properties:
data:
type: object
example:
name: Toto
email: toto@localhost.com
firstname: John
mobile_phone: 01-23-45-67-89
genre: Mademoiselle
civilite: Mr
civil_status: Célibataire
updated_at: '2022-02-15 11:20:54'
created_at: '2022-02-15 11:20:54'
id: 11
roles:
-
id: 1
title: 'Admin système'
team: null
tags:
- '05 - Sessions de bilans'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contact_id:
type: integer
description: 'Id du contact à suivre.'
example: 1
bilan_id:
type: integer
description: 'Id du bilan.'
example: 1
date:
type: string
description: 'Date de la session. Must be a valid date in the format Y-m-d.'
example: '2022-01-15 00:00:00'
required:
- contact_id
- bilan_id
- date
'/api/v1/session-bilans/{id}':
get:
summary: 'Afficher une participation pour un contact'
description: "Permet de récupérer les détails d'une participation d'un contact à un session de bilan"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
date: '2022-01-17'
bilan_id: 2
contact_id: 1
bilan:
id: 2
nom: 'Bilan Semaine 2'
code: BS2
description: 'Bilan Semaine 2'
programme_id: 1
contact:
id: 1
civilite: Mr
lastname: Dupont
firstname: Jean
etat_civil: Marié(e)
genre: Homme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: ipsum
liste_id: 1
source_id: 1
properties:
data:
type: object
example:
id: 1
date: '2022-01-17'
bilan_id: 2
contact_id: 1
bilan:
id: 2
nom: 'Bilan Semaine 2'
code: BS2
description: 'Bilan Semaine 2'
programme_id: 1
contact:
id: 1
civilite: Mr
lastname: Dupont
firstname: Jean
etat_civil: Marié(e)
genre: Homme
birthdate: '2022-01-11'
est_mineur: 0
metier: Agriculteur
telephone: 01-23-45-67-89
email: ipsum
liste_id: 1
source_id: 1
tags:
- '05 - Sessions de bilans'
put:
summary: 'Modifier une participation pour un contact'
description: "Permet de modifier les détails d'une participation d'un contact à un session de bilan"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
date: '2022-01-10'
id: 1
properties:
data:
type: object
example:
date: '2022-01-10'
id: 1
tags:
- '05 - Sessions de bilans'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
date:
type: string
description: 'Date de la session. Must be a valid date in the format Y-m-d.'
example: '2022-01-15 00:00:00'
required:
- date
delete:
summary: 'Supprimer une participation pour un contact'
description: "Permet de supprimer la participation d'un contact à une session de bilan (soft delete)"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '05 - Sessions de bilans'
parameters:
-
in: path
name: id
description: 'The ID of the session bilan.'
example: 10
required: true
schema:
type: integer
-
in: path
name: session_bilan
description: "ID de l'objet session_bilan. Exemple : 1"
example: 20
required: true
schema:
type: integer
/api/v1/suivi-telephoniques:
get:
summary: 'Liste des suivis téléphoniques'
description: "Permet d'afficher la liste des suivis téléphoniques"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
post:
summary: 'Enregistrer suivi téléphonique'
description: "Permet d'enregistrer le rapport d'un suivi téléphonique"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
contact_id: 2
coach_id: 5
date_appel: '2022-01-24 15:40:00'
commentaires: 'test de création de suivi téléphonique'
statut_id: 4
updated_at: '2022-02-16 14:41:05'
created_at: '2022-02-16 14:41:05'
id: 1
properties:
data:
type: object
example:
contact_id: 2
coach_id: 5
date_appel: '2022-01-24 15:40:00'
commentaires: 'test de création de suivi téléphonique'
statut_id: 4
updated_at: '2022-02-16 14:41:05'
created_at: '2022-02-16 14:41:05'
id: 1
tags:
- '06 - Suivi téléphonique'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
date_appel:
type: string
description: "Date et heure d'appel du suivi. Must be a valid date in the format Y-m-d."
example: '2022-01-15 15:30:00'
commentaires:
type: string
description: 'Commentaires éventuels saisis par le coach.'
example: N.A
contact_id:
type: integer
description: 'Id du contact à suivre.'
example: 1
coach_id:
type: integer
description: 'Id du coach qui effectue le bilan.'
example: 1
statut_id:
type: integer
description: 'Id du statut du suivi.'
example: 1
required:
- date_appel
- contact_id
- coach_id
- statut_id
'/api/v1/suivi-telephoniques/{id}':
get:
summary: 'Afficher un suivi téléphonique'
description: "Permet de récupérer les détails d'un rapport de suivi téléphonique"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
date_appel: '2022-01-24 15:40:00'
commentaires: 'test de création de suivi téléphonique'
contact_id: 2
coach_id: 5
statut_id: 4
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie-Claire
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 1
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
liste_id: 1
source_id: 1
coach:
id: 5
name: Ngoileye
email: emailtestlaurence@yahoo.fr
firstname: Laurence
birthdate: '1985-06-12'
civilite: Mme
civil_status: Marié(e)
mobile_phone: '0612121212'
secteur_gf: 'Secteur 7'
reseau_md: 'MD Intensité'
autre_departement: Libéralité
genre: Femme
created_at: '2021-11-13 23:11:06'
updated_at: '2021-11-13 23:15:21'
keycloak_user_id: null
is_active: 1
statut:
id: 4
libelle: 'Changement de coach'
code: CCH
description: 'Changement de coach'
type: PCP
team: null
properties:
data:
type: object
example:
id: 1
date_appel: '2022-01-24 15:40:00'
commentaires: 'test de création de suivi téléphonique'
contact_id: 2
coach_id: 5
statut_id: 4
contact:
id: 2
civilite: Mme
lastname: Dupont
firstname: Marie-Claire
etat_civil: Marié(e)
genre: Femme
birthdate: '2022-01-11'
est_mineur: 1
metier: Agriculteur
telephone: 01-23-45-67-89
email: est
liste_id: 1
source_id: 1
coach:
id: 5
name: Ngoileye
email: emailtestlaurence@yahoo.fr
firstname: Laurence
birthdate: '1985-06-12'
civilite: Mme
civil_status: Marié(e)
mobile_phone: '0612121212'
secteur_gf: 'Secteur 7'
reseau_md: 'MD Intensité'
autre_departement: Libéralité
genre: Femme
created_at: '2021-11-13 23:11:06'
updated_at: '2021-11-13 23:15:21'
keycloak_user_id: null
is_active: 1
statut:
id: 4
libelle: 'Changement de coach'
code: CCH
description: 'Changement de coach'
type: PCP
team: null
tags:
- '06 - Suivi téléphonique'
put:
summary: 'Modifier un suivi téléphonique'
description: "Permet de modifier les détails d'une participation d'un contact à un session de bilan"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
date_appel: '2022-01-23 16:35:00'
commentaires: 'test de modification de suivi téléphonique'
statut_id: 3
id: 1
properties:
data:
type: object
example:
date_appel: '2022-01-23 16:35:00'
commentaires: 'test de modification de suivi téléphonique'
statut_id: 3
id: 1
tags:
- '06 - Suivi téléphonique'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
date_appel:
type: string
description: "Date et heure d'appel du suivi. Must be a valid date in the format Y-m-d."
example: '2022-01-15 15:30:00'
commentaires:
type: string
description: 'Commentaires éventuels saisis par le coach.'
example: N.A
statut_id:
type: integer
description: 'Id du statut du suivi.'
example: 1
required:
- statut_id
delete:
summary: 'Supprimer un suivi téléphonique'
description: 'Permet de supprimer le rapport de suivi téléphonique'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '06 - Suivi téléphonique'
parameters:
-
in: path
name: id
description: 'The ID of the suivi telephonique.'
example: 1
required: true
schema:
type: integer
-
in: path
name: suivi_telephonique
description: "ID de l'objet suivi_telephonique. Exemple : 1"
example: 12
required: true
schema:
type: integer
/api/v1/mon-suivi-telephonique:
get:
summary: 'Mon suivi téléphonique'
description: "Permet d'afficher la liste des suivis téléphoniques de l'utilisateur connecté"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-perseverance:
get:
summary: 'Suivi téléphonique persévérance'
description: "Permet d'afficher la liste des suivis téléphoniques de la liste de persévérance"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-perseverance-adulte:
get:
summary: 'Suivi téléphonique persévérance adulte'
description: "Permet d'afficher la liste des suivis téléphoniques de la liste de persévérance"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-perseverance-ado:
get:
summary: 'Suivi téléphonique persévérance adolescent'
description: "Permet d'afficher la liste des suivis téléphoniques de la liste de persévérance"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-principale:
get:
summary: 'Suivi téléphonique principale'
description: "Permet d'afficher la liste des suivis téléphoniques de la liste principale"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-liste-actions:
get:
summary: "Listes des statuts d'action"
description: "Permet de récupérer la liste des statuts d'action"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'Id inconnu'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'Id inconnu'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-action:
get:
summary: 'Suivi pour action'
description: "Permet d'afficher la liste des suivis téléphoniques necéssitant une action"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-action-adulte:
get:
summary: 'Suivi pour action adulte'
description: "Permet d'afficher la liste des suivis téléphoniques necéssitant une action (adulte)"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/suivi-telephonique-action-ado:
get:
summary: 'Suivi pour action ado'
description: "Permet d'afficher la liste des suivis téléphoniques necéssitant une action (ado)"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '06 - Suivi téléphonique'
/api/v1/configs:
get:
summary: 'Lister les paramètes'
description: 'Permet de recuperer la liste des paramètres'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '07 - Paramètres'
post:
summary: 'Créer un paramètre'
description: 'Permet de créer un nouveau paramètre'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: quota_suivi_contact
value: '10'
properties:
data:
type: object
example:
lastname: quota_suivi_contact
value: '10'
tags:
- '07 - Paramètres'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nom du paramètre.'
example: quota_suivi_contact
value:
type: string
description: 'Valeur du paramètre.'
example: '10'
required:
- name
- value
'/api/v1/configs/{id}':
get:
summary: 'Afficher un paramètre par son Id'
description: "Permet de récupérer les détails d'un paramètre par son id"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: quota_suivi_contact
value: '10'
properties:
data:
type: object
example:
lastname: quota_suivi_contact
value: '10'
tags:
- '07 - Paramètres'
put:
summary: 'Modifier un paramètre'
description: 'Permet de modifier un paramètre'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: quota_suivi_contact
value: '10'
properties:
data:
type: object
example:
lastname: quota_suivi_contact
value: '10'
tags:
- '07 - Paramètres'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'Nom du paramètre.'
example: quota_suivi_contact
value:
type: string
description: 'Valeur du paramètre.'
example: '10'
required:
- name
- value
delete:
summary: 'Supprimer un paramètre'
description: 'Permet de supprimer un paramètre'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '07 - Paramètres'
parameters:
-
in: path
name: id
description: 'The ID of the config.'
example: 1
required: true
schema:
type: integer
'/api/v1/config-by-name/{name}':
get:
summary: 'Afficher un paramètre'
description: "Permet de récupérer les détails d'un paramètre par som nom"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
lastname: quota_suivi_contact
value: '10'
properties:
data:
type: object
example:
lastname: quota_suivi_contact
value: '10'
tags:
- '07 - Paramètres'
parameters:
-
in: path
name: name
description: ''
example: ea
required: true
schema:
type: string
/api/v1/diplomes/print:
post:
summary: 'POST /api/v1/diplomes/print'
description: 'Print and dowload diplomes'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{"document file"}'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Invalid parameters'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Invalid parameters'
tags:
- '08 - Certificats'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
users:
type: array
description: ''
example:
- 16
items:
type: integer
/api/v1/diplomes/latests:
get:
summary: 'POST /api/v1/diplomes/latests'
description: 'Print and dowload latest diplomes'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{"document file"}'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Invalid parameters'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Invalid parameters'
tags:
- '08 - Certificats'
/api/v1/diplomes/update-date:
post:
summary: 'POST /api/v1/diplomes/update-date'
description: 'Update date of certification'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{"results : ok"}'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Invalid parameters'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Invalid parameters'
tags:
- '08 - Certificats'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
users:
type: array
description: ''
example:
- 17
items:
type: integer
/api/v1/contact-list-types:
get:
summary: 'Lister les types de contacts'
description: 'Permet de recuperer la liste des types de contacts'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '09 - Types de Contact'
post:
summary: 'Créer un type de contact'
description: 'Permet de créer une nouveau type contact'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
libelle: Principale
code: PCP
description: 'Liste principale des contacts'
properties:
data:
type: object
example:
id: 1
libelle: Principale
code: PCP
description: 'Liste principale des contacts'
tags:
- '09 - Types de Contact'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
libelle:
type: string
description: ''
example: quos
code:
type: string
description: ''
example: rerum
description:
type: string
description: ''
example: rem
required:
- libelle
- code
'/api/v1/contact-list-types/{id}':
get:
summary: 'Afficher un type de contact'
description: "Permet de récupérer les détails d'un type de contact"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
libelle: Principale
code: PCP
description: 'Liste principale des contacts'
properties:
data:
type: object
example:
id: 1
libelle: Principale
code: PCP
description: 'Liste principale des contacts'
tags:
- '09 - Types de Contact'
put:
summary: 'Modifier un type de contact'
description: 'Permet de modifier un type de contact'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
libelle: Principale
code: PCP
description: 'Liste principale des contacts'
properties:
data:
type: object
example:
id: 1
libelle: Principale
code: PCP
description: 'Liste principale des contacts'
tags:
- '09 - Types de Contact'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
libelle:
type: string
description: ''
example: officia
code:
type: string
description: ''
example: est
description:
type: string
description: ''
example: velit
required:
- libelle
- code
delete:
summary: 'Supprimer un type de contact'
description: 'Permet de supprimer un type de contact (soft delete)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '09 - Types de Contact'
parameters:
-
in: path
name: id
description: 'The ID of the contact list type.'
example: 1
required: true
schema:
type: integer
/api/v1/contact-list-types-active:
get:
summary: 'Lister les types de contacts actifs'
description: 'Permet de recuperer la liste des types de contacts ayant le statut actif'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '09 - Types de Contact'
/api/v1/source-contacts:
get:
summary: 'Lister les sources de contacts'
description: 'Permet de recuperer la liste des sources de contacts'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "data" : [ {...}, {...} ] }'
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
tags:
- '10 - Sources de Contact'
post:
summary: 'Créer une source de contact'
description: 'Permet de créer une nouvelle source de contact'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
libelle: 'Nouveaux Convertis'
code: NCO
description: 'Contact provenant de la liste des nouveaux convertis'
properties:
data:
type: object
example:
id: 1
libelle: 'Nouveaux Convertis'
code: NCO
description: 'Contact provenant de la liste des nouveaux convertis'
tags:
- '10 - Sources de Contact'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
libelle:
type: string
description: ''
example: qui
code:
type: string
description: ''
example: dolor
description:
type: string
description: ''
example: ipsum
'/api/v1/source-contacts/{id}':
get:
summary: 'Afficher une source de contact'
description: "Permet de récupérer les détails d'une source de contact"
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
libelle: 'Nouveaux Convertis'
code: NCO
description: 'Contact provenant de la liste des nouveaux convertis'
properties:
data:
type: object
example:
id: 1
libelle: 'Nouveaux Convertis'
code: NCO
description: 'Contact provenant de la liste des nouveaux convertis'
tags:
- '10 - Sources de Contact'
put:
summary: 'Modifier une source de contact'
description: 'Permet de modifier une source de contact'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
422:
description: ''
content:
text/plain:
schema:
type: string
example: '{ "message" : "The given data was invalid.", "error" : {...}}'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 1
libelle: 'Nouveaux Convertis'
code: NCO
description: 'Contact provenant de la liste des nouveaux convertis'
properties:
data:
type: object
example:
id: 1
libelle: 'Nouveaux Convertis'
code: NCO
description: 'Contact provenant de la liste des nouveaux convertis'
tags:
- '10 - Sources de Contact'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
libelle:
type: string
description: ''
example: assumenda
code:
type: string
description: ''
example: quos
description:
type: string
description: ''
example: cupiditate
delete:
summary: 'Supprimer une source de contact'
description: 'Permet de supprimer une source de contact (soft delete)'
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
204:
description: ''
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Bad token'
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Bad token'
404:
description: ''
content:
application/json:
schema:
type: object
example:
code: 404
message: 'Resource not found'
path: null
description: 'No query result found for this Id'
properties:
code:
type: integer
example: 404
message:
type: string
example: 'Resource not found'
path:
type: string
example: null
description:
type: string
example: 'No query result found for this Id'
tags:
- '10 - Sources de Contact'
parameters:
-
in: path
name: id
description: 'The ID of the source contact.'
example: 1
required: true
schema:
type: integer
/api/documentation:
get:
summary: 'Display Swagger API page.'
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n\n \n L5 Swagger UI\n \n \n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n"
tags:
- Endpoints
/api/oauth2-callback:
get:
summary: 'Display Oauth2 callback pages.'
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n\n Swagger UI: OAuth2 Redirect\n\n\n\n\n\n"
tags:
- Endpoints
/api/v1/roles:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: ''
example: beatae
permissions:
type: array
description: ''
example:
- 4
items:
type: integer
required:
- title
'/api/v1/roles/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
put:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: ''
example: illo
permissions:
type: array
description: ''
example:
- 15
items:
type: integer
required:
- title
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the role.'
example: 1
required: true
schema:
type: integer
/api/v1/statut-appels:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
libelle:
type: string
description: ''
example: cum
code:
type: string
description: ''
example: voluptates
description:
type: string
description: ''
example: necessitatibus
'/api/v1/statut-appels/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
put:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
libelle:
type: string
description: ''
example: voluptatibus
code:
type: string
description: ''
example: a
description:
type: string
description: ''
example: impedit
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the statut appel.'
example: 1
required: true
schema:
type: integer
/api/v1/teams:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: amet
required:
- name
'/api/v1/teams/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
put:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: beatae
required:
- name
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the team.'
example: 1
required: true
schema:
type: integer
/api/v1/user-alerts:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
alert_text:
type: string
description: ''
example: voluptas
alert_link:
type: string
description: ''
example: laboriosam
users:
type: array
description: ''
example:
- 7
items:
type: integer
required:
- alert_text
'/api/v1/user-alerts/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the user alert.'
example: 3
required: true
schema:
type: integer
/api/v1/content-pages/media:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
/api/v1/content-pages:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: ''
example: consequatur
categories:
type: array
description: ''
example:
- 2
items:
type: integer
tags:
type: array
description: ''
example:
- 9
items:
type: integer
required:
- title
'/api/v1/content-pages/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
put:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: ''
example: autem
categories:
type: array
description: ''
example:
- 10
items:
type: integer
tags:
type: array
description: ''
example:
- 5
items:
type: integer
required:
- title
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the content page.'
example: 3
required: true
schema:
type: integer
/api/v1/programmes:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nom:
type: string
description: ''
example: beatae
description:
type: string
description: ''
example: architecto
required:
- nom
'/api/v1/programmes/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the programme.'
example: 1
required: true
schema:
type: integer
/api/v1/bilans:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nom:
type: string
description: ''
example: et
code:
type: string
description: ''
example: et
description:
type: string
description: ''
example: eaque
required:
- nom
'/api/v1/bilans/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the bilan.'
example: 1
required: true
schema:
type: integer
/api/v1/formations:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
nom:
type: string
description: ''
example: accusantium
description:
type: string
description: ''
example: eum
required:
- nom
'/api/v1/formations/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the formation.'
example: 5
required: true
schema:
type: integer
/api/v1/suivi-formations:
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
date_formation:
type: string
description: 'Must be a valid date in the format Y-m-d.'
example: '2025-02-21'
'/api/v1/suivi-formations/{id}':
get:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
code: 401
message: Unauthorized
path: null
description: 'Not authenticated'
userid: null
accessToken: null
properties:
code:
type: integer
example: 401
message:
type: string
example: Unauthorized
path:
type: string
example: null
description:
type: string
example: 'Not authenticated'
userid:
type: string
example: null
accessToken:
type: string
example: null
tags:
- Endpoints
put:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
date_formation:
type: string
description: 'Must be a valid date in the format Y-m-d.'
example: '2025-02-21'
delete:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the suivi formation.'
example: 4
required: true
schema:
type: integer
/api/register:
post:
summary: ''
description: ''
parameters:
-
in: header
name: Content-Type
description: ''
example: application/json
schema:
type: string
-
in: header
name: Accept
description: ''
example: application/json
schema:
type: string
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: aperiam
email:
type: string
description: 'value doit être une adresse e-mail valide.'
example: runolfsson.trevor@example.com
password:
type: string
description: 'value doit être au moins 6 caractères.'
example: bqngzt
required:
- name
- email
- password
tags:
-
name: '01 - User Authentication'
description: ''
-
name: '02 - Utilisateurs'
description: ''
-
name: '03 - Contacts'
description: ''
-
name: '04 - Affectations de suivi'
description: ''
-
name: '05 - Sessions de bilans'
description: ''
-
name: '06 - Suivi téléphonique'
description: ''
-
name: '07 - Paramètres'
description: ''
-
name: '08 - Certificats'
description: ''
-
name: '09 - Types de Contact'
description: ''
-
name: '10 - Sources de Contact'
description: ''
-
name: Endpoints
description: ''