openapi: 3.0.3
info:
title: 'Service for age Api'
description: ''
version: 1.0.0
servers:
-
url: 'https://api.services4aged.com'
paths:
'/api/payment/getTransactionStatus/{reference}':
post:
summary: 'Get transaction status'
operationId: getTransactionStatus
description: ''
parameters: []
responses: { }
tags:
- 'Paiement Module'
parameters:
-
in: path
name: reference
description: ''
example: doloribus
required: true
schema:
type: string
/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: 'Must be a valid email address.'
example: raleigh.mueller@example.net
product_name:
type: string
description: 'Must not be greater than 255 characters.'
example: zjyggiauomskqbybtp
total_amount:
type: string
description: ''
example: atque
currency:
type: string
description: ''
example: eur
enum:
- usd
- xaf
- eur
required:
- customer_email
- product_name
- total_amount
- currency
/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'
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'
external_user:
type: string
description: 'external_user Represent the Order Id.'
example: '1'
required:
- amount
- from
- description
- external_reference
- external_user
/api/withdraw:
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'
external_reference:
type: integer
description: 'external_reference of the request payment put id of the card_user.'
example: 1
required:
- amount
- to
- description
- external_reference
/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/create-prestataire:
post:
summary: 'store prestataire'
operationId: storePrestataire
description: ''
parameters: []
responses: { }
tags:
- 'Module Prestataire'
requestBody:
required: true
content:
application/json:
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
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. Must be a valid date.'
example: '1996-03-11'
accept_term_condition:
type: boolean
description: ''
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: integer
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
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. 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'
lang:
type: string
description: ''
example: quis
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'
accept_term_condition:
type: boolean
description: ''
example: false
professional_experience:
type: string
description: ''
example: eos
shool_level:
type: string
description: ''
example: null
specific_skill:
type: string
description: ''
example: cum
speciality:
type: string
description: ''
example: null
cni_number:
type: number
description: ''
example: 737796.79256091
category_prestataire_id:
type: number
description: ''
example: 2433.7
profession_id:
type: number
description: ''
example: 205386.05
required:
- accept_term_condition
'/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: natus
required: true
schema:
type: string
'/api/restrict-souscripteur/{souscripteur_id}':
patch:
summary: ''
operationId: patchApiRestrictSouscripteurSouscripteur_id
description: ''
parameters: []
responses: { }
tags:
- 'Module Souscripteur'
parameters:
-
in: path
name: souscripteur_id
description: 'The ID of the souscripteur.'
example: blanditiis
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: en
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/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: cumque
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. Must not be greater than 255 characters.'
example: John
beneficiary_id:
type: string
description: ''
example: null
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.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. 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'
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
lang:
type: string
description: ''
example: temporibus
'/api/remove-restriction/{souscripteur_id}':
patch:
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: ut
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: en
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/package-details/{id}':
get:
summary: ''
operationId: getApiPackageDetailsId
description: ''
parameters: []
responses:
404:
description: ''
content:
application/json:
schema:
type: object
example:
status: false
errors: []
message: 'Package not found'
properties:
status:
type: boolean
example: false
errors:
type: array
example: []
message:
type: string
example: 'Package not found'
tags:
- 'Module package'
parameters:
-
in: path
name: id
description: 'The ID of the package detail.'
example: eveniet
required: true
schema:
type: string
/api/list-all-package:
get:
summary: 'Get all package'
operationId: getAllPackage
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: true
data:
packages:
-
id: 1
title: 'Offre De Base'
category_prestation_id: 4
missions: 'aide soignante sexy'
price: 3000
duration: 30
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
title: 'Offre Bonus'
category_prestation_id: 1
missions: 'Réaliser des courses une fois par semaine. Le coût du panier à la charge du souscripteur'
price: 40000
duration: 30
created_at: '2023-09-20T03:58:34.000000Z'
updated_at: '2023-09-20T03:58:34.000000Z'
-
id: 3
title: 'Offre Premium'
category_prestation_id: 2
missions: "Offre de Base\r\n Offre S4A3 : Consultation à domicile une fois par mois\r\n Offre S4A2 : Hygiène de vie et soin corporelle une fois par semaine"
price: 50000
duration: 30
created_at: '2023-09-20T02:55:20.000000Z'
updated_at: '2023-09-20T03:58:34.000000Z'
-
id: 4
title: 'Offre Platinum'
category_prestation_id: 4
missions: "Offre Platinum\r\nOffre de Base\r\n Offre S4A3 : Consultation à domicile une fois par mois\r\n Offre S4A2 : Hygiène de vie et soin corporelle une fois par semaine\r\n Offre S4A5 : Loisir et vie sociale une fois par semaine"
price: 100000
duration: 30
created_at: '2023-09-20T03:58:34.000000Z'
updated_at: '2023-09-20T02:55:20.000000Z'
message: 'Package charged successfully'
properties:
status:
type: boolean
example: true
data:
type: object
properties:
packages:
type: array
example:
-
id: 1
title: 'Offre De Base'
category_prestation_id: 4
missions: 'aide soignante sexy'
price: 3000
duration: 30
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
title: 'Offre Bonus'
category_prestation_id: 1
missions: 'Réaliser des courses une fois par semaine. Le coût du panier à la charge du souscripteur'
price: 40000
duration: 30
created_at: '2023-09-20T03:58:34.000000Z'
updated_at: '2023-09-20T03:58:34.000000Z'
-
id: 3
title: 'Offre Premium'
category_prestation_id: 2
missions: "Offre de Base\r\n Offre S4A3 : Consultation à domicile une fois par mois\r\n Offre S4A2 : Hygiène de vie et soin corporelle une fois par semaine"
price: 50000
duration: 30
created_at: '2023-09-20T02:55:20.000000Z'
updated_at: '2023-09-20T03:58:34.000000Z'
-
id: 4
title: 'Offre Platinum'
category_prestation_id: 4
missions: "Offre Platinum\r\nOffre de Base\r\n Offre S4A3 : Consultation à domicile une fois par mois\r\n Offre S4A2 : Hygiène de vie et soin corporelle une fois par semaine\r\n Offre S4A5 : Loisir et vie sociale une fois par semaine"
price: 100000
duration: 30
created_at: '2023-09-20T03:58:34.000000Z'
updated_at: '2023-09-20T02:55:20.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
title:
type: string
example: 'Offre De Base'
category_prestation_id:
type: integer
example: 4
missions:
type: string
example: 'aide soignante sexy'
price:
type: integer
example: 3000
duration:
type: integer
example: 30
created_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
updated_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
message:
type: string
example: 'Package charged successfully'
tags:
- 'Module package'
/api/create-package:
get:
summary: 'Create package'
operationId: createPackage
description: ''
parameters: []
responses:
401:
description: ''
content:
application/json:
schema:
type: object
example:
message: Unauthenticated.
properties:
message:
type: string
example: Unauthenticated.
tags:
- 'Module package'
requestBody:
required: true
content:
application/json:
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.'
example: 5000
duration:
type: integer
description: ''
example: 8
required:
- title
- category_prestation_id
- missions
- price
- duration
/api/verify-token:
post:
summary: ''
operationId: postApiVerifyToken
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
/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: 'Must be a valid email address.'
example: jrunolfsdottir@example.net
password:
type: string
description: ''
example: 'N&:lODQ>[9=G/Qe{p'
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: 'Must be a valid email address.'
example: heaney.mossie@example.net
device:
type: string
description: ''
example: rerum
required:
- email
- device
security: []
/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: 'Must be a valid email address. Must not be greater than 255 characters.'
example: myrl70@example.com
otp:
type: string
description: ''
example: non
required:
- email
- otp
/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: web
enum:
- mobile
- web
email:
type: string
description: 'Must be a valid email address.'
example: raegan27@example.org
password:
type: string
description: ''
example: doloribus
required:
- device
- email
- password
security: []
'/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: in
required: true
schema:
type: string
-
in: path
name: hash
description: ''
example: cupiditate
required: true
schema:
type: string
/api/email/resend-verification-notification:
post:
summary: 'Resend email verification'
operationId: resendEmailVerification
description: ''
parameters: []
responses: { }
tags:
- 'Module Authentification'
/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: 'Must be a valid email address.'
example: hagenes.dandre@example.org
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: 'Must be an image. Must not be greater than 3072 kilobytes.'
/api/verify-email-with-otp:
post:
summary: 'Verify email with otp code'
operationId: verifyEmailWithOtpCode
description: ''
parameters: []
responses: { }
tags:
- 'User management'
/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/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: 16
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: 2
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/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: 1
prestataire_id:
type: integer
description: ''
example: 18
required:
- prestation_id
- prestataire_id
'/api/isConfirmed/{prestation_id}':
patch:
summary: 'Confirmed Prestation by admin.'
operationId: confirmedPrestationByAdmin
description: ''
parameters: []
responses: { }
tags:
- 'Module prestation'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
isConfirmed:
type: boolean
description: ''
example: false
required:
- isConfirmed
parameters:
-
in: path
name: prestation_id
description: 'The ID of the prestation.'
example: voluptate
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/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: true
required:
- isClosed
parameters:
-
in: path
name: id
description: 'The ID of the isClosed.'
example: occaecati
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:
isAvailable:
type: boolean
description: ''
example: true
required:
- isAvailable
parameters:
-
in: path
name: id
description: 'The ID of the isCandidate.'
example: earum
required: true
schema:
type: string
'/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: totam
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: sed
required: true
schema:
type: string
-
in: path
name: patient_id
description: 'The ID of the patient.'
example: quia
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/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: dolores
/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: false
required:
- isAvailable
parameters:
-
in: path
name: id
description: 'The ID of the isAvailable.'
example: aut
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. Must be a valid date.'
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/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. Must be a valid date.'
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/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. 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: en
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/supprimer-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. 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
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. Must be a valid date.'
example: '1996-03-11'
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
parameters:
-
in: path
name: id
description: 'The ID of the supprimer un administrateur.'
example: neque
required: true
schema:
type: string
'/api/modifier-un-administrateur/{id}':
delete:
summary: 'Delete admin'
operationId: deleteAdmin
description: ''
parameters: []
responses: { }
tags:
- 'Super administrator management'
parameters:
-
in: path
name: id
description: 'The ID of the modifier un administrateur.'
example: adipisci
required: true
schema:
type: string
/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. Must not be greater than 255 characters.'
example: John
beneficiary_id:
type: string
description: ''
example: null
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.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. 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'
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
lang:
type: string
description: ''
example: suscipit
/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. Must not be greater than 255 characters.'
example: John
beneficiary_id:
type: string
description: ''
example: null
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.'
file_antecedent_medicaux:
type: string
format: binary
description: 'Must be a file. 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'
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
lang:
type: string
description: ''
example: enim
/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
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. Must be at least 1 character. Must not be greater than 10 characters.'
example: 6
required:
- external_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
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. Must be at least 1 character. Must not be greater than 10 characters.'
example: 6
required:
- external_id
- type
- tag
- rate
'/api/note-exist/{prestation_id}':
get:
summary: ''
operationId: getApiNoteExistPrestation_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: prestation_id
description: 'The ID of the prestation.'
example: autem
required: true
schema:
type: string
/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: 'Must not be greater than 255 characters.'
example: adwu
description:
type: string
description: ''
example: 'Magni voluptas suscipit eos hic aut.'
start_date:
type: string
description: 'Must be a valid date.'
example: '2023-10-06T13:45:20'
end_date:
type: string
description: 'Must be a valid date. Must be a date after or equal to start_date.'
example: '2049-06-22'
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: 'Must not be greater than 255 characters.'
example: tkifzv
description:
type: string
description: ''
example: 'Modi ut voluptas illo neque voluptas pariatur recusandae consequatur.'
start_date:
type: string
description: 'Must be a valid date.'
example: '2023-10-06T13:45:20'
end_date:
type: string
description: 'Must be a valid date. Must be a date after or equal to start_date.'
example: '2038-06-19'
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: mollitia
required: true
schema:
type: string
/api/payments-methods:
get:
summary: ''
operationId: getApiPaymentsMethods
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: true
data:
payments:
-
id: 1
name: 'Orange Money'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
name: 'Mtn Money'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 3
name: 'Yoome Monney'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 4
name: Cash
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 5
name: 'Carte de credit'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
message: 'Payment charged successfully'
properties:
status:
type: boolean
example: true
data:
type: object
properties:
payments:
type: array
example:
-
id: 1
name: 'Orange Money'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
name: 'Mtn Money'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 3
name: 'Yoome Monney'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 4
name: Cash
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 5
name: 'Carte de credit'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Orange Money'
created_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
updated_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
message:
type: string
example: 'Payment charged successfully'
tags:
- Endpoints
/api/professions:
get:
summary: 'All professions'
operationId: allProfessions
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: true
data:
professions:
-
id: 1
name: Medecin
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
name: 'Aide soignant'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 3
name: Infirmier
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 4
name: "Agent d'entretien"
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 5
name: 'Auxilliaire de vie'
created_at: '2023-09-28T16:45:05.000000Z'
updated_at: '2023-09-28T16:45:05.000000Z'
-
id: 6
name: Coursier
created_at: '2023-09-28T16:45:05.000000Z'
updated_at: '2023-09-28T16:45:05.000000Z'
-
id: 7
name: 'Assistant social'
created_at: '2023-09-28T16:45:58.000000Z'
updated_at: '2023-09-28T16:45:58.000000Z'
message: 'Professions charged successfully'
properties:
status:
type: boolean
example: true
data:
type: object
properties:
professions:
type: array
example:
-
id: 1
name: Medecin
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
name: 'Aide soignant'
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 3
name: Infirmier
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 4
name: "Agent d'entretien"
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 5
name: 'Auxilliaire de vie'
created_at: '2023-09-28T16:45:05.000000Z'
updated_at: '2023-09-28T16:45:05.000000Z'
-
id: 6
name: Coursier
created_at: '2023-09-28T16:45:05.000000Z'
updated_at: '2023-09-28T16:45:05.000000Z'
-
id: 7
name: 'Assistant social'
created_at: '2023-09-28T16:45:58.000000Z'
updated_at: '2023-09-28T16:45:58.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Medecin
created_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
updated_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
message:
type: string
example: 'Professions charged successfully'
tags:
- 'Module Profession'
/api/categories-prestations:
get:
summary: 'Categories Prestation'
operationId: categoriesPrestation
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
status: true
data:
categories:
-
id: 1
name: Santé
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
name: Ménage
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 3
name: Loisir
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 4
name: Auxilliaire
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
message: 'Categories Prestation charged successfully'
properties:
status:
type: boolean
example: true
data:
type: object
properties:
categories:
type: array
example:
-
id: 1
name: Santé
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 2
name: Ménage
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 3
name: Loisir
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
-
id: 4
name: Auxilliaire
created_at: '2023-09-05T23:20:48.000000Z'
updated_at: '2023-09-05T23:20:48.000000Z'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Santé
created_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
updated_at:
type: string
example: '2023-09-05T23:20:48.000000Z'
message:
type: string
example: 'Categories Prestation charged successfully'
tags:
- 'Module category Prestation'
'/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: facere
required: true
schema:
type: string
/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: ab
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: aliquid
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: explicabo
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: quis
required: true
schema:
type: string
/api/store-rapport-prestation:
post:
summary: 'Store report'
operationId: storeReport
description: ''
parameters: []
responses: { }
tags:
- Report
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
patient_id:
type: string
description: 'ID du patient.'
example: 1
prestation_id:
type: string
description: 'ID de la prestation.'
example: 3
motifs:
type: string
description: 'Motifs de la consultation.'
example: 'Douleurs abdominales'
history_antecedents:
type: string
description: 'Antécédents médicaux.'
example: 'Hypertension artérielle'
enquete_system:
type: string
description: 'Enquête systémique.'
example: 'Cardiovasculaire, respiratoire'
imc:
type: number
description: 'Indice de masse corporelle.'
example: 25.5
pa:
type: number
description: 'Pression artérielle.'
example: 120.0
fc:
type: number
description: 'Fréquence cardiaque.'
example: 75.0
sao2:
type: number
description: 'Saturation en oxygène.'
example: 97.0
temperature:
type: number
description: 'Température corporelle.'
example: 37.5
diagnostic_differentiels:
type: string
description: 'Diagnostics différentiels.'
example: 'Gastro-entérite, ulcère gastroduodénal'
file:
type: string
description: 'Fichier (rapport médical, etc.). Must not be greater than 10240 characters.'
example: rapport_medical.pdf
prise_en_charge:
type: string
description: 'Prise en charge.'
example: Médication
enquete_nutritionnelle:
type: string
description: 'Enquête nutritionnelle.'
example: 'Régime équilibré'
enquete_hygiene:
type: string
description: 'Enquête hygiène.'
example: 'Bonne hygiène corporelle'
required:
- patient_id
- prestation_id
- motifs
- history_antecedents
- enquete_system
- imc
- pa
- fc
- sao2
- temperature
- diagnostic_differentiels
- prise_en_charge
- enquete_nutritionnelle
- enquete_hygiene
/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
tags:
-
name: 'Paiement Module'
description: ''
-
name: 'Module Prestataire'
description: ''
-
name: 'Module Souscripteur'
description: ''
-
name: 'Module Partenaire'
description: ''
-
name: 'Module package'
description: ''
-
name: 'Module Authentification'
description: ''
-
name: 'User management'
description: ''
-
name: 'Module administrateur'
description: ''
-
name: 'Module prestation'
description: ''
-
name: 'Super administrator management'
description: ''
-
name: 'Module Beneficiaire'
description: ''
-
name: 'Module Note'
description: ''
-
name: Evenement
description: ''
-
name: Endpoints
description: ''
-
name: 'Module Profession'
description: ''
-
name: 'Module category Prestation'
description: ''
-
name: Report
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: []