{"openapi":"3.0.1","info":{"title":"Business Gateway API"},"servers":[{"url":"http://recmkpmid-vli01.april.interne.fr:21117","description":"Generated server url"}],"paths":{"/sales/v1/projects/{projectId}/needs":{"get":{"tags":["04 - Needs"],"summary":"Get the need of a project","operationId":"getNeedByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NeedResponseWrapper"}}}}}},"put":{"tags":["04 - Needs"],"summary":"Update the need to a project","operationId":"updateNeedByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Need"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NeedResponseWrapper"}}}}}},"post":{"tags":["04 - Needs"],"summary":"Add the need to a project","operationId":"createNeedByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Need"}}}},"responses":{"201":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NeedResponseWrapper"}}}}}},"delete":{"tags":["04 - Needs"],"summary":"Delete the need of a project","operationId":"deleteNeedByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/characteristics":{"get":{"tags":["03 - Projects"],"summary":"Get characteristics of a project","operationId":"getCharacteristicsByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CharacteristicsResponseWrapper"}}}}}},"put":{"tags":["03 - Projects"],"summary":"Update characteristics of a project","operationId":"updateCharacteristicsByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Characteristics"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CharacteristicsResponseWrapper"}}}}}},"post":{"tags":["03 - Projects"],"summary":"Add characteristics to a project","operationId":"createCharacteristicsByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Characteristics"}}}},"responses":{"201":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CharacteristicsResponseWrapper"}}}}}},"delete":{"tags":["03 - Projects"],"summary":"Delete characteristics of a project","operationId":"deleteCharacteristicsByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects":{"post":{"tags":["03 - Projects"],"summary":"Create a new project","operationId":"createProject","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCreationRequestWrapper"}}}},"responses":{"201":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectCreationResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}":{"delete":{"tags":["03 - Projects"],"summary":"Delete a project","operationId":"deleteProject","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/contributors":{"get":{"tags":["03 - Projects"],"summary":"Get contributors of a project","operationId":"getContributorsByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Contributor"}}}}}}},"post":{"tags":["03 - Projects"],"summary":"Add a contributor to a project","operationId":"createContributorByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contributor"}}}},"responses":{"201":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Contributor"}}}}}}},"/sales/v1/projects/{projectId}/contributors/{contributorId}":{"get":{"tags":["03 - Projects"],"summary":"Get a contributor of a project","operationId":"getContributorByProjectIdAndContributorId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"contributorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Contributor"}}}}}},"put":{"tags":["03 - Projects"],"summary":"Update a contributor of a project","operationId":"updateContributorByProjectIdAndContributorId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"contributorId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contributor"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Contributor"}}}}}},"delete":{"tags":["03 - Projects"],"summary":"Delete a contributor from a project","operationId":"deleteContributorByProjectIdAndContributorId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"contributorId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/documents_to_sign":{"get":{"tags":["06 - Subscription"],"summary":"Get documents to sign for the offer for third part signature subscription mode","operationId":"getDocumentsToSignByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentSignature"}}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/signed_document/{documentId}":{"put":{"tags":["06 - Subscription"],"summary":"Upload a signed base 64 document","operationId":"uploadBase64DocumentSignatureByProjectIdAndOfferIdAndDocumentId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSignatureUploadRequestWrapper"}}}},"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/contract/documents":{"get":{"tags":["06 - Subscription"],"summary":"Get contractual documents for the subscription to an offer","operationId":"getDocumentsContractByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentContract"}}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/contract/documents/{documentId}":{"get":{"tags":["06 - Subscription"],"summary":"Download a base 64 contractual document","operationId":"downloadBase64DocumentContractByProjectIdAndQuotationIdAndDocumentId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Base64DocumentResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/documents_to_sign/{documentId}":{"get":{"tags":["06 - Subscription"],"summary":"Download a base 64 document to sign","operationId":"downloadBase64DocumentSignatureByProjectIdAndOfferIdAndDocumentId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Base64DocumentResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription_modes":{"get":{"tags":["06 - Subscription"],"summary":"Get the subscription modes available for the offer","operationId":"getSubscriptionModesByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubscriptionModesAvailableResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription":{"post":{"tags":["06 - Subscription"],"summary":"Start subscription to the offer","operationId":"createSubscriptionByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionCreationRequestWrapper"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SubscriptionCreationResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/status":{"get":{"tags":["06 - Subscription"],"summary":"Get subscription status to the offer","operationId":"getSubscriptionStatusByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Status"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/reimbursement_modes":{"get":{"tags":["06 - Subscription"],"summary":"Get the reimbursement modes available for the offer","operationId":"getReimbursementModesByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReimbursementModesAvailableResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/payment_modes":{"get":{"tags":["06 - Subscription"],"summary":"Get the payment modes available for the offer","operationId":"getPaymentModesByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaymentModesAvailableResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/accounts_information":{"get":{"tags":["06 - Subscription"],"summary":"Get all accounts information for the offer","operationId":"getAccountsInformationByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountsInformationResponseWrapper"}}}}}},"put":{"tags":["06 - Subscription"],"summary":"Update all accounts information for the offer","operationId":"updateAccountsInformationByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsInformationCreationRequestWrapper"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountsInformationResponseWrapper"}}}}}},"post":{"tags":["06 - Subscription"],"summary":"Fill all accounts information for the offer","operationId":"createAccountsInformationByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountsInformationCreationRequestWrapper"}}}},"responses":{"201":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountsInformationResponseWrapper"}}}}}},"delete":{"tags":["06 - Subscription"],"summary":"Delete all accounts information for the offer","operationId":"deleteAccountsInformationByProjectIdAndOfferId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/offers/{offerId}/subscription/validation":{"post":{"tags":["06 - Subscription"],"summary":"Validate a subscription to an offer","operationId":"validateSubscription","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"offerId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/offers/quotations/{quotationId}/documents":{"get":{"tags":["05 - Sales"],"summary":"Get a list of all documents for the quotation","operationId":"getDocumentsQuotationByProjectIdAndQuotationId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"quotationId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DocumentQuotation"}}}}}}}},"/sales/v1/projects/{projectId}/offers/quotations/{quotationId}/documents/{documentId}":{"get":{"tags":["05 - Sales"],"summary":"Download a base 64 document for the quotation","operationId":"downloadBase64DocumentQuotationByProjectIdAndQuotationIdAndDocumentId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"quotationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"documentId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Base64DocumentResponseWrapper"}}}}}}},"/sales/v1/projects/{projectId}/offers/quotations/{quotationId}/email":{"post":{"tags":["05 - Sales"],"summary":"Send quotation documents by email","operationId":"sendQuotationDocumentsByEmailByProjectIdAndQuotationId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"quotationId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotationSharingRequestWrapper"}}}},"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/offers/quotations/{quotationId}/online":{"post":{"tags":["05 - Sales"],"summary":"Send quotation access URL by email","operationId":"sendQuotationUrlAccessByEmailByProjectIdAndQuotationId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}},{"name":"quotationId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotationSharingRequestWrapper"}}}},"responses":{"204":{"description":"default response"}}}},"/sales/v1/projects/{projectId}/rate":{"get":{"tags":["05 - Sales"],"summary":"Get a rate for the products suggested by the needs filled for the project","operationId":"getRateByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Rate"}}}}}}}},"/sales/v1/projects/{projectId}/offers":{"get":{"tags":["05 - Sales"],"summary":"Get all offers based on products information for the project","operationId":"getAllOffersByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}}}}}}},"post":{"tags":["05 - Sales"],"summary":"Fill an bodyWrapper based on products information for the project","operationId":"createOfferByProjectId","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferCreationRequestWrapper"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Offer"}}}}}}},"/sales/v1/projects/{projectId}/offers/quotations":{"post":{"tags":["05 - Sales"],"summary":"Ask for a quote for offers and generate the quotation documents","operationId":"createQuotationByProjectIdAndOfferIds","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuotationCreationRequestWrapper"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/QuotationCreationResponseWrapper"}}}}}}},"/information/v1/referentials/civilities":{"get":{"tags":["01 - Common referentials"],"summary":"Referential of civilities","operationId":"getCivilitiesV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericReference"}}}}}}}},"/information/v1/referentials/countries":{"get":{"tags":["01 - Common referentials"],"summary":"Referential of countries","operationId":"getCountriesV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CountryReference"}}}}}}}},"/information/v1/referentials/marital_status":{"get":{"tags":["01 - Common referentials"],"summary":"Referential of marital status","operationId":"getMaritalStatusV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericReference"}}}}}}}},"/information/v1/referentials/townships":{"get":{"tags":["01 - Common referentials"],"summary":"Referential of township by country","operationId":"getTownshipsV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}},{"name":"ISOcode2","in":"query","required":false,"schema":{"type":"string","default":"fr"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericReference"}}}}}}}},"/information/v1/referentials/departments":{"get":{"tags":["01 - Common referentials"],"summary":"Referential of department by country","operationId":"getDepartmentsV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}},{"name":"ISOcode2","in":"query","required":false,"schema":{"type":"string","default":"fr"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GenericReference"}}}}}}}},"/healthcare/v1/products/{productId}/commissions":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Get a list of commissions available for a product","operationId":"getCommissionsByProductId","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CommissionsAvailable"}}}}}}},"/healthcare/v1/products/{productCode}/coverage-summary":{"post":{"tags":["02 - Health specifics referentials"],"summary":"Get a coverage summary for given product, level and options","operationId":"getCoverageSummaryByProductId","parameters":[{"name":"productCode","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CoverageSummaryRequestWrapper"}}}},"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CoverageSummaryResponseWrapper"}}}}}}},"/healthcare/v1/products":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Get a list of health care product available","operationId":"getProducts","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Product"}}}}}}}},"/healthcare/v1/products/{productCode}":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Get details of a health care product","operationId":"getProductByCode","parameters":[{"name":"productCode","in":"path","required":true,"schema":{"type":"string"}},{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Product"}}}}}}},"/healthcare/v1/professional_activities":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Referential of jobs","operationId":"getJobsV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthGenericReference"}}}}}}}},"/healthcare/v1/professional_status":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Referential of professional status","operationId":"getProfessionalStatusV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthGenericReference"}}}}}}}},"/healthcare/v1/mandatory_schemes":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Referential of mandatory schemes","operationId":"getMandatorySchemesV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}},{"name":"ISOcode2","in":"query","required":false,"schema":{"type":"string","default":"fr"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthGenericReference"}}}}}}}},"/healthcare/v1/basic_health_covers":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Referential of basic health covers","operationId":"getBasicHealthCoversV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}},{"name":"ISOcode2","in":"query","required":false,"schema":{"type":"string","default":"fr"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthGenericReference"}}}}}}}},"/healthcare/v1/roles":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Referential of roles","operationId":"getRolesV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthGenericReference"}}}}}}}},"/healthcare/v1/relationships":{"get":{"tags":["02 - Health specifics referentials"],"summary":"Referential of relationships","operationId":"getRelationshipsV1","parameters":[{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"*"}}],"responses":{"200":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/HealthGenericReference"}}}}}}}}},"components":{"schemas":{"BasicHealthCovers":{"type":"object","properties":{"hospitalization":{"type":"integer","format":"int32"},"medicalExpenses":{"type":"integer","format":"int32"},"optical":{"type":"integer","format":"int32"},"dental":{"type":"integer","format":"int32"}}},"Need":{"type":"object","properties":{"basicHealthCovers":{"$ref":"#/components/schemas/BasicHealthCovers"},"basicHealthCoversType":{"type":"string","enum":["LEVEL","MANDATORY_SCHEME_LEVEL"]},"periodicity":{"type":"string","enum":["MONTHLY","QUARTERLY","BIANNUALLY","ANNUALLY"]},"currency":{"type":"string","enum":["EUR"]},"effectiveDate":{"type":"string","format":"date"}}},"NeedResponseWrapper":{"type":"object","properties":{"projectId":{"type":"string"},"need":{"$ref":"#/components/schemas/Need"}}},"Characteristics":{"required":["commissionWishes"],"type":"object","properties":{"commissionWishes":{"type":"string"}}},"CharacteristicsResponseWrapper":{"type":"object","properties":{"projectId":{"type":"string"},"characteristics":{"$ref":"#/components/schemas/Characteristics"}}},"ProjectCreationRequestWrapper":{"required":["effectiveDate","projectType"],"type":"object","properties":{"projectType":{"type":"string"},"effectiveDate":{"type":"string","format":"date"}}},"ProjectCreationResponseWrapper":{"type":"object","properties":{"projectId":{"type":"string"}}},"Address":{"type":"object","properties":{"addressIdentity":{"type":"string"},"addressIdentityRecipient":{"type":"string"},"addressDetail":{"type":"string"},"addressRoad":{"type":"string"},"addressPoBox":{"type":"string"},"addressZipCode":{"type":"string"},"addressTownship":{"type":"string"},"addressCodeIso2Country":{"type":"string"}}},"ContactDetails":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"phoneNumber":{"type":"string"},"email":{"type":"string"}}},"Contributor":{"type":"object","properties":{"contributorId":{"type":"string"},"civilityRefId":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"birthDate":{"type":"string","format":"date"},"roleRefId":{"type":"string"},"mandatorySchemeRefId":{"type":"string"},"maritalStatusRefId":{"type":"string"},"contactDetails":{"$ref":"#/components/schemas/ContactDetails"},"attachmentContributorId":{"type":"string"},"relationshipRefId":{"type":"string"},"professionalStatusRefId":{"type":"string"},"jobRefId":{"type":"string"}}},"DocumentSignature":{"type":"object","properties":{"documentId":{"type":"string"},"documentLabel":{"type":"string"},"documentType":{"type":"string"},"rank":{"type":"integer","format":"int32"}}},"DocumentSignatureUploadRequestWrapper":{"required":["base64"],"type":"object","properties":{"base64":{"type":"string"}}},"DocumentContract":{"type":"object","properties":{"documentId":{"type":"string"},"documentLabel":{"type":"string"},"documentType":{"type":"string"},"rank":{"type":"integer","format":"int32"}}},"Base64DocumentResponseWrapper":{"type":"object","properties":{"base64":{"type":"string"}}},"SubscriptionModesAvailableResponseWrapper":{"type":"object","properties":{"subscriptionModesAvailable":{"type":"array","items":{"type":"string","enum":["PAPER","ELECTRONIC","ELECTRONIC_WITHOUT_PROSPECT_SPACE","THIRD_PART_SIGNATURE"]}}}},"SubscriptionCreationRequestWrapper":{"required":["subscriptionMode"],"type":"object","properties":{"subscriptionMode":{"type":"string","enum":["PAPER","ELECTRONIC","ELECTRONIC_WITHOUT_PROSPECT_SPACE","THIRD_PART_SIGNATURE"]},"callBackUrl":{"type":"string"}}},"SubscriptionCreationResponseWrapper":{"type":"object","properties":{"marketingId":{"type":"string"}}},"Status":{"type":"object","properties":{"projectStatus":{"type":"string"},"contributorsStatus":{"type":"object","additionalProperties":{"type":"string"}}}},"ReimbursementModesAvailableResponseWrapper":{"type":"object","properties":{"reimbursementModesAvailable":{"type":"array","items":{"type":"string","enum":["IBAN","CHECK"]}}}},"PaymentModesAvailableResponseWrapper":{"type":"object","properties":{"paymentModesAvailable":{"type":"array","items":{"type":"string","enum":["IBAN","CHECK","DEBIT_CARD","LYDIA"]}}}},"AccountInformation":{"required":["bankMode"],"type":"object","properties":{"bankMode":{"pattern":"IBAN|CHECK|LYDIA|DEBIT_CARD","type":"string"},"ibanSpecification":{"$ref":"#/components/schemas/IbanSpecification"},"useForPayment":{"type":"boolean"},"useForReimbursement":{"type":"boolean"}}},"AccountsInformationCreationRequestWrapper":{"required":["accountsInformation"],"type":"object","properties":{"accountsInformation":{"type":"array","items":{"$ref":"#/components/schemas/AccountInformation"}}}},"IbanSpecification":{"required":["accountTitularName"],"type":"object","properties":{"accountTitularName":{"type":"string"},"iban":{"pattern":"[a-zA-Z]{2}[0-9]{2}[a-zA-Z0-9]{4}[0-9]{7}([a-zA-Z0-9]?){0,16}","type":"string"}}},"AccountsInformationResponseWrapper":{"type":"object","properties":{"projectId":{"type":"string"},"offerId":{"type":"string"},"accountsInformation":{"type":"array","items":{"$ref":"#/components/schemas/AccountInformation"}}}},"DocumentOffer":{"type":"object","properties":{"documentId":{"type":"string"},"documentLabel":{"type":"string"},"documentType":{"type":"string"},"rank":{"type":"integer","format":"int32"}}},"DocumentQuotation":{"type":"object","properties":{"offerId":{"type":"string"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentOffer"}}}},"QuotationSharingRequestWrapper":{"required":["contactEmail","contactEmailContent"],"type":"object","properties":{"contactEmail":{"pattern":"^[a-zA-Z0-9_!#$%&’*+/=?`{|}~^.-]+@[a-zA-Z0-9.-]+$","type":"string"},"contactEmailContent":{"type":"string"}}},"Act":{"type":"object","properties":{"actId":{"type":"string"},"actLabel":{"type":"string"},"actValue":{"type":"string"},"actUnit":{"type":"string"},"actDescription":{"type":"string"},"representative":{"type":"boolean"},"filterable":{"type":"boolean"}}},"Action":{"type":"object","properties":{"actionId":{"type":"string"},"actionLabel":{"type":"string"}}},"Cover":{"type":"object","properties":{"coverId":{"type":"string"},"coverLabel":{"type":"string"},"coverDescription":{"type":"string"},"subCovers":{"type":"array","items":{"$ref":"#/components/schemas/SubCover"}},"acts":{"type":"array","items":{"$ref":"#/components/schemas/Act"}}}},"Highlight":{"type":"object","properties":{"highlightLabel":{"type":"string"},"highlightDescription":{"type":"string"}}},"Option":{"required":["optionId"],"type":"object","properties":{"optionId":{"type":"string"},"optionLabel":{"type":"string"},"optionLevel":{"type":"string"},"optionDescription":{"type":"string"},"optionPrice":{"type":"number","format":"double"},"periodicity":{"type":"string","enum":["MONTHLY","QUARTERLY","BIANNUALLY","ANNUALLY"]},"optionType":{"type":"string"},"currency":{"type":"string","enum":["EUR"]},"selected":{"type":"boolean"}}},"Promotion":{"required":["promotionId"],"type":"object","properties":{"promotionId":{"type":"string"},"promotionLabel":{"type":"string"},"promotionDescription":{"type":"string"},"promotionReduction":{"type":"number","format":"double"},"periodicity":{"type":"string","enum":["MONTHLY","QUARTERLY","BIANNUALLY","ANNUALLY"]},"currency":{"type":"string","enum":["EUR"]},"selected":{"type":"boolean"}}},"Rate":{"type":"object","properties":{"rank":{"type":"integer","format":"int32"},"marketingProductId":{"type":"string"},"brandId":{"type":"string"},"brandLabel":{"type":"string"},"productLabel":{"type":"string"},"levelCode":{"type":"string"},"levelLabel":{"type":"string"},"designedBy":{"type":"string"},"managedBy":{"type":"string"},"coveredBy":{"type":"string"},"supplierLogoUrl":{"type":"string"},"commission":{"type":"string"},"periodicity":{"type":"string","enum":["MONTHLY","QUARTERLY","BIANNUALLY","ANNUALLY"]},"globalPrice":{"type":"number","format":"double"},"globalPriceWithoutOption":{"type":"number","format":"double"},"currency":{"type":"string","enum":["EUR"]},"warrantiesSummary":{"type":"array","items":{"$ref":"#/components/schemas/Cover"}},"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/Highlight"}},"possibleActions":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"errorMessages":{"type":"array","items":{"type":"string"}}}},"SubCover":{"type":"object","properties":{"subCoverId":{"type":"string"},"subCoverLabel":{"type":"string"},"acts":{"type":"array","items":{"$ref":"#/components/schemas/Act"}}}},"OfferCreationRequestWrapper":{"required":["levelCode","marketingProductId"],"type":"object","properties":{"levelCode":{"type":"string"},"commission":{"type":"string"},"optionsSelected":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"promotionsSelected":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"marketingProductId":{"type":"string"}}},"Offer":{"required":["offerId"],"type":"object","properties":{"offerId":{"type":"string"},"rank":{"type":"integer","format":"int32"},"brandId":{"type":"string"},"brandLabel":{"type":"string"},"productLabel":{"type":"string"},"designedBy":{"type":"string"},"managedBy":{"type":"string"},"coveredBy":{"type":"string"},"supplierLogoUrl":{"type":"string"},"levelCode":{"type":"string"},"levelLabel":{"type":"string"},"commission":{"type":"string"},"periodicity":{"type":"string","enum":["MONTHLY","QUARTERLY","BIANNUALLY","ANNUALLY"]},"globalPrice":{"type":"number","format":"double"},"globalPriceWithoutOption":{"type":"number","format":"double"},"currency":{"type":"string","enum":["EUR"]},"warrantiesSummary":{"type":"array","items":{"$ref":"#/components/schemas/Cover"}},"options":{"type":"array","items":{"$ref":"#/components/schemas/Option"}},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/Promotion"}},"highlights":{"type":"array","items":{"$ref":"#/components/schemas/Highlight"}},"possibleActions":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"errorMessages":{"type":"array","items":{"type":"string"}},"marketingProductId":{"type":"string"}}},"QuotationCreationRequestWrapper":{"type":"object","properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"}}}},"QuotationCreationResponseWrapper":{"type":"object","properties":{"quotationId":{"type":"string"}}},"GenericReference":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"object"}}},"CountryReference":{"type":"object","properties":{"countryCodeIso2":{"type":"string"},"countryLabel":{"type":"object"},"countryNationalityCode":{"type":"string"},"countryNationalityLabel":{"type":"string"}}},"Commission":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"CommissionsAvailable":{"type":"object","properties":{"marketingProductId":{"type":"string"},"availableCommissions":{"type":"array","items":{"$ref":"#/components/schemas/Commission"}}}},"CoverageSummaryRequestWrapper":{"type":"object","properties":{"level":{"type":"string"},"option":{"type":"string"},"optionLevel":{"type":"string"}}},"CoverageSummaryResponseWrapper":{"type":"object","properties":{"productCode":{"type":"string"},"level":{"type":"string"},"option":{"type":"string"},"optionLevel":{"type":"string"},"warrantiesSummary":{"type":"array","items":{"$ref":"#/components/schemas/Cover"}}}},"Brand":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"logo":{"type":"string"}}},"Level":{"type":"object","properties":{"code":{"type":"string"},"label":{"type":"string"},"availableOptions":{"type":"array","items":{"$ref":"#/components/schemas/Option"}}}},"Product":{"type":"object","properties":{"marketingProductId":{"type":"string"},"label":{"type":"string"},"availableLevels":{"type":"array","items":{"$ref":"#/components/schemas/Level"}},"brand":{"$ref":"#/components/schemas/Brand"},"designedBy":{"type":"string"},"managedBy":{"type":"string"},"coveredBy":{"type":"string"}}},"HealthGenericReference":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"object"},"description":{"type":"object"}}}}}}