openapi: 3.0.3
info:
title: 'Service for age Api'
description: ''
version: 1.0.0
servers:
-
url: 'https://staging-api.services4aged.com'
paths:
/api/payments-methods:
get:
summary: ''
operationId: getApiPaymentsMethods
description: ''
parameters: []
responses:
403:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Access denied contact the administrator'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Access denied contact the administrator'
tags:
- Endpoints
'/api/confirm-cash-payment/{reference}':
get:
summary: ''
operationId: getApiConfirmCashPaymentReference
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: reference
description: ''
example: quaerat
required: true
schema:
type: string
'/api/cancel-cash-payment/{reference}':
get:
summary: ''
operationId: getApiCancelCashPaymentReference
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: reference
description: ''
example: voluptas
required: true
schema:
type: string
'/api/details-cash-transaction/{reference}':
get:
summary: ''
operationId: getApiDetailsCashTransactionReference
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: reference
description: ''
example: ipsam
required: true
schema:
type: string
/api/get-cash-payment:
get:
summary: ''
operationId: getApiGetCashPayment
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/list-refund-admin:
get:
summary: ''
operationId: getApiListRefundAdmin
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
'/api/approve-refund/{id}':
post:
summary: ''
operationId: postApiApproveRefundId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: id
description: 'The ID of the approve refund.'
example: et
required: true
schema:
type: string
'/api/reject-refund/{id}':
post:
summary: ''
operationId: postApiRejectRefundId
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
rejection_reason:
type: string
description: ''
example: dolor
required:
- rejection_reason
parameters:
-
in: path
name: id
description: 'The ID of the reject refund.'
example: dolores
required: true
schema:
type: string
'/api/ask-payment/{prestation_id}':
get:
summary: ''
operationId: getApiAskPaymentPrestation_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
parameters:
-
in: path
name: prestation_id
description: 'The ID of the prestation.'
example: et
required: true
schema:
type: string
/api/list-refund-souscripteur:
get:
summary: ''
operationId: getApiListRefundSouscripteur
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Endpoints
/api/pay-as-cash:
post:
summary: ''
operationId: postApiPayAsCash
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
total_amount:
type: string
description: ''
example: non
description:
type: string
description: ''
example: 'Deleniti omnis ut fugit a et.'
prestation_id:
type: string
description: ''
example: ullam
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 3072 kilo-octets.'
required:
- total_amount
- description
- prestation_id
- photo
/api/refund-requests:
post:
summary: 'Store a newly created refund request in storage.'
operationId: storeANewlyCreatedRefundRequestInStorage
description: ''
parameters: []
responses: { }
tags:
- Endpoints
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
reason:
type: string
description: ''
example: molestiae
prestation_id:
type: string
description: ''
example: quo
amount:
type: string
description: ''
example: id
phone:
type: string
description: ''
example: quia
required:
- reason
- prestation_id
- amount
- phone
/api/events:
get:
summary: "Récupère tous les événements de l'utilisateur authentifié."
operationId: rcupreTousLesvnementsDeLutilisateurAuthentifi
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Evenement
post:
summary: 'Crée un nouvel événement avec les détails fournis.'
operationId: creUnNouvelvnementAvecLesDtailsFournis
description: ''
parameters: []
responses: { }
tags:
- Evenement
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: xwnesysonxuvoykybsvgdk
description:
type: string
description: ''
example: 'Omnis esse voluptatem cumque placeat voluptates error.'
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:29'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2061-02-24'
required:
- title
- start_date
- end_date
'/api/events/{id}':
get:
summary: "Récupère les détails d'un événement spécifique."
operationId: rcupreLesDtailsDunvnementSpcifique
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Evenement
put:
summary: "Met à jour les détails d'un événement spécifique."
operationId: metJourLesDtailsDunvnementSpcifique
description: ''
parameters: []
responses: { }
tags:
- Evenement
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: nlqcavrlzjmpvznskkewnrwka
description:
type: string
description: ''
example: 'Accusantium facere veniam sunt omnis laborum.'
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:29'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2031-02-09'
required:
- start_date
- end_date
delete:
summary: 'Supprime un événement spécifique.'
operationId: supprimeUnvnementSpcifique
description: ''
parameters: []
responses: { }
tags:
- Evenement
parameters:
-
in: path
name: id
description: 'The ID of the event.'
example: esse
required: true
schema:
type: string
/api/logout:
post:
summary: ''
operationId: postApiLogout
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
/api/login:
post:
summary: ''
operationId: postApiLogin
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Le champ value doit être une adresse email valide.'
example: jade02@example.org
password:
type: string
description: ''
example: '3?bk)1JWQe6"a+5'
required:
- email
- password
security: []
/api/forgot-password:
post:
summary: ''
operationId: postApiForgotPassword
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Le champ value doit être une adresse email valide.'
example: parker.suzanne@example.org
device:
type: string
description: ''
example: eaque
required:
- email
- device
security: []
/api/reset-password:
post:
summary: ''
operationId: postApiResetPassword
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: ''
example: null
device:
type: string
description: ''
example: mobile
enum:
- mobile
- web
email:
type: string
description: 'Le champ value doit être une adresse email valide.'
example: dayna.rogahn@example.org
password:
type: string
description: ''
example: provident
required:
- device
- email
- password
security: []
/api/verify-token:
post:
summary: ''
operationId: postApiVerifyToken
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
/api/verify-otp-password:
post:
summary: ''
operationId: postApiVerifyOtpPassword
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: cathy.corkery@example.net
otp:
type: string
description: ''
example: ex
required:
- email
- otp
'/api/verify-email/{id}/{hash}':
get:
summary: 'Verify email'
operationId: verifyEmail
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Authentification'
parameters:
-
in: path
name: id
description: 'The ID of the verify email.'
example: fugiat
required: true
schema:
type: string
-
in: path
name: hash
description: ''
example: unde
required: true
schema:
type: string
/api/email/resend-verification-notification:
post:
summary: 'Resend email verification'
operationId: resendEmailVerification
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
/api/update-beneficiary-information:
patch:
summary: 'Mise à jour information bénéficiaire'
operationId: miseJourInformationBnficiaire
description: ''
parameters: []
responses: { }
tags:
- 'Module Beneficiaire'
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: John
beneficiary_id:
type: string
description: ''
example: null
last_name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: Doe
phone:
type: string
description: 'phone of user. Le texte de value ne peut contenir plus de 14 caractères.'
example: '696661135'
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: "Date de naissance. Le champ value n'est pas une date valide."
example: '1996-03-11'
email:
type: string
description: 'email of user. Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
lang:
type: string
description: ''
example: consequatur
/api/souscripteur-update-beneficiary:
patch:
summary: 'Mise à jour information bénéficiaire'
operationId: miseJourInformationBnficiaire
description: ''
parameters: []
responses: { }
tags:
- 'Module Beneficiaire'
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: John
beneficiary_id:
type: string
description: ''
example: null
last_name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: Doe
phone:
type: string
description: 'phone of user. Le texte de value ne peut contenir plus de 14 caractères.'
example: '696661135'
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: "Date de naissance. Le champ value n'est pas une date valide."
example: '1996-03-11'
email:
type: string
description: 'email of user. Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
lang:
type: string
description: ''
example: dolore
/api/note-prestataire:
post:
summary: 'Note prestataire'
operationId: notePrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module Note'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
external_id:
type: string
description: 'Id de la ressource a noté (prestation ou prestataire).'
example: 2
prestation_id:
type: string
description: 'Id de la ressource a noté (prestation ou prestataire).'
example: 2
type:
type: string
description: 'le type de ressource a noté.'
example: prestaire
enum:
- prestation
- prestataire
tag:
type: string
description: 'Commentaire sur la ressource noté.'
example: 'un commentaire'
rate:
type: string
description: 'Une note comprise entre 1-10. Le texte du champ value doit contenir au moins 1 caractères. Le texte de value ne peut contenir plus de 10 caractères.'
example: 6
required:
- external_id
- prestation_id
- type
- tag
- rate
/api/note-prestation:
post:
summary: 'Note prestation'
operationId: notePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module Note'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
external_id:
type: string
description: 'Id de la ressource a noté (prestation ou prestataire).'
example: 2
prestation_id:
type: string
description: 'Id de la ressource a noté (prestation ou prestataire).'
example: 2
type:
type: string
description: 'le type de ressource a noté.'
example: prestaire
enum:
- prestation
- prestataire
tag:
type: string
description: 'Commentaire sur la ressource noté.'
example: 'un commentaire'
rate:
type: string
description: 'Une note comprise entre 1-10. Le texte du champ value doit contenir au moins 1 caractères. Le texte de value ne peut contenir plus de 10 caractères.'
example: 6
required:
- external_id
- prestation_id
- type
- tag
- rate
'/api/note-exist/{prestataire_id}/{prestation_id}':
get:
summary: ''
operationId: getApiNoteExistPrestataire_idPrestation_id
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Note'
parameters:
-
in: path
name: prestataire_id
description: 'The ID of the prestataire.'
example: saepe
required: true
schema:
type: string
-
in: path
name: prestation_id
description: 'The ID of the prestation.'
example: libero
required: true
schema:
type: string
/api/create-partenaire:
post:
summary: "Inscription d'un partenaire"
operationId: inscriptionDunPartenaire
description: ''
parameters: []
responses: { }
tags:
- 'Module Partenaire'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Must not be greater than 255 characters.'
example: John
last_name:
type: string
description: 'name of user. Must not be greater than 255 characters.'
example: Doe
phone:
type: string
description: 'phone of user. Must not be greater than 14 characters.'
example: '696661135'
photo:
type: string
format: binary
description: 'Must be an image. Must not be greater than 2048 kilobytes.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: 'Date de naissance. Must be a valid date.'
example: '1996-03-11'
lang:
type: string
description: ''
example: fr
enum:
- en
- fr
accept_term_condition:
type: boolean
description: 'Must be accepted.'
example: true
email:
type: string
description: 'email of user. Must be a valid email address. Must not be greater than 255 characters.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
password_confirmation:
type: string
description: 'confirm password of user.'
example: Admin@1234
required:
- name
- last_name
- phone
- country_residence
- city_residence
- date_birth
- lang
- accept_term_condition
- email
- password
- password_confirmation
/api/create-prestataire:
post:
summary: 'store prestataire'
operationId: storePrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module Prestataire'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Must not be greater than 255 characters.'
example: John
last_name:
type: string
description: 'name of user. Must not be greater than 255 characters.'
example: Doe
phone:
type: string
description: 'phone of user. Must not be greater than 14 characters.'
example: '696661135'
image:
type: string
format: binary
description: 'Must be an image. Must not be greater than 2048 kilobytes.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: 'Date de naissance. Must be a valid date.'
example: '1996-03-11'
accept_term_condition:
type: boolean
description: 'Accept or deny. Must be accepted.'
example: true
email:
type: string
description: 'email of user. Must be a valid email address. Must not be greater than 255 characters.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
password_confirmation:
type: string
description: 'confirm password of user.'
example: Admin@1234
professional_experience:
type: string
description: 'describe professional experience.'
example: '3 years'
shool_level:
type: string
description: 'describe school level.'
example: 'O level'
specific_skill:
type: string
description: 'define specific skill.'
example: manager
speciality:
type: string
description: 'describe your speciality.'
example: '3'
cni_number:
type: string
description: 'enter your cni number.'
example: '3216586158'
category_prestataire_id:
type: integer
description: 'enter the category.'
example: 2
profession_id:
type: integer
description: 'enter your profession.'
example: 3
payment_method_id:
type: integer
description: 'choose your payment method.'
example: 5
phone_payment:
type: string
description: ''
example: null
required:
- name
- last_name
- phone
- country_residence
- city_residence
- date_birth
- accept_term_condition
- email
- password
- password_confirmation
- professional_experience
- shool_level
- specific_skill
- speciality
- cni_number
- category_prestataire_id
- profession_id
- payment_method_id
/api/get-one-prestataire:
get:
summary: 'show prestataire'
operationId: showPrestataire
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Prestataire'
/api/update-prestataire:
post:
summary: 'Update prestataire'
operationId: updatePrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module Prestataire'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: John
last_name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: Doe
phone:
type: string
description: 'phone of user. Le texte de value ne peut contenir plus de 14 caractères.'
example: '696661135'
lang:
type: string
description: ''
example: iusto
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: "Date de naissance. Le champ value n'est pas une date valide."
example: '1996-03-11'
accept_term_condition:
type: boolean
description: ''
example: true
professional_experience:
type: string
description: ''
example: officiis
shool_level:
type: string
description: ''
example: null
specific_skill:
type: string
description: ''
example: non
speciality:
type: string
description: ''
example: null
cni_number:
type: string
description: ''
example: iusto
category_prestataire_id:
type: number
description: ''
example: 365.16
profession_id:
type: number
description: ''
example: 2580969.4510293
phone_payment:
type: string
description: 'Enter your phone payment.'
example: '3216586158'
required:
- accept_term_condition
/api/professions:
get:
summary: 'All professions'
operationId: allProfessions
description: ''
parameters: []
responses:
403:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Access denied contact the administrator'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Access denied contact the administrator'
tags:
- 'Module Profession'
'/api/get-beneficiary-details/{id}':
get:
summary: ''
operationId: getApiGetBeneficiaryDetailsId
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Souscripteur'
parameters:
-
in: path
name: id
description: 'The ID of the get beneficiary detail.'
example: neque
required: true
schema:
type: string
/api/create-soubscripteur:
post:
summary: 'Creer un souscripteur'
operationId: creerUnSouscripteur
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Must not be greater than 255 characters.'
example: John
last_name:
type: string
description: 'name of user. Must not be greater than 255 characters.'
example: Doe
phone:
type: string
description: 'phone of user. Must not be greater than 14 characters.'
example: '696661135'
photo:
type: string
format: binary
description: 'Must be an image. Must not be greater than 2048 kilobytes.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: 'Date de naissance. Must be a valid date.'
example: '1996-03-11'
lang:
type: string
description: ''
example: fr
enum:
- en
- fr
accept_term_condition:
type: boolean
description: 'Must be accepted.'
example: true
email:
type: string
description: 'email of user. Must be a valid email address. Must not be greater than 255 characters.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
password_confirmation:
type: string
description: 'confirm password of user.'
example: Admin@1234
required:
- name
- last_name
- phone
- country_residence
- city_residence
- date_birth
- lang
- accept_term_condition
- email
- password
- password_confirmation
/api/create-beneficiary:
post:
summary: 'Créer un beneficiaire'
operationId: crerUnBeneficiaire
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: x
last_name:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: eptv
phone:
type: string
description: 'Le texte de value ne peut contenir plus de 14 caractères.'
example: adxjwx
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. Le fichier value ne peut être plus gros que 4048 kilo-octets.'
country_residence:
type: string
description: ''
example: facilis
city_residence:
type: string
description: ''
example: aut
date_birth:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:28'
lang:
type: string
description: ''
example: en
enum:
- en
- fr
accept_term_condition:
type: boolean
description: 'Must be accepted.'
example: true
email:
type: string
description: 'Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: tjacobs@example.com
password:
type: string
description: ''
example: perspiciatis
password_confirmation:
type: string
description: ''
example: doloribus
name_contact:
type: string
description: ''
example: et
phone_contact:
type: string
description: ''
example: enim
parenter:
type: string
description: ''
example: minima
required:
- name
- last_name
- phone
- country_residence
- city_residence
- date_birth
- lang
- accept_term_condition
- email
- password
- password_confirmation
- name_contact
- phone_contact
- parenter
/api/get-beneficiary:
get:
summary: 'Liste beneficiaire souscripteur'
operationId: listeBeneficiaireSouscripteur
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Souscripteur'
'/api/delete-beneficiary/{id}':
delete:
summary: 'Delete Beneficiary'
operationId: deleteBeneficiary
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
parameters:
-
in: path
name: id
description: 'The ID of the delete beneficiary.'
example: quod
required: true
schema:
type: string
/api/update-souscripteur-information:
patch:
summary: 'Metre à jour un souscripteur'
operationId: metreJourUnSouscripteur
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: John
beneficiary_id:
type: string
description: ''
example: null
last_name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: Doe
phone:
type: string
description: 'phone of user. Le texte de value ne peut contenir plus de 14 caractères.'
example: '696661135'
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: "Date de naissance. Le champ value n'est pas une date valide."
example: '1996-03-11'
email:
type: string
description: 'email of user. Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
lang:
type: string
description: ''
example: dolorem
'/api/restrict-souscripteur/{souscripteur_id}':
post:
summary: ''
operationId: postApiRestrictSouscripteurSouscripteur_id
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
parameters:
-
in: path
name: souscripteur_id
description: 'The ID of the souscripteur.'
example: itaque
required: true
schema:
type: string
/api/get-my-souscripteur:
get:
summary: ''
operationId: getApiGetMySouscripteur
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Souscripteur'
'/api/remove-restriction/{souscripteur_id}':
post:
summary: 'Remove restrict souscripteur'
operationId: removeRestrictSouscripteur
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
parameters:
-
in: path
name: souscripteur_id
description: 'The ID of the souscripteur.'
example: non
required: true
schema:
type: string
/api/get-unactived-prestataire:
get:
summary: 'Liste des prestataires inactif'
operationId: listeDesPrestatairesInactif
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
/api/get-unactived-prestataire-filter:
post:
summary: 'Liste des prestataires inactif'
operationId: listeDesPrestatairesInactif
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:28'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2058-05-18'
required:
- start_date
- end_date
/api/active-prestataire:
post:
summary: 'Activer un prestataire'
operationId: activerUnPrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prestataire_id:
type: integer
description: ''
example: 14
required:
- prestataire_id
/api/unactive-prestataire:
post:
summary: 'Désactiver un prestataire'
operationId: dsactiverUnPrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prestataire_id:
type: integer
description: ''
example: 5
required:
- prestataire_id
/api/delete-prestataire:
post:
summary: 'Delete du prestataire'
operationId: deleteDuPrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prestataire_id:
type: integer
description: ''
example: 15
required:
- prestataire_id
/api/get-all-prestataire:
get:
summary: 'Liste des prestataires'
operationId: listeDesPrestataires
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
/api/get-all-souscripteur:
get:
summary: 'Liste des souscripteurs'
operationId: listeDesSouscripteurs
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
/api/get-all-beneficiaries:
get:
summary: 'Liste des bénéficiaires'
operationId: listeDesBnficiaires
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
'/api/get-details-souscripteur/{id}':
get:
summary: "Details d'un souscripteur"
operationId: detailsDunSouscripteur
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
parameters:
-
in: path
name: id
description: 'The ID of the get details souscripteur.'
example: qui
required: true
schema:
type: string
'/api/get-details-beneficiary/{id}':
get:
summary: "Details d'un beneficiaire"
operationId: detailsDunBeneficiaire
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
parameters:
-
in: path
name: id
description: 'The ID of the get details beneficiary.'
example: est
required: true
schema:
type: string
'/api/details-prestataire/{id}':
get:
summary: 'Detail du prestataire'
operationId: detailDuPrestataire
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
parameters:
-
in: path
name: id
description: 'The ID of the details prestataire.'
example: ut
required: true
schema:
type: string
/api/beneficiaires-filter:
post:
summary: ''
operationId: postApiBeneficiairesFilter
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:28'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2049-10-31'
required:
- start_date
- end_date
/api/souscripteurs-filter:
post:
summary: ''
operationId: postApiSouscripteursFilter
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:28'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2074-01-22'
required:
- start_date
- end_date
/api/prestataires-filter:
post:
summary: ''
operationId: postApiPrestatairesFilter
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:28'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2059-12-12'
required:
- start_date
- end_date
'/api/get-prestataires-for-prestation/{id}':
get:
summary: 'Get all Prestation for specific prestation'
operationId: getAllPrestationForSpecificPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
parameters:
-
in: path
name: id
description: 'The ID of the get prestataires for prestation.'
example: libero
required: true
schema:
type: string
'/api/get-prestataires-for-prestation-sollicitation/{id}':
get:
summary: 'Get all Prestation for sollicitation of specific prestation'
operationId: getAllPrestationForSollicitationOfSpecificPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
parameters:
-
in: path
name: id
description: 'The ID of the get prestataires for prestation sollicitation.'
example: ut
required: true
schema:
type: string
'/api/sollicitation/{id}':
post:
summary: ''
operationId: postApiSollicitationId
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
parameters:
-
in: path
name: id
description: 'The ID of the sollicitation.'
example: voluptatum
required: true
schema:
type: string
/api/list-prestation-assigner:
get:
summary: 'Liste prestation non cloturer'
operationId: listePrestationNonCloturer
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
/api/list-prestation-en-attente:
get:
summary: 'Liste prestation en attente'
operationId: listePrestationEnAttente
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module administrateur'
/api/assign-prestataire:
post:
summary: 'Assigner prestation'
operationId: assignerPrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module administrateur'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
prestation_id:
type: integer
description: ''
example: 4
prestataire_id:
type: integer
description: ''
example: 13
required:
- prestation_id
- prestataire_id
/api/categories-prestations:
get:
summary: 'Categories Prestation'
operationId: categoriesPrestation
description: ''
parameters: []
responses:
403:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Access denied contact the administrator'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Access denied contact the administrator'
tags:
- 'Module category Prestation'
'/api/package-details/{id}':
get:
summary: 'Details of the package'
operationId: detailsOfThePackage
description: ''
parameters: []
responses:
403:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Access denied contact the administrator'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Access denied contact the administrator'
tags:
- 'Module package'
parameters:
-
in: path
name: id
description: 'The ID of the package detail.'
example: cum
required: true
schema:
type: string
/api/list-all-package:
get:
summary: 'Get all package'
operationId: getAllPackage
description: ''
parameters: []
responses:
403:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Access denied contact the administrator'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Access denied contact the administrator'
tags:
- 'Module package'
/api/get-package-details-souscription:
get:
summary: 'Details of the package'
operationId: detailsOfThePackage
description: ''
parameters: []
responses:
403:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Access denied contact the administrator'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Access denied contact the administrator'
tags:
- 'Module package'
/api/create-package:
post:
summary: 'Create package'
operationId: createPackage
description: ''
parameters: []
responses: { }
tags:
- 'Module package'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description: 'Enter title.'
example: Premium
category_prestation_id:
type: integer
description: 'Enter category prestation id.'
example: 2
missions:
type: string
description: 'Enter all missions.'
example: 'Guard patient'
price:
type: integer
description: 'Enter price. La valeur de value doit être au moins de 0.'
example: 5000
duration:
type: integer
description: 'La valeur de value doit être au moins de 0.'
example: 79
type:
type: string
description: ''
example: mensuel
enum:
- hebdomadaire
- mensuel
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
amount_prestataire:
type: integer
description: 'La valeur de value doit être au moins de 0.'
example: 71
disabled_at:
type: string
description: "This field is required when disable_option is at. Le champ value n'est pas une date valide. Le champ value doit être une date postérieure au today."
example: '2053-02-13'
required:
- title
- category_prestation_id
- missions
- price
- duration
- type
- photo
- amount_prestataire
'/api/update-package/{id}':
patch:
summary: 'Update package'
operationId: updatePackage
description: ''
parameters: []
responses: { }
tags:
- 'Module package'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
title:
type: string
description: ''
example: quo
category_prestation_id:
type: integer
description: ''
example: 9
missions:
type: string
description: ''
example: possimus
price:
type: integer
description: ''
example: 18
duration:
type: integer
description: ''
example: 8
type:
type: string
description: ''
example: mensuel
enum:
- hebdomadaire
- mensuel
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
amount_prestataire:
type: integer
description: ''
example: 20
disabled_at:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à today."
example: '2030-01-22'
required:
- category_prestation_id
parameters:
-
in: path
name: id
description: 'The ID of the update package.'
example: harum
required: true
schema:
type: string
'/api/supprimer-un-package/{id}':
post:
summary: 'Delete package'
operationId: deletePackage
description: ''
parameters: []
responses: { }
tags:
- 'Module package'
parameters:
-
in: path
name: id
description: 'The ID of the supprimer un package.'
example: sed
required: true
schema:
type: string
/api/update-amount-prestataire:
post:
summary: ''
operationId: postApiUpdateAmountPrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module package'
'/api/isConfirmed/{prestation_id}':
post:
summary: 'Confirmed Prestation by admin.'
operationId: confirmedPrestationByAdmin
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
parameters:
-
in: path
name: prestation_id
description: 'The ID of the prestation.'
example: et
required: true
schema:
type: string
/api/isAvailablePrestation:
get:
summary: 'listing available prestation by prestataire'
operationId: listingAvailablePrestationByPrestataire
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
'/api/details-mission-prestataire/{id}/{patient_id}':
get:
summary: 'Details prestataire prestation'
operationId: detailsPrestatairePrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
parameters:
-
in: path
name: id
description: 'The ID of the details mission prestataire.'
example: nihil
required: true
schema:
type: string
-
in: path
name: patient_id
description: 'The ID of the patient.'
example: quia
required: true
schema:
type: string
'/api/isClosed/{id}':
post:
summary: 'Close Prestation.'
operationId: closePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
isClosed:
type: boolean
description: ''
example: false
required:
- isClosed
parameters:
-
in: path
name: id
description: 'The ID of the isClosed.'
example: dolor
required: true
schema:
type: string
'/api/isCandidate/{id}':
post:
summary: 'Candidate Prestation.'
operationId: candidatePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
isDisponible:
type: string
description: ''
example: eos
required:
- isDisponible
parameters:
-
in: path
name: id
description: 'The ID of the isCandidate.'
example: iste
required: true
schema:
type: string
'/api/CancelIsCandidate/{id}':
post:
summary: 'Cancel Candidate Prestation.'
operationId: cancelCandidatePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
parameters:
-
in: path
name: id
description: 'The ID of the CancelIsCandidate.'
example: occaecati
required: true
schema:
type: string
/api/update-phone-number:
post:
summary: ''
operationId: postApiUpdatePhoneNumber
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
phone_payment:
type: string
description: ''
example: aut
confirm_phone_payment:
type: string
description: 'The value and phone_payment must match. Le texte de value ne peut contenir plus de 255 caractères.'
example: ufvylcufikdzqmfniujsycaf
name_account:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: mbx
required:
- phone_payment
- confirm_phone_payment
- name_account
'/api/detailsPrestation/{id}':
get:
summary: 'Details prestataire prestation'
operationId: detailsPrestatairePrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
parameters:
-
in: path
name: id
description: 'The ID of the detailsPrestation.'
example: quo
required: true
schema:
type: string
'/api/details-patient-rapport/{id}/{patient_id}':
get:
summary: 'Details prestataire prestation'
operationId: detailsPrestatairePrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
parameters:
-
in: path
name: id
description: 'The ID of the details patient rapport.'
example: in
required: true
schema:
type: string
-
in: path
name: patient_id
description: 'The ID of the patient.'
example: distinctio
required: true
schema:
type: string
/api/listPendingPrestation:
get:
summary: 'Pending prestataire prestation'
operationId: pendingPrestatairePrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
/api/listPostulationPrestation:
get:
summary: 'Pending prestataire prestation'
operationId: pendingPrestatairePrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
/api/prestationsYouCanCandidate:
get:
summary: 'Pending prestataire prestation'
operationId: pendingPrestatairePrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
'/api/searchPrestations/{search}':
get:
summary: 'Search prestation'
operationId: searchPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
parameters:
-
in: path
name: search
description: 'Optional parameter.'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: sint
/api/suivi-prestation-by-prestataire:
get:
summary: 'Follow prestation'
operationId: followPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
'/api/isAvailable/{id}':
post:
summary: 'Available Prestation.'
operationId: availablePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
isAvailable:
type: boolean
description: ''
example: true
isDisponible:
type: string
description: ''
example: autem
required:
- isAvailable
- isDisponible
parameters:
-
in: path
name: id
description: 'The ID of the isAvailable.'
example: labore
required: true
schema:
type: string
/api/createPrestation:
post:
summary: 'Choose Prestation.'
operationId: choosePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
beneficiaire_id:
type: integer
description: 'Enter beneficiaire id.'
example: 4
package_id:
type: integer
description: 'Enter package id.'
example: 2
start_date:
type: string
description: "Enter start date. Le champ value n'est pas une date valide."
example: 01/07/2023
required:
- beneficiaire_id
- package_id
/api/get-area-prestation-nearby:
get:
summary: 'Listing prestation area nearby'
operationId: listingPrestationAreaNearby
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
/api/all-prestations:
get:
summary: 'all prestation'
operationId: allPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
/api/all-prestations-filter:
post:
summary: 'all prestation'
operationId: allPrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:28'
end_date:
type: string
description: "Le champ value n'est pas une date valide. Le champ value doit être une date après ou égale à start_date."
example: '2102-11-23'
required:
- start_date
- end_date
/api/prolonger-prestation:
post:
summary: 'Prolonger une Prestation.'
operationId: prolongerUnePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
package_id:
type: integer
description: 'Enter package id.'
example: 2
prestation_id:
type: integer
description: 'Id de la prestation.'
example: 2
start_date:
type: string
description: "Enter start date. Le champ value n'est pas une date valide."
example: 01/07/2023
required:
- package_id
- prestation_id
- start_date
/api/list-prestation-souscripteur:
get:
summary: 'Souscripteur prestation'
operationId: souscripteurPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
/api/suivi-prestation-by-souscripteur:
get:
summary: 'Follow prestation'
operationId: followPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
/api/update-date-prestation:
post:
summary: 'Choose Prestation.'
operationId: choosePrestation
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
package_duration:
type: string
description: ''
example: quos
prestation_id:
type: string
description: ''
example: repudiandae
start_date:
type: string
description: "Le champ value n'est pas une date valide."
example: '2024-09-26T17:31:29'
required:
- package_duration
- prestation_id
- start_date
/api/update-souscripteur-phone-number:
post:
summary: ''
operationId: postApiUpdateSouscripteurPhoneNumber
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
phone_payment:
type: string
description: ''
example: quia
confirm_phone_payment:
type: string
description: 'The value and phone_payment must match. Le texte de value ne peut contenir plus de 255 caractères.'
example: njzcesacajbu
name_account:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: gdnpusg
required:
- phone_payment
- confirm_phone_payment
- name_account
/api/list-prestation-beneficiaire:
get:
summary: 'Souscripteur prestation'
operationId: souscripteurPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module prestation'
'/api/payment/getTransactionStatus/{reference}':
get:
summary: 'Get transaction status'
operationId: getTransactionStatus
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Paiement Module'
parameters:
-
in: path
name: reference
description: ''
example: dolorum
required: true
schema:
type: string
/api/link-payment-generate:
post:
summary: 'Generate payment link'
operationId: generatePaymentLink
description: ''
parameters: []
responses: { }
tags:
- 'Paiement Module'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: string
description: 'amount of the bill.'
example: '5000'
currency:
type: string
description: 'currency of amount.'
example: XAF
description:
type: string
description: 'description of the request payment.'
example: 'Payment de la facture No-YH789'
external_reference:
type: string
description: 'external_reference of the request payment put id of the card_user.'
example: '1'
redirect_url:
type: string
description: 'redirect_url of the links.'
example: '1'
required:
- amount
- currency
- description
- external_reference
- redirect_url
/api/withdrawl:
post:
summary: 'Withdraw OM/MOMO'
operationId: withdrawOMMOMO
description: ''
parameters: []
responses: { }
tags:
- 'Paiement Module'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: string
description: 'amount of the bill.'
example: '5000'
to:
type: integer
description: 'phone number of the user.'
example: 237693468041
description:
type: string
description: 'description of the request payment.'
example: 'Payment de la facture No-YH789'
prestation_id:
type: integer
description: ''
example: 17
required:
- amount
- to
- description
- prestation_id
/api/stripe-checkout:
post:
summary: 'Payment Visa/MasterCard'
operationId: paymentVisaMasterCard
description: ''
parameters: []
responses: { }
tags:
- 'Paiement Module'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
customer_email:
type: string
description: 'Le champ value doit être une adresse email valide.'
example: schamberger.beulah@example.org
product_name:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: nqtxtqpqtuaotuvrleaun
description:
type: string
description: 'Le texte de value ne peut contenir plus de 255 caractères.'
example: 'Inventore voluptatem id sed quis sed fuga.'
total_amount:
type: string
description: ''
example: voluptas
currency:
type: string
description: ''
example: xaf
enum:
- usd
- xaf
- eur
prestation_id:
type: string
description: ''
example: explicabo
required:
- customer_email
- product_name
- description
- total_amount
- currency
- prestation_id
/api/checkout:
post:
summary: 'Payment OM/MOMO'
operationId: paymentOMMOMO
description: ''
parameters: []
responses: { }
tags:
- 'Paiement Module'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
amount:
type: string
description: 'amount of the bill.'
example: '5000'
from:
type: string
description: 'phone number of the user.'
example: '237693468041'
0:
type: string
description: ''
example: null
description:
type: string
description: 'description of the request payment.'
example: 'Payment de la facture No-YH789'
prestation_id:
type: string
description: ''
example: earum
required:
- amount
- from
- description
- prestation_id
/api/get-unvalidated-report:
get:
summary: 'Get unvalidated report'
operationId: getUnvalidatedReport
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Report
/api/get-validated-report:
get:
summary: 'Get validated report'
operationId: getValidatedReport
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Report
'/api/validated-report/{id}':
patch:
summary: 'Validated report'
operationId: validatedReport
description: ''
parameters: []
responses: { }
tags:
- Report
parameters:
-
in: path
name: id
description: 'The ID of the validated report.'
example: in
required: true
schema:
type: string
'/api/unvalidated-report/{id}':
patch:
summary: 'Unvalidated report'
operationId: unvalidatedReport
description: ''
parameters: []
responses: { }
tags:
- Report
parameters:
-
in: path
name: id
description: 'The ID of the unvalidated report.'
example: excepturi
required: true
schema:
type: string
'/api/get-patient-report/{patient_id}':
get:
summary: 'Get all report of my prestation'
operationId: getAllReportOfMyPrestation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Report
parameters:
-
in: path
name: patient_id
description: 'The ID of the patient.'
example: sapiente
required: true
schema:
type: string
'/api/get-report-of-my-patient/{patient_id}':
get:
summary: 'Get report of my patient'
operationId: getReportOfMyPatient
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Report
parameters:
-
in: path
name: patient_id
description: 'The ID of the patient.'
example: nemo
required: true
schema:
type: string
'/api/get-one-report/{id}':
get:
summary: 'Get one report'
operationId: getOneReport
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Report
parameters:
-
in: path
name: id
description: 'The ID of the get one report.'
example: reprehenderit
required: true
schema:
type: string
/api/get-beneficiairy-report:
get:
summary: 'Get beneficiaury report'
operationId: getBeneficiauryReport
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- Report
/api/liste-des-administrateurs:
get:
summary: 'Admin lists'
operationId: adminLists
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Super administrator management'
/api/creer-un-administrateur:
post:
summary: 'Create admin'
operationId: createAdmin
description: ''
parameters: []
responses: { }
tags:
- 'Super administrator management'
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: John
last_name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: Doe
phone:
type: string
description: 'phone of user. Le texte de value ne peut contenir plus de 14 caractères.'
example: '696661135'
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 2048 kilo-octets.'
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: "Date de naissance. Le champ value n'est pas une date valide."
example: '1996-03-11'
lang:
type: string
description: ''
example: en
enum:
- en
- fr
accept_term_condition:
type: boolean
description: 'Must be accepted.'
example: true
email:
type: string
description: 'email of user. Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
password_confirmation:
type: string
description: 'confirm password of user.'
example: Admin@1234
required:
- name
- last_name
- phone
- country_residence
- city_residence
- date_birth
- lang
- accept_term_condition
- email
- password
- password_confirmation
'/api/modifier-un-administrateur/{id}':
patch:
summary: 'Update admin'
operationId: updateAdmin
description: ''
parameters: []
responses: { }
tags:
- 'Super administrator management'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: John
last_name:
type: string
description: 'name of user. Le texte de value ne peut contenir plus de 255 caractères.'
example: Doe
phone:
type: string
description: 'phone of user. Le texte de value ne peut contenir plus de 14 caractères.'
example: '696661135'
image:
type: string
description: ''
example: null
country_residence:
type: string
description: 'Pays de résidence.'
example: Cameroun
city_residence:
type: string
description: 'Ville de résidence.'
example: Yaoundé
date_birth:
type: string
description: "Date de naissance. Le champ value n'est pas une date valide."
example: '1996-03-11'
email:
type: string
description: 'email of user. Le champ value doit être une adresse email valide. Le texte de value ne peut contenir plus de 255 caractères.'
example: nativemind@google.com
password:
type: string
description: 'password of user.'
example: Admin@1234
parameters:
-
in: path
name: id
description: 'The ID of the modifier un administrateur.'
example: aut
required: true
schema:
type: string
'/api/supprimer-un-administrateur/{id}':
post:
summary: 'Delete admin'
operationId: deleteAdmin
description: ''
parameters: []
responses: { }
tags:
- 'Super administrator management'
parameters:
-
in: path
name: id
description: 'The ID of the supprimer un administrateur.'
example: sint
required: true
schema:
type: string
/api/check-exist-email:
post:
summary: ''
operationId: postApiCheckExistEmail
description: ''
parameters: []
responses: { }
tags:
- 'User management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Le champ value doit être une adresse email valide.'
example: bednar.darrion@example.com
required:
- email
/api/user/auth:
get:
summary: 'Display the specified User information.'
operationId: displayTheSpecifiedUserInformation
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'User management'
/api/user-update-info:
post:
summary: 'Update the User information'
operationId: updateTheUserInformation
description: ''
parameters: []
responses: { }
tags:
- 'User management'
/api/change-avatar:
post:
summary: 'Change Avatar user'
operationId: changeAvatarUser
description: ''
parameters: []
responses: { }
tags:
- 'User management'
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
photo:
type: string
format: binary
description: 'Le champ value doit être une image. Le fichier value ne peut être plus gros que 3072 kilo-octets.'
/api/change-lang:
post:
summary: ''
operationId: postApiChangeLang
description: ''
parameters: []
responses: { }
tags:
- 'User management'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
lang:
type: string
description: ''
example: en
enum:
- en
- fr
/api/verify-email-with-otp:
post:
summary: 'Verify email with otp code'
operationId: verifyEmailWithOtpCode
description: ''
parameters: []
responses: { }
tags:
- 'User management'
/api/all-appointment:
get:
summary: 'List all appoitments'
operationId: listAllAppoitments
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Appoitment'
/api/store-appoitment:
post:
summary: 'Create appoitment'
operationId: createAppoitment
description: ''
parameters: []
responses: { }
tags:
- 'Module Appoitment'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: ''
example: ''
titre:
type: string
description: 'New events.'
example: 2
label:
type: string
description: 'Consultation à domicile.'
example: 'Consultation à domicile'
date_debut:
type: string
description: "Start date. Le champ value n'est pas une date valide."
example: 09/10/2023
date_fin:
type: string
description: "End date. Le champ value n'est pas une date valide."
example: 09/10/2023
allDay:
type: boolean
description: 'true or false.'
example: true
patient_id:
type: string
description: 'Beneficiaire id.'
example: 10
localisation:
type: string
description: Lieu.
example: 'New localisation'
description_localisation:
type: string
description: 'Description lieu.'
example: 'Description New localisation'
required:
- titre
- label
- date_debut
- date_fin
- allDay
- localisation
'/api/one-appoitment/{id}':
get:
summary: 'Show one appoitment'
operationId: showOneAppoitment
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module Appoitment'
parameters:
-
in: path
name: id
description: 'The ID of the one appoitment.'
example: fugit
required: true
schema:
type: string
'/api/update-appointment/{id}':
put:
summary: 'Update appoitment'
operationId: updateAppoitment
description: ''
parameters: []
responses: { }
tags:
- 'Module Appoitment'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
type: string
description: ''
example: ''
titre:
type: string
description: 'New events.'
example: 2
label:
type: string
description: 'Consultation à domicile.'
example: 'Consultation à domicile'
date_debut:
type: string
description: "Start date. Le champ value n'est pas une date valide."
example: 09/10/2023
date_fin:
type: string
description: "End date. Le champ value n'est pas une date valide."
example: 09/10/2023
allDay:
type: boolean
description: 'true or false.'
example: true
patient_id:
type: string
description: 'Beneficiaire id.'
example: 10
localisation:
type: string
description: Lieu.
example: 'New localisation'
description_localisation:
type: string
description: 'Description lieu.'
example: 'Description New localisation'
required:
- titre
- label
- date_debut
- date_fin
- allDay
- localisation
parameters:
-
in: path
name: id
description: 'The ID of the update appointment.'
example: quo
required: true
schema:
type: string
'/api/delete-appointment/{id}':
delete:
summary: 'Destroy one appoitment'
operationId: destroyOneAppoitment
description: ''
parameters: []
responses: { }
tags:
- 'Module Appoitment'
parameters:
-
in: path
name: id
description: 'The ID of the delete appointment.'
example: eos
required: true
schema:
type: string
tags:
-
name: Endpoints
description: ''
-
name: Evenement
description: ''
-
name: 'Module Authentification'
description: ''
-
name: 'Module Beneficiaire'
description: ''
-
name: 'Module Note'
description: ''
-
name: 'Module Partenaire'
description: ''
-
name: 'Module Prestataire'
description: ''
-
name: 'Module Profession'
description: ''
-
name: 'Module Souscripteur'
description: ''
-
name: 'Module administrateur'
description: ''
-
name: 'Module category Prestation'
description: ''
-
name: 'Module package'
description: ''
-
name: 'Module prestation'
description: ''
-
name: 'Paiement Module'
description: ''
-
name: Report
description: ''
-
name: 'Super administrator management'
description: ''
-
name: 'User management'
description: ''
-
name: 'Module Appoitment'
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard and clicking Generate API token.'
security:
-
default: []