{ "openapi": "3.0.0", "info": { "title": "Qualibox API", "description": "API REST pour int\u00e9grer Qualibox avec des CRM et applications externes.\n\n## Authentification\n\nToutes les requ\u00eates n\u00e9cessitent une cl\u00e9 API via le header `X-Api-Key`.\n\nObtenez votre cl\u00e9 API dans votre espace Qualibox : **R\u00e9glages \u2192 API**.\n\n## Scopes\n\n- **Cl\u00e9 r\u00e9seau** : acc\u00e8s \u00e0 toutes les entreprises du r\u00e9seau\n- **Cl\u00e9 entreprise** : acc\u00e8s uniquement \u00e0 votre entreprise\n\n## Rate Limiting\n\n100 requ\u00eates par minute maximum.\n", "contact": { "name": "Support Qualibox", "email": "support@quali-box.fr" }, "version": "1.0.0" }, "paths": { "/api/platform/cities": { "get": { "tags": [ "City" ], "summary": "Retrieves the collection of City resources.", "description": "Retrieves the collection of City resources.", "operationId": "api_cities_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "City collection", "content": { "application/ld+json": { "schema": { "description": "City.jsonld-city.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/City.jsonld-city.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/City-city.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/cities/{id}": { "get": { "tags": [ "City" ], "summary": "Retrieves a City resource.", "description": "Retrieves a City resource.", "operationId": "api_cities_id_get", "parameters": [ { "name": "id", "in": "path", "description": "City identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "City resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/City.jsonld-city.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/City-city.list" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/companies": { "get": { "tags": [ "Company" ], "summary": "Retrieves the collection of Company resources.", "description": "Retrieves the collection of Company resources.", "operationId": "api_companies_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "city", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "slug", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "slug[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "externalCrmId", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "externalCrmId[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Company collection", "content": { "application/ld+json": { "schema": { "description": "Company.jsonld-company.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Company.jsonld-company.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company-company.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Company" ], "summary": "Creates a Company resource.", "description": "Creates a Company resource.", "operationId": "api_companies_post", "requestBody": { "description": "The new Company resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Company-company.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company-company.write" } } } }, "responses": { "201": { "description": "Company resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Company.jsonld-company.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company-company.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/companies/{id}": { "get": { "tags": [ "Company" ], "summary": "Retrieves a Company resource.", "description": "Retrieves a Company resource.", "operationId": "api_companies_id_get", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Company resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Company.jsonld-company.read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company-company.read" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Company" ], "summary": "Replaces the Company resource.", "description": "Replaces the Company resource.", "operationId": "api_companies_id_put", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated Company resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Company-company.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company-company.write" } } } }, "responses": { "200": { "description": "Company resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Company.jsonld-company.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company-company.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Platform API" ], "operationId": "delete_app_modules_platform_api_platform_platformapi_deactivatecompany", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Company" ], "summary": "Updates the Company resource.", "description": "Updates the Company resource.", "operationId": "api_companies_id_patch", "parameters": [ { "name": "id", "in": "path", "description": "Company identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated Company resource", "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/Company-company.update.jsonMergePatch" } } } }, "responses": { "200": { "description": "Company resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Company.jsonld-company.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Company-company.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/contact_requests": { "get": { "tags": [ "ContactRequest" ], "summary": "Retrieves the collection of ContactRequest resources.", "description": "Retrieves the collection of ContactRequest resources.", "operationId": "api_contact_requests_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "ContactRequest collection", "content": { "application/ld+json": { "schema": { "description": "ContactRequest.jsonld-contact.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRequest.jsonld-contact.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRequest-contact.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ContactRequest" ], "summary": "Creates a ContactRequest resource.", "description": "Creates a ContactRequest resource.", "operationId": "api_contact_requests_post", "requestBody": { "description": "The new ContactRequest resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ContactRequest-contact.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest-contact.write" } } } }, "responses": { "201": { "description": "ContactRequest resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ContactRequest.jsonld-contact.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ContactRequest-contact.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/demande_devis": { "get": { "tags": [ "DemandeDevis" ], "summary": "Retrieves the collection of DemandeDevis resources.", "description": "Retrieves the collection of DemandeDevis resources.", "operationId": "api_demande_devis_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "status", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "status[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "DemandeDevis collection", "content": { "application/ld+json": { "schema": { "description": "DemandeDevis.jsonld-devis.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/DemandeDevis.jsonld-devis.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DemandeDevis-devis.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "DemandeDevis" ], "summary": "Creates a DemandeDevis resource.", "description": "Creates a DemandeDevis resource.", "operationId": "api_demande_devis_post", "requestBody": { "description": "The new DemandeDevis resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/DemandeDevis-devis.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DemandeDevis-devis.write" } } } }, "responses": { "201": { "description": "DemandeDevis resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/DemandeDevis.jsonld-devis.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DemandeDevis-devis.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/demande_devis/{id}": { "get": { "tags": [ "DemandeDevis" ], "summary": "Retrieves a DemandeDevis resource.", "description": "Retrieves a DemandeDevis resource.", "operationId": "api_demande_devis_id_get", "parameters": [ { "name": "id", "in": "path", "description": "DemandeDevis identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DemandeDevis resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/DemandeDevis.jsonld-devis.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DemandeDevis-devis.list" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "tags": [ "DemandeDevis" ], "summary": "Updates the DemandeDevis resource.", "description": "Updates the DemandeDevis resource.", "operationId": "api_demande_devis_id_patch", "parameters": [ { "name": "id", "in": "path", "description": "DemandeDevis identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated DemandeDevis resource", "required": true, "content": { "application/merge-patch+json": { "schema": { "$ref": "#/components/schemas/DemandeDevis-devis.write.jsonMergePatch" } } } }, "responses": { "200": { "description": "DemandeDevis resource updated", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/DemandeDevis.jsonld-devis.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DemandeDevis-devis.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/auth/login": { "post": { "tags": [ "Login Check" ], "summary": "Creates a user token.", "description": "Creates a user token.", "operationId": "login_check_post", "requestBody": { "description": "The login data", "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "type": "string", "nullable": false }, "password": { "type": "string", "nullable": false } }, "type": "object" } } } }, "responses": { "200": { "description": "User token created", "content": { "application/json": { "schema": { "required": [ "token" ], "properties": { "token": { "type": "string", "readOnly": true, "nullable": false } }, "type": "object" } } } } } } }, "/api/platform/networks": { "get": { "tags": [ "Network" ], "summary": "Retrieves the collection of Network resources.", "description": "Retrieves the collection of Network resources.", "operationId": "api_networks_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Network collection", "content": { "application/ld+json": { "schema": { "description": "Network.jsonld-network.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Network.jsonld-network.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Network-network.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_createnetwork", "responses": { "default": { "description": "" } } } }, "/api/platform/networks/{id}": { "get": { "tags": [ "Network" ], "summary": "Retrieves a Network resource.", "description": "Retrieves a Network resource.", "operationId": "api_networks_id_get", "parameters": [ { "name": "id", "in": "path", "description": "Network identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Network resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Network.jsonld-network.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Network-network.list" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Platform API" ], "operationId": "put_app_modules_platform_api_platform_platformapi_updatenetwork", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Platform API" ], "operationId": "delete_app_modules_platform_api_platform_platformapi_deactivatenetwork", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/reviews": { "get": { "tags": [ "Review" ], "summary": "Retrieves the collection of Review resources.", "description": "Retrieves the collection of Review resources.", "operationId": "api_reviews_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "status", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "status[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "company", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "company[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "createdAt[before]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "createdAt[strictly_before]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "createdAt[after]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "createdAt[strictly_after]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "globalRating[between]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "globalRating[gt]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "globalRating[gte]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "globalRating[lt]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "globalRating[lte]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Review collection", "content": { "application/ld+json": { "schema": { "description": "Review.jsonld-review.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Review.jsonld-review.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Review-review.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Review" ], "summary": "Creates a Review resource.", "description": "Creates a Review resource.", "operationId": "api_reviews_post", "requestBody": { "description": "The new Review resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Review-review.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Review-review.write" } } } }, "responses": { "201": { "description": "Review resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Review.jsonld-review.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Review-review.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/reviews/{id}": { "get": { "tags": [ "Review" ], "summary": "Retrieves a Review resource.", "description": "Retrieves a Review resource.", "operationId": "api_reviews_id_get", "parameters": [ { "name": "id", "in": "path", "description": "Review identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Review resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Review.jsonld-review.read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Review-review.read" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "tags": [ "Review" ], "summary": "Removes the Review resource.", "description": "Removes the Review resource.", "operationId": "api_reviews_id_delete", "parameters": [ { "name": "id", "in": "path", "description": "Review identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Review resource deleted" }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/review_criterias": { "get": { "tags": [ "ReviewCriteria" ], "summary": "Retrieves the collection of ReviewCriteria resources.", "description": "Retrieves the collection of ReviewCriteria resources.", "operationId": "api_review_criterias_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "ReviewCriteria collection", "content": { "application/ld+json": { "schema": { "description": "ReviewCriteria.jsonld-criteria.read collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewCriteria.jsonld-criteria.read" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewCriteria-criteria.read" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/review_criterias/{id}": { "get": { "tags": [ "ReviewCriteria" ], "summary": "Retrieves a ReviewCriteria resource.", "description": "Retrieves a ReviewCriteria resource.", "operationId": "api_review_criterias_id_get", "parameters": [ { "name": "id", "in": "path", "description": "ReviewCriteria identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ReviewCriteria resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ReviewCriteria.jsonld-criteria.read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReviewCriteria-criteria.read" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/review_invitations": { "get": { "tags": [ "ReviewInvitation" ], "summary": "Retrieves the collection of ReviewInvitation resources.", "description": "Retrieves the collection of ReviewInvitation resources.", "operationId": "api_review_invitations_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "ReviewInvitation collection", "content": { "application/ld+json": { "schema": { "description": "ReviewInvitation.jsonld-invitation.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewInvitation.jsonld-invitation.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewInvitation-invitation.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "ReviewInvitation" ], "summary": "Creates a ReviewInvitation resource.", "description": "Creates a ReviewInvitation resource.", "operationId": "api_review_invitations_post", "requestBody": { "description": "The new ReviewInvitation resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ReviewInvitation-invitation.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReviewInvitation-invitation.write" } } } }, "responses": { "201": { "description": "ReviewInvitation resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ReviewInvitation.jsonld-invitation.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ReviewInvitation-invitation.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/sectors": { "get": { "tags": [ "Sector" ], "summary": "Retrieves the collection of Sector resources.", "description": "Retrieves the collection of Sector resources.", "operationId": "api_sectors_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "Sector collection", "content": { "application/ld+json": { "schema": { "description": "Sector.jsonld-sector.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Sector.jsonld-sector.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Sector-sector.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/sectors/{id}": { "get": { "tags": [ "Sector" ], "summary": "Retrieves a Sector resource.", "description": "Retrieves a Sector resource.", "operationId": "api_sectors_id_get", "parameters": [ { "name": "id", "in": "path", "description": "Sector identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Sector resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Sector.jsonld-sector.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Sector-sector.list" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/surveys": { "get": { "tags": [ "Survey" ], "summary": "Retrieves the collection of Survey resources.", "description": "Retrieves the collection of Survey resources.", "operationId": "api_surveys_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "externalId", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "externalId[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "externalSource", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "externalSource[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "sourceType", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "sourceType[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Survey collection", "content": { "application/ld+json": { "schema": { "description": "Survey.jsonld-survey.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/Survey.jsonld-survey.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Survey-survey.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "Survey" ], "summary": "Creates a Survey resource.", "description": "Creates a Survey resource.", "operationId": "api_surveys_post", "requestBody": { "description": "The new Survey resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Survey-survey.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Survey-survey.write" } } } }, "responses": { "201": { "description": "Survey resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Survey.jsonld-survey.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Survey-survey.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/surveys/{id}": { "get": { "tags": [ "Survey" ], "summary": "Retrieves a Survey resource.", "description": "Retrieves a Survey resource.", "operationId": "api_surveys_id_get", "parameters": [ { "name": "id", "in": "path", "description": "Survey identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Survey resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Survey.jsonld-survey.read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Survey-survey.read" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "tags": [ "Platform API" ], "operationId": "put_app_modules_platform_api_platform_platformapi_updatesurvey", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/survey_invitations": { "get": { "tags": [ "SurveyInvitation" ], "summary": "Retrieves the collection of SurveyInvitation resources.", "description": "Retrieves the collection of SurveyInvitation resources.", "operationId": "api_survey_invitations_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } }, { "name": "externalId", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "externalId[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "externalSource", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "externalSource[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "survey", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "survey[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "company", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "company[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "status", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "status[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "token", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": false, "schema": { "type": "string" } }, { "name": "token[]", "in": "query", "description": "", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "SurveyInvitation collection", "content": { "application/ld+json": { "schema": { "description": "SurveyInvitation.jsonld-survey-invitation.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyInvitation.jsonld-survey-invitation.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyInvitation-survey-invitation.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "tags": [ "SurveyInvitation" ], "summary": "Creates a SurveyInvitation resource.", "description": "Creates a SurveyInvitation resource.", "operationId": "api_survey_invitations_post", "requestBody": { "description": "The new SurveyInvitation resource", "required": true, "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/SurveyInvitation-survey-invitation.write" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SurveyInvitation-survey-invitation.write" } } } }, "responses": { "201": { "description": "SurveyInvitation resource created", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/SurveyInvitation.jsonld-survey-invitation.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SurveyInvitation-survey-invitation.list" } } } }, "400": { "description": "Invalid input", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "An error occurred", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ConstraintViolation" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/survey_invitations/{id}": { "get": { "tags": [ "SurveyInvitation" ], "summary": "Retrieves a SurveyInvitation resource.", "description": "Retrieves a SurveyInvitation resource.", "operationId": "api_survey_invitations_id_get", "parameters": [ { "name": "id", "in": "path", "description": "SurveyInvitation identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyInvitation resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/SurveyInvitation.jsonld-survey-invitation.read" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SurveyInvitation-survey-invitation.read" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/survey_responses": { "get": { "tags": [ "SurveyResponse" ], "summary": "Retrieves the collection of SurveyResponse resources.", "description": "Retrieves the collection of SurveyResponse resources.", "operationId": "api_survey_responses_get_collection", "parameters": [ { "name": "page", "in": "query", "description": "The collection page number", "required": false, "deprecated": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 1 } } ], "responses": { "200": { "description": "SurveyResponse collection", "content": { "application/ld+json": { "schema": { "description": "SurveyResponse.jsonld-survey-response.list collection.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchema" }, { "required": [ "member" ], "properties": { "member": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResponse.jsonld-survey-response.list" } } }, "type": "object" } ] } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResponse-survey-response.list" } } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/survey_responses/{id}": { "get": { "tags": [ "SurveyResponse" ], "summary": "Retrieves a SurveyResponse resource.", "description": "Retrieves a SurveyResponse resource.", "operationId": "api_survey_responses_id_get", "parameters": [ { "name": "id", "in": "path", "description": "SurveyResponse identifier", "required": true, "deprecated": false, "style": "simple", "explode": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyResponse resource", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/SurveyResponse.jsonld-survey-response.list" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResponse-survey-response.list" } } } }, "403": { "description": "Forbidden", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/ld+json": { "schema": { "$ref": "#/components/schemas/Error.jsonld" } }, "application/problem+json": { "schema": { "$ref": "#/components/schemas/Error" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/platform/invoices": { "get": { "tags": [ "Invoices" ], "summary": "Lister les factures", "description": "Retourne les factures des entreprises du p\u00e9rim\u00e8tre.", "operationId": "get_app_modules_platform_api_platform_platformapi_listinvoices", "parameters": [ { "name": "companyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "draft", "sent", "paid", "overdue", "cancelled" ] } } ], "responses": { "200": { "description": "Liste des factures" } } }, "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_createinvoice", "responses": { "default": { "description": "" } } } }, "/api/platform/invoices/{id}": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_showinvoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/service-orders/{id}": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_showserviceorder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/entreprises": { "get": { "tags": [ "Compat Devibox" ], "summary": "Lister les entreprises (format Hydra)", "description": "Liste les entreprises du r\u00e9seau au format Hydra/JSON-LD pour compatibilit\u00e9 Devibox.", "operationId": "get_app_modules_platform_api_compat_deviboxcompat_listentreprises", "parameters": [ { "name": "devibox_id", "in": "query", "description": "Filtrer par ID Devibox", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Collection Hydra" } } }, "post": { "tags": [ "Compat Devibox" ], "summary": "Cr\u00e9er une entreprise (format Hydra)", "description": "Cr\u00e9e une nouvelle entreprise au format Hydra. Le SIRET est obligatoire.", "operationId": "post_app_modules_platform_api_compat_deviboxcompat_createentreprise", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "nom", "siret" ], "properties": { "nom": { "description": "Nom de l'entreprise", "type": "string" }, "nomQualibox": { "description": "Nom commercial", "type": "string" }, "siret": { "description": "SIRET ou num\u00e9ro d'immatriculation (obligatoire)", "type": "string" }, "devibox_id": { "description": "ID Devibox externe", "type": "string" }, "adresse": { "type": "string" }, "codePostal": { "type": "string" }, "ville": { "type": "string" }, "pays": { "description": "Pays (france, belgique, suisse, etc.)", "type": "string" }, "email": { "type": "string", "format": "email" }, "telephone": { "type": "string" }, "website": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Entreprise cr\u00e9\u00e9e" }, "200": { "description": "Entreprise mise \u00e0 jour (si devibox_id existant)" }, "400": { "description": "SIRET manquant" }, "409": { "description": "SIRET d\u00e9j\u00e0 utilis\u00e9" }, "422": { "description": "SIRET invalide" } } } }, "/api/pro": { "get": { "tags": [ "Compat Devibox" ], "summary": "Lister les entreprises (format Hydra)", "description": "Liste les entreprises du r\u00e9seau au format Hydra/JSON-LD pour compatibilit\u00e9 Devibox.", "operationId": "get_app_modules_platform_api_compat_deviboxcompat_listentreprises_1", "parameters": [ { "name": "devibox_id", "in": "query", "description": "Filtrer par ID Devibox", "schema": { "type": "string" } }, { "name": "slug", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "schema": { "type": "integer", "default": 30 } } ], "responses": { "200": { "description": "Collection Hydra" } } }, "post": { "tags": [ "Compat Devibox" ], "summary": "Cr\u00e9er une entreprise (format Hydra)", "description": "Cr\u00e9e une nouvelle entreprise au format Hydra. Le SIRET est obligatoire.", "operationId": "post_app_modules_platform_api_compat_deviboxcompat_createentreprise_1", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "nom", "siret" ], "properties": { "nom": { "description": "Nom de l'entreprise", "type": "string" }, "nomQualibox": { "description": "Nom commercial", "type": "string" }, "siret": { "description": "SIRET ou num\u00e9ro d'immatriculation (obligatoire)", "type": "string" }, "devibox_id": { "description": "ID Devibox externe", "type": "string" }, "adresse": { "type": "string" }, "codePostal": { "type": "string" }, "ville": { "type": "string" }, "pays": { "description": "Pays (france, belgique, suisse, etc.)", "type": "string" }, "email": { "type": "string", "format": "email" }, "telephone": { "type": "string" }, "website": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Entreprise cr\u00e9\u00e9e" }, "200": { "description": "Entreprise mise \u00e0 jour (si devibox_id existant)" }, "400": { "description": "SIRET manquant" }, "409": { "description": "SIRET d\u00e9j\u00e0 utilis\u00e9" }, "422": { "description": "SIRET invalide" } } } }, "/api/entreprises/{id}": { "get": { "tags": [ "Compat Devibox" ], "operationId": "get_app_modules_platform_api_compat_deviboxcompat_getentreprise", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Compat Devibox" ], "operationId": "put_app_modules_platform_api_compat_deviboxcompat_updateentreprise", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Compat Devibox" ], "operationId": "delete_app_modules_platform_api_compat_deviboxcompat_deleteentreprise", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Compat Devibox" ], "operationId": "patch_app_modules_platform_api_compat_deviboxcompat_updateentreprise", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } } }, "/api/pro/{id}": { "get": { "tags": [ "Compat Devibox" ], "operationId": "get_app_modules_platform_api_compat_deviboxcompat_getentreprise_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "put": { "tags": [ "Compat Devibox" ], "operationId": "put_app_modules_platform_api_compat_deviboxcompat_updateentreprise_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "delete": { "tags": [ "Compat Devibox" ], "operationId": "delete_app_modules_platform_api_compat_deviboxcompat_deleteentreprise_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } }, "patch": { "tags": [ "Compat Devibox" ], "operationId": "patch_app_modules_platform_api_compat_deviboxcompat_updateentreprise_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": ".+" } } ], "responses": { "default": { "description": "" } } } }, "/api/avis": { "get": { "tags": [ "Compat Devibox" ], "summary": "Lister les avis (format Hydra)", "description": "Liste les avis clients du r\u00e9seau au format Hydra.", "operationId": "get_app_modules_platform_api_compat_deviboxcompat_listavis", "parameters": [ { "name": "company_id", "in": "query", "description": "ID entreprise (UUID ou Devibox ID)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Collection Hydra" } } }, "post": { "tags": [ "Compat Devibox" ], "operationId": "post_app_modules_platform_api_compat_deviboxcompat_createavis", "responses": { "default": { "description": "" } } } }, "/api/avis/{id}": { "delete": { "tags": [ "Compat Devibox" ], "operationId": "delete_app_modules_platform_api_compat_deviboxcompat_deleteavis", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/surveys": { "get": { "operationId": "get_api_compat_surveys_list", "responses": { "default": { "description": "" } } }, "post": { "operationId": "post_api_compat_surveys_upsert", "responses": { "default": { "description": "" } } } }, "/api/surveys/by-external/{externalId}": { "get": { "operationId": "get_api_compat_surveys_by_external", "parameters": [ { "name": "externalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/surveys/{surveyId}/invitations/external-ids": { "get": { "summary": "Liste les externalId des invitations d'une enqu\u00eate (pour migration/sync).", "description": "Retourne les IDs et dates d'envoi pour recr\u00e9er les flags locaux avec les bonnes dates.", "operationId": "get_api_compat_survey_invitation_external_ids", "parameters": [ { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/surveys/{surveyId}/invitations": { "post": { "operationId": "post_api_compat_survey_invitation_create", "parameters": [ { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/surveys/{surveyId}/responses": { "post": { "operationId": "post_api_compat_survey_response_create", "parameters": [ { "name": "surveyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/companies/me": { "get": { "tags": [ "Company Me" ], "summary": "R\u00e9cup\u00e9rer mon entreprise", "description": "Retourne les informations de l'entreprise li\u00e9e \u00e0 la cl\u00e9 API. Disponible uniquement pour les cl\u00e9s de scope entreprise.", "operationId": "get_app_modules_platform_api_platform_companyme_show", "responses": { "200": { "description": "D\u00e9tails de l'entreprise" }, "403": { "description": "API Key requise" }, "404": { "description": "Disponible uniquement pour les cl\u00e9s entreprise" } } }, "put": { "tags": [ "Company Me" ], "summary": "Modifier mon entreprise", "description": "Met \u00e0 jour les informations de l'entreprise li\u00e9e \u00e0 la cl\u00e9 API.", "operationId": "put_app_modules_platform_api_platform_companyme_update", "requestBody": { "content": { "application/json": { "schema": { "properties": { "name": { "type": "string" }, "siret": { "type": "string" }, "address": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email" }, "website": { "type": "string" }, "description": { "type": "string" }, "services": { "type": "array", "items": { "type": "string" } }, "socialLinks": { "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Entreprise modifi\u00e9e" } } } }, "/api/platform/users": { "get": { "tags": [ "Users" ], "summary": "Lister les utilisateurs", "description": "Retourne les utilisateurs filtr\u00e9s par email ou entreprise.", "operationId": "get_app_modules_platform_api_platform_platformapi_listusers", "parameters": [ { "name": "email", "in": "query", "description": "Filtre exact par email", "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "description": "Filtre par UUID d'entreprise", "schema": { "type": "string", "format": "uuid" } }, { "name": "companyDeviboxId", "in": "query", "description": "Filtre par ID Devibox de l'entreprise", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Liste des utilisateurs", "content": { "application/json": { "schema": { "properties": { "totalItems": { "type": "integer" }, "member": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } } } }, "post": { "tags": [ "Users" ], "summary": "Cr\u00e9er un utilisateur", "description": "Cr\u00e9e un nouvel utilisateur rattach\u00e9 \u00e0 une entreprise du p\u00e9rim\u00e8tre.", "operationId": "post_app_modules_platform_api_platform_platformapi_createuser", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "firstName", "lastName", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "password": { "type": "string" }, "companyId": { "description": "UUID de l'entreprise", "type": "string", "format": "uuid" }, "phone": { "type": "string" }, "jobTitle": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Utilisateur cr\u00e9\u00e9" }, "400": { "description": "Donn\u00e9es invalides" }, "403": { "description": "API Key requise" } } } }, "/api/platform/users/{id}": { "put": { "tags": [ "Users" ], "summary": "Modifier un utilisateur", "description": "Met \u00e0 jour les informations d'un utilisateur existant.", "operationId": "put_app_modules_platform_api_platform_platformapi_updateuser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Utilisateur modifi\u00e9" }, "404": { "description": "Utilisateur non trouv\u00e9" } } }, "delete": { "tags": [ "Users" ], "summary": "D\u00e9sactiver un utilisateur", "description": "D\u00e9sactive un utilisateur (soft delete).", "operationId": "delete_app_modules_platform_api_platform_platformapi_deactivateuser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Utilisateur d\u00e9sactiv\u00e9" }, "404": { "description": "Utilisateur non trouv\u00e9" } } } }, "/api/platform/companies/{id}/assign-network": { "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_assignnetwork", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/companies/{id}/remove-network": { "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_removefromnetwork", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/companies/upsert": { "post": { "tags": [ "Companies" ], "summary": "Cr\u00e9er ou mettre \u00e0 jour une entreprise", "description": "Endpoint idempotent pour synchroniser une entreprise depuis un CRM externe. Utilise externalCrmId ou SIRET pour le rapprochement. Le SIRET est obligatoire en cr\u00e9ation.", "operationId": "post_app_modules_platform_api_platform_platformapi_createcompany", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "siret" ], "properties": { "name": { "description": "Raison sociale", "type": "string" }, "displayName": { "description": "Nom commercial", "type": "string" }, "externalCrmId": { "description": "ID dans le CRM externe", "type": "string" }, "externalCrmType": { "description": "Type de CRM (devibox, etc.)", "type": "string" }, "siret": { "description": "SIRET ou num\u00e9ro d'immatriculation (obligatoire en cr\u00e9ation)", "type": "string" }, "slug": { "type": "string" }, "address": { "type": "string" }, "postalCode": { "type": "string" }, "city": { "type": "string" }, "countryCode": { "description": "Code pays ISO (FR, BE, etc.)", "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string", "format": "email" }, "website": { "type": "string" }, "description": { "type": "string" }, "logoUrl": { "description": "URL du logo \u00e0 t\u00e9l\u00e9charger", "type": "string" }, "latitude": { "type": "number", "format": "float" }, "longitude": { "type": "number", "format": "float" }, "isActive": { "type": "boolean" }, "is_network_head": { "description": "Cr\u00e9er comme t\u00eate de r\u00e9seau (admin uniquement)", "type": "boolean" }, "owner_email": { "description": "Email du propri\u00e9taire \u00e0 cr\u00e9er", "type": "string" }, "owner_first_name": { "type": "string" }, "owner_last_name": { "type": "string" } }, "type": "object" } } } }, "responses": { "201": { "description": "Entreprise cr\u00e9\u00e9e", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": "string" }, "api_key": { "description": "Cl\u00e9 API (si t\u00eate de r\u00e9seau cr\u00e9\u00e9e)", "type": "string" } }, "type": "object" } } } }, "200": { "description": "Entreprise mise \u00e0 jour" }, "400": { "description": "SIRET manquant en cr\u00e9ation" }, "409": { "description": "Conflit (SIRET d\u00e9j\u00e0 utilis\u00e9 par un autre CRM)" }, "422": { "description": "SIRET invalide" } } } }, "/api/platform/plans": { "get": { "tags": [ "Subscriptions" ], "summary": "Lister les plans d'abonnement", "description": "Retourne la liste des plans d'abonnement actifs.", "operationId": "get_app_modules_platform_api_platform_platformapi_listplans", "responses": { "200": { "description": "Liste des plans" } } } }, "/api/platform/subscriptions": { "get": { "tags": [ "Subscriptions" ], "summary": "Lister les abonnements", "description": "Retourne les abonnements des entreprises du p\u00e9rim\u00e8tre.", "operationId": "get_app_modules_platform_api_platform_platformapi_listsubscriptions", "parameters": [ { "name": "companyId", "in": "query", "description": "Filtrer par entreprise", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Liste des abonnements" } } }, "post": { "tags": [ "Subscriptions" ], "summary": "Cr\u00e9er un abonnement", "description": "Active un abonnement pour une entreprise.", "operationId": "post_app_modules_platform_api_platform_platformapi_createsubscription", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "planSlug" ], "properties": { "planSlug": { "description": "Slug du plan", "type": "string" }, "companyId": { "type": "string", "format": "uuid" }, "billingPeriod": { "type": "string", "enum": [ "monthly", "yearly" ] } }, "type": "object" } } } }, "responses": { "201": { "description": "Abonnement cr\u00e9\u00e9" } } } }, "/api/platform/subscriptions/{id}": { "delete": { "tags": [ "Platform API" ], "operationId": "delete_app_modules_platform_api_platform_platformapi_cancelsubscription", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/subscriptions/gift": { "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_giftsubscription", "responses": { "default": { "description": "" } } } }, "/api/platform/join-requests": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_listjoinrequests", "responses": { "default": { "description": "" } } }, "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_createjoinrequest", "responses": { "default": { "description": "" } } } }, "/api/platform/commissions": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_listcommissions", "responses": { "default": { "description": "" } } } }, "/api/platform/invoices/{id}/pdf": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_invoicepdf", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/services-catalog": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_listservices", "responses": { "default": { "description": "" } } } }, "/api/platform/services-catalog/{serviceId}/buy": { "post": { "tags": [ "Platform API" ], "operationId": "post_app_modules_platform_api_platform_platformapi_buyservice", "parameters": [ { "name": "serviceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "default": { "description": "" } } } }, "/api/platform/service-orders": { "get": { "tags": [ "Platform API" ], "operationId": "get_app_modules_platform_api_platform_platformapi_listserviceorders", "responses": { "default": { "description": "" } } } }, "/api/platform/users/upsert": { "post": { "tags": [ "Users" ], "summary": "Cr\u00e9er ou mettre \u00e0 jour un utilisateur", "description": "Endpoint idempotent pour synchroniser un utilisateur depuis un CRM externe. Utilis\u00e9 notamment pour l'auto-login.", "operationId": "post_app_modules_platform_api_platform_platformapi_upsertuser", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "firstName", "lastName" ], "properties": { "email": { "description": "Email de l'utilisateur", "type": "string", "format": "email" }, "firstName": { "description": "Pr\u00e9nom", "type": "string" }, "lastName": { "description": "Nom", "type": "string" }, "phone": { "description": "T\u00e9l\u00e9phone", "type": "string" }, "companyDeviboxId": { "description": "ID Devibox de l'entreprise \u00e0 rattacher", "type": "integer" } }, "type": "object" } } } }, "responses": { "201": { "description": "Utilisateur cr\u00e9\u00e9", "content": { "application/json": { "schema": { "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyId": { "type": "string", "format": "uuid", "nullable": true }, "created": { "type": "boolean" } }, "type": "object" } } } }, "200": { "description": "Utilisateur mis \u00e0 jour" }, "409": { "description": "Email d\u00e9j\u00e0 utilis\u00e9 par une autre entreprise" } } } }, "/api/platform/auth/login-url": { "post": { "tags": [ "Authentication" ], "summary": "G\u00e9n\u00e9rer une URL d'auto-login", "description": "G\u00e9n\u00e8re une URL permettant de connecter automatiquement un utilisateur. L'URL contient un token temporaire.", "operationId": "post_app_modules_platform_api_platform_platformauth_generateloginurl", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "userEmail" ], "properties": { "userEmail": { "description": "Email de l'utilisateur \u00e0 connecter", "type": "string", "format": "email" }, "redirect": { "description": "Chemin de redirection apr\u00e8s login (d\u00e9faut: /espace)", "type": "string" }, "surveyId": { "description": "UUID de l'enqu\u00eate pour construire le redirect", "type": "string", "format": "uuid" }, "action": { "description": "Action sp\u00e9cifique", "type": "string", "enum": [ "dashboard", "edit", "respondants", "alertes", "send" ] }, "locale": { "description": "Locale pour l'URL (d\u00e9faut: fr)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "URL g\u00e9n\u00e9r\u00e9e", "content": { "application/json": { "schema": { "properties": { "url": { "description": "URL d'auto-login compl\u00e8te", "type": "string" } }, "type": "object" } } } }, "403": { "description": "API Key requise ou utilisateur hors p\u00e9rim\u00e8tre" }, "404": { "description": "Utilisateur non trouv\u00e9" } } } }, "/api/platform/auth/survey-login-url": { "post": { "tags": [ "Authentication" ], "summary": "G\u00e9n\u00e9rer une URL d'auto-login vers une enqu\u00eate", "description": "G\u00e9n\u00e8re une URL d'auto-login redirigeant vers une enqu\u00eate sp\u00e9cifique. Cr\u00e9e l'utilisateur automatiquement si inexistant.", "operationId": "post_app_modules_platform_api_platform_platformauth_generatesurveyloginurl", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "userEmail" ], "properties": { "userEmail": { "description": "Email de l'utilisateur \u00e0 connecter", "type": "string", "format": "email" }, "surveyId": { "description": "UUID Qualibox de l'enqu\u00eate (prioritaire)", "type": "string", "format": "uuid" }, "externalId": { "description": "ID externe de l'enqu\u00eate (fallback legacy)", "type": "string" }, "externalSource": { "description": "Source externe (d\u00e9faut: devibox)", "type": "string" }, "action": { "type": "string", "enum": [ "dashboard", "edit", "questions", "respondants", "non-respondants", "alertes", "send" ] }, "locale": { "description": "Locale (d\u00e9faut: fr)", "type": "string" }, "firstName": { "description": "Pr\u00e9nom (requis si cr\u00e9ation utilisateur)", "type": "string" }, "lastName": { "description": "Nom (requis si cr\u00e9ation utilisateur)", "type": "string" }, "companyDeviboxId": { "description": "ID Devibox de l'entreprise", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "URL g\u00e9n\u00e9r\u00e9e", "content": { "application/json": { "schema": { "properties": { "url": { "type": "string" }, "surveyId": { "type": "string", "format": "uuid" }, "surveyTitle": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Donn\u00e9es invalides (surveyId ou externalId requis)" }, "404": { "description": "Enqu\u00eate non trouv\u00e9e" } } } } }, "components": { "schemas": { "City-city.list": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" }, "postalCode": { "type": "string", "nullable": true }, "population": { "type": "integer", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "default": "FR" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "City.jsonld-city.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" }, "postalCode": { "type": "string", "nullable": true }, "population": { "type": "integer", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "default": "FR" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "Company-company.list": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "sector": { "anyOf": [ { "$ref": "#/components/schemas/Sector-company.list" }, { "type": "null" } ] }, "shortDescription": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "externalCrmId": { "type": "string", "nullable": true }, "externalCrmType": { "type": "string", "nullable": true }, "averageRating": { "type": "number", "nullable": true }, "reviewCount": { "type": "integer", "default": 0 }, "publicName": { "type": "string", "readOnly": true } }, "type": "object" }, "Company-company.read": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "language": { "type": "string", "default": "fr" }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "siret": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "sector": { "anyOf": [ { "$ref": "#/components/schemas/Sector-company.read" }, { "type": "null" } ] }, "metiers": { "type": "array", "items": { "$ref": "#/components/schemas/Metier-company.read" } }, "description": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "coverImage": { "type": "string", "nullable": true }, "galleryImages": { "type": "array", "items": { "type": "string", "nullable": true } }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "metaTitle": { "type": "string", "nullable": true }, "metaDescription": { "type": "string", "nullable": true }, "externalCrmId": { "type": "string", "nullable": true }, "externalCrmType": { "type": "string", "nullable": true }, "averageRating": { "type": "number", "nullable": true }, "reviewCount": { "type": "integer", "default": 0 }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "publicName": { "type": "string", "readOnly": true } }, "type": "object" }, "Company-company.update.jsonMergePatch": { "properties": { "countryCode": { "type": "string" }, "language": { "type": "string", "default": "fr" }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "siret": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "metiers": { "type": "array", "items": { "$ref": "#/components/schemas/Metier-company.update" } }, "description": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "coverImage": { "type": "string", "nullable": true }, "galleryImages": { "type": "array", "items": { "type": "string", "nullable": true } }, "address": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "googlePlaceId": { "type": "string", "nullable": true }, "metaTitle": { "type": "string", "nullable": true }, "metaDescription": { "type": "string", "nullable": true }, "externalCrmId": { "type": "string", "nullable": true }, "externalCrmType": { "type": "string", "nullable": true }, "openingHours": { "type": "array", "items": { "type": "string", "nullable": true } }, "services": { "type": "array", "items": { "type": "string", "nullable": true } }, "certifications": { "type": "array", "items": { "type": "string", "nullable": true } }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true } }, "type": "object" }, "Company-company.write": { "required": [ "name" ], "properties": { "countryCode": { "type": "string" }, "language": { "type": "string", "default": "fr" }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "siret": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "metiers": { "type": "array", "items": { "$ref": "#/components/schemas/Metier-company.write" } }, "description": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "coverImage": { "type": "string", "nullable": true }, "galleryImages": { "type": "array", "items": { "type": "string", "nullable": true } }, "address": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "website": { "type": "string", "nullable": true }, "googlePlaceId": { "type": "string", "nullable": true }, "metaTitle": { "type": "string", "nullable": true }, "metaDescription": { "type": "string", "nullable": true }, "externalCrmId": { "type": "string", "nullable": true }, "externalCrmType": { "type": "string", "nullable": true }, "openingHours": { "type": "array", "items": { "type": "string", "nullable": true } }, "services": { "type": "array", "items": { "type": "string", "nullable": true } }, "certifications": { "type": "array", "items": { "type": "string", "nullable": true } }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true } }, "type": "object" }, "Company.jsonld-company.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "sector": { "anyOf": [ { "$ref": "#/components/schemas/Sector.jsonld-company.list" }, { "type": "null" } ] }, "shortDescription": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "externalCrmId": { "type": "string", "nullable": true }, "externalCrmType": { "type": "string", "nullable": true }, "averageRating": { "type": "number", "nullable": true }, "reviewCount": { "type": "integer", "default": 0 }, "publicName": { "type": "string", "readOnly": true } }, "type": "object" } ] }, "Company.jsonld-company.read": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "language": { "type": "string", "default": "fr" }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "siret": { "type": "string", "nullable": true }, "vatNumber": { "type": "string", "nullable": true }, "sector": { "anyOf": [ { "$ref": "#/components/schemas/Sector.jsonld-company.read" }, { "type": "null" } ] }, "metiers": { "type": "array", "items": { "$ref": "#/components/schemas/Metier.jsonld-company.read" } }, "description": { "type": "string", "nullable": true }, "shortDescription": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "coverImage": { "type": "string", "nullable": true }, "galleryImages": { "type": "array", "items": { "type": "string", "nullable": true } }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "metaTitle": { "type": "string", "nullable": true }, "metaDescription": { "type": "string", "nullable": true }, "externalCrmId": { "type": "string", "nullable": true }, "externalCrmType": { "type": "string", "nullable": true }, "averageRating": { "type": "number", "nullable": true }, "reviewCount": { "type": "integer", "default": 0 }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "publicName": { "type": "string", "readOnly": true } }, "type": "object" } ] }, "ConstraintViolation": { "description": "Unprocessable entity", "properties": { "status": { "type": "integer", "default": 422 }, "violations": { "type": "array", "items": { "required": [ "propertyPath", "message" ], "properties": { "propertyPath": { "description": "The property path of the violation", "type": "string" }, "message": { "description": "The message associated with the violation", "type": "string" }, "code": { "description": "The code of the violation", "type": "string" }, "hint": { "description": "An extra hint to understand the violation", "type": "string" }, "payload": { "description": "The serialized payload of the violation", "type": "object", "additionalProperties": true } }, "type": "object" } }, "detail": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "title": { "type": "string", "readOnly": true, "nullable": true }, "instance": { "type": "string", "readOnly": true, "nullable": true } }, "type": "object" }, "ConstraintViolation.jsonld": { "description": "Unprocessable entity", "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "status": { "type": "integer", "default": 422 }, "violations": { "type": "array", "items": { "required": [ "propertyPath", "message" ], "properties": { "propertyPath": { "description": "The property path of the violation", "type": "string" }, "message": { "description": "The message associated with the violation", "type": "string" }, "code": { "description": "The code of the violation", "type": "string" }, "hint": { "description": "An extra hint to understand the violation", "type": "string" }, "payload": { "description": "The serialized payload of the violation", "type": "object", "additionalProperties": true } }, "type": "object" } }, "detail": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true }, "type": { "type": "string", "readOnly": true }, "title": { "type": "string", "readOnly": true, "nullable": true }, "instance": { "type": "string", "readOnly": true, "nullable": true } }, "type": "object" } ] }, "ContactRequest-contact.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "message": { "type": "string" }, "type": { "type": "string", "default": "contact" }, "status": { "type": "string", "default": "new" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "ContactRequest-contact.write": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "message": { "type": "string" }, "type": { "type": "string", "default": "contact" } }, "type": "object" }, "ContactRequest.jsonld-contact.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "message": { "type": "string" }, "type": { "type": "string", "default": "contact" }, "status": { "type": "string", "default": "new" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "DemandeDevis-devis.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string", "nullable": true }, "urgency": { "type": "string", "default": "pas_urgent" }, "status": { "type": "string", "default": "new" }, "source": { "type": "string" }, "countryCode": { "type": "string", "default": "FR" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" }, "DemandeDevis-devis.write": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "description": { "type": "string" }, "sector": { "type": "string", "nullable": true }, "metier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "budget": { "type": "string", "nullable": true }, "urgency": { "type": "string", "default": "pas_urgent" }, "source": { "type": "string" } }, "type": "object" }, "DemandeDevis-devis.write.jsonMergePatch": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string", "nullable": true }, "description": { "type": "string" }, "sector": { "type": "string", "nullable": true }, "metier": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "budget": { "type": "string", "nullable": true }, "urgency": { "type": "string", "default": "pas_urgent" }, "source": { "type": "string" } }, "type": "object" }, "DemandeDevis.jsonld-devis.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string", "nullable": true }, "urgency": { "type": "string", "default": "pas_urgent" }, "status": { "type": "string", "default": "new" }, "source": { "type": "string" }, "countryCode": { "type": "string", "default": "FR" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true } }, "type": "object" } ] }, "Error": { "description": "A representation of common errors.", "properties": { "title": { "description": "A short, human-readable summary of the problem.", "type": "string", "readOnly": true, "nullable": true }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string", "readOnly": true, "nullable": true }, "status": { "type": "integer", "default": 400, "nullable": true }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": "string", "readOnly": true, "nullable": true }, "type": { "description": "A URI reference that identifies the problem type", "type": "string", "readOnly": true } }, "type": "object" }, "Error.jsonld": { "description": "A representation of common errors.", "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "title": { "description": "A short, human-readable summary of the problem.", "type": "string", "readOnly": true, "nullable": true }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string", "readOnly": true, "nullable": true }, "status": { "type": "integer", "default": 400, "nullable": true }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "type": "string", "readOnly": true, "nullable": true }, "type": { "description": "A URI reference that identifies the problem type", "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true, "nullable": true } }, "type": "object" } ] }, "HydraCollectionBaseSchema": { "allOf": [ { "$ref": "#/components/schemas/HydraCollectionBaseSchemaNoPagination" }, { "properties": { "view": { "properties": { "@id": { "type": "string", "format": "iri-reference" }, "@type": { "type": "string" }, "first": { "type": "string", "format": "iri-reference" }, "last": { "type": "string", "format": "iri-reference" }, "previous": { "type": "string", "format": "iri-reference" }, "next": { "type": "string", "format": "iri-reference" } }, "type": "object", "example": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" } } }, "type": "object" } ] }, "HydraCollectionBaseSchemaNoPagination": { "properties": { "totalItems": { "type": "integer", "minimum": 0 }, "search": { "properties": { "@type": { "type": "string" }, "template": { "type": "string" }, "variableRepresentation": { "type": "string" }, "mapping": { "type": "array", "items": { "properties": { "@type": { "type": "string" }, "variable": { "type": "string" }, "property": { "type": "string", "nullable": true }, "required": { "type": "boolean" } }, "type": "object" } } }, "type": "object" } }, "type": "object" }, "HydraItemBaseSchema": { "required": [ "@id", "@type" ], "properties": { "@context": { "oneOf": [ { "type": "string" }, { "required": [ "@vocab", "hydra" ], "properties": { "@vocab": { "type": "string" }, "hydra": { "type": "string", "enum": [ "http://www.w3.org/ns/hydra/core#" ] } }, "type": "object", "additionalProperties": true } ] }, "@id": { "type": "string" }, "@type": { "type": "string" } }, "type": "object" }, "Metier-company.read": { "type": "object" }, "Metier-company.update": { "type": "object" }, "Metier-company.write": { "type": "object" }, "Metier.jsonld-company.read": { "type": "object" }, "Network-network.list": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "logoInitials": { "type": "string", "nullable": true }, "logoColor": { "type": "string", "nullable": true }, "logoBgColor": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "rating": { "type": "number", "nullable": true }, "reviewCount": { "type": "integer", "default": 0 }, "agencyCount": { "type": "string", "nullable": true }, "sector": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "isFeatured": { "type": "boolean", "default": false }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "nullable": true } }, "type": "object" }, "Network.jsonld-network.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "displayName": { "type": "string", "nullable": true }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "logoInitials": { "type": "string", "nullable": true }, "logoColor": { "type": "string", "nullable": true }, "logoBgColor": { "type": "string", "nullable": true }, "logoPath": { "type": "string", "nullable": true }, "rating": { "type": "number", "nullable": true }, "reviewCount": { "type": "integer", "default": 0 }, "agencyCount": { "type": "string", "nullable": true }, "sector": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "isFeatured": { "type": "boolean", "default": false }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "nullable": true } }, "type": "object" } ] }, "Review-review.list": { "required": [ "comment", "authorName" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "globalRating": { "type": "integer", "maximum": 5, "minimum": 1 }, "title": { "type": "string", "nullable": true }, "comment": { "type": "string", "minLength": 10 }, "authorName": { "type": "string" }, "status": { "type": "string", "default": "pending" }, "createdAt": { "type": "string", "format": "date-time" }, "source": { "type": "string", "nullable": true } }, "type": "object" }, "Review-review.read": { "required": [ "comment", "authorName", "authorEmail" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "language": { "type": "string", "default": "fr" }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "globalRating": { "type": "integer", "maximum": 5, "minimum": 1 }, "criteriaRatings": { "type": "array", "items": { "type": "string", "nullable": true } }, "title": { "type": "string", "nullable": true }, "comment": { "type": "string", "minLength": 10 }, "photos": { "type": "array", "items": { "type": "string", "nullable": true } }, "authorName": { "type": "string" }, "authorEmail": { "type": "string", "format": "email", "externalDocs": { "url": "https://schema.org/email" } }, "authorCity": { "type": "string", "nullable": true }, "status": { "type": "string", "default": "pending" }, "createdAt": { "type": "string", "format": "date-time" }, "source": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "sourceUrl": { "type": "string", "nullable": true } }, "type": "object" }, "Review-review.write": { "required": [ "comment", "authorName", "authorEmail" ], "properties": { "globalRating": { "type": "integer", "maximum": 5, "minimum": 1 }, "criteriaRatings": { "type": "array", "items": { "type": "string", "nullable": true } }, "title": { "type": "string", "nullable": true }, "comment": { "type": "string", "minLength": 10 }, "authorName": { "type": "string" }, "authorEmail": { "type": "string", "format": "email", "externalDocs": { "url": "https://schema.org/email" } }, "authorCity": { "type": "string", "nullable": true }, "source": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true } }, "type": "object" }, "Review.jsonld-review.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "comment", "authorName" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "globalRating": { "type": "integer", "maximum": 5, "minimum": 1 }, "title": { "type": "string", "nullable": true }, "comment": { "type": "string", "minLength": 10 }, "authorName": { "type": "string" }, "status": { "type": "string", "default": "pending" }, "createdAt": { "type": "string", "format": "date-time" }, "source": { "type": "string", "nullable": true } }, "type": "object" } ] }, "Review.jsonld-review.read": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "comment", "authorName", "authorEmail" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "language": { "type": "string", "default": "fr" }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "globalRating": { "type": "integer", "maximum": 5, "minimum": 1 }, "criteriaRatings": { "type": "array", "items": { "type": "string", "nullable": true } }, "title": { "type": "string", "nullable": true }, "comment": { "type": "string", "minLength": 10 }, "photos": { "type": "array", "items": { "type": "string", "nullable": true } }, "authorName": { "type": "string" }, "authorEmail": { "type": "string", "format": "email", "externalDocs": { "url": "https://schema.org/email" } }, "authorCity": { "type": "string", "nullable": true }, "status": { "type": "string", "default": "pending" }, "createdAt": { "type": "string", "format": "date-time" }, "source": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "sourceUrl": { "type": "string", "nullable": true } }, "type": "object" } ] }, "ReviewCriteria-criteria.read": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "sector": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true } }, "type": "object" }, "ReviewCriteria.jsonld-criteria.read": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "sector": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true } }, "type": "object" } ] }, "ReviewInvitation-invitation.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "clientEmail": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "clientPhone": { "type": "string", "nullable": true }, "token": { "type": "string", "readOnly": true }, "type": { "type": "string", "default": "email" }, "status": { "type": "string", "default": "pending" }, "sentAt": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "reminderCount": { "type": "integer", "default": 0 }, "channel": { "type": "string", "default": "email" } }, "type": "object" }, "ReviewInvitation-invitation.write": { "properties": { "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "clientEmail": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "clientPhone": { "type": "string", "nullable": true } }, "type": "object" }, "ReviewInvitation.jsonld-invitation.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "clientEmail": { "type": "string", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "clientPhone": { "type": "string", "nullable": true }, "token": { "type": "string", "readOnly": true }, "type": { "type": "string", "default": "email" }, "status": { "type": "string", "default": "pending" }, "sentAt": { "type": "string", "format": "date-time", "readOnly": true, "nullable": true }, "reminderCount": { "type": "integer", "default": 0 }, "channel": { "type": "string", "default": "email" } }, "type": "object" } ] }, "Sector-company.list": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "Sector-company.read": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" }, "Sector-sector.list": { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "nullable": true } }, "type": "object" }, "Sector.jsonld-company.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" } ] }, "Sector.jsonld-company.read": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object" } ] }, "Sector.jsonld-sector.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "required": [ "name" ], "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "name": { "type": "string" }, "slug": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "default": true }, "displayOrder": { "type": "integer", "default": 0 }, "countryCode": { "type": "string", "nullable": true } }, "type": "object" } ] }, "Survey-survey-invitation.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "title": { "type": "string" } }, "type": "object" }, "Survey-survey.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "default": "satisfaction" }, "isActive": { "type": "boolean", "default": true }, "isDefault": { "type": "boolean", "default": false }, "isNps": { "type": "boolean", "default": false }, "defaultChannel": { "type": "string", "default": "email" }, "sourceType": { "description": "Type de source metier : 'devis', 'chantier', 'facture', 'commande', 'sav', 'contact', 'fichier'", "type": "string", "nullable": true }, "alertThreshold": { "description": "Seuil de note en-dessous duquel on declenche une alerte (0 = desactive)", "type": "integer", "default": 0 }, "everybody": { "description": "S'applique a toutes les companies du reseau (equivalent Devibox tout_reseau/everybody)", "type": "boolean", "default": false }, "notifyOnCompletion": { "description": "Envoyer un email aux destinataires \u00e0 chaque r\u00e9ponse compl\u00e9t\u00e9e", "type": "boolean", "default": false } }, "type": "object" }, "Survey-survey.read": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "language": { "type": "string", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "default": "satisfaction" }, "isActive": { "type": "boolean", "default": true }, "isDefault": { "type": "boolean", "default": false }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "source": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailContent": { "type": "string", "nullable": true }, "isNps": { "type": "boolean", "default": false }, "maxScore": { "type": "integer", "default": 5 }, "defaultChannel": { "type": "string", "default": "email" }, "reminderEnabled": { "type": "boolean", "default": false }, "reminderDays": { "type": "integer", "default": 7 }, "maxReminders": { "type": "integer", "default": 2 }, "externalId": { "description": "ID dans le systeme source (ex: id Devibox) pour idempotence", "type": "string", "nullable": true }, "externalSource": { "description": "Source externe : 'devibox', 'import_csv', 'api'.", "type": "string", "nullable": true }, "sourceType": { "description": "Type de source metier : 'devis', 'chantier', 'facture', 'commande', 'sav', 'contact', 'fichier'", "type": "string", "nullable": true }, "dateReferenceField": { "description": "Nom du champ date qui sert de r\u00e9f\u00e9rence pour d\u00e9clencher l'enqu\u00eate (ex: 'date_signature', 'date_fin')", "type": "string", "nullable": true }, "triggerDays": { "description": "Nombre de jours apres la date de reference", "type": "integer", "nullable": true }, "triggerFromDate": { "description": "Date a partir de laquelle on commence a declencher", "type": "string", "format": "date-time", "nullable": true }, "triggerFilters": { "description": "JSON libre : tous les filtres metier (montant, etat, marque, etablissement...)", "type": "array", "items": { "type": "string", "nullable": true } }, "alertThreshold": { "description": "Seuil de note en-dessous duquel on declenche une alerte (0 = desactive)", "type": "integer", "default": 0 }, "everybody": { "description": "S'applique a toutes les companies du reseau (equivalent Devibox tout_reseau/everybody)", "type": "boolean", "default": false }, "acceptPhotos": { "description": "Accepter les photos en reponse", "type": "boolean", "default": false }, "allowMultiple": { "description": "Autoriser l'envoi plusieurs fois au meme destinataire (Devibox doublonsAccepted)", "type": "boolean", "default": false }, "displayOnSite": { "description": "Afficher les reponses validees sur le site public (Devibox onTheSite)", "type": "boolean", "default": false }, "recipientEmails": { "description": "Emails destinataires des notifications (separes par ',' ou ';')", "type": "string", "nullable": true }, "notifyOnCompletion": { "description": "Envoyer un email aux destinataires \u00e0 chaque r\u00e9ponse compl\u00e9t\u00e9e", "type": "boolean", "default": false } }, "type": "object" }, "Survey-survey.write": { "properties": { "countryCode": { "type": "string" }, "language": { "type": "string", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "default": "satisfaction" }, "isActive": { "type": "boolean", "default": true }, "isDefault": { "type": "boolean", "default": false }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "source": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailContent": { "type": "string", "nullable": true }, "isNps": { "type": "boolean", "default": false }, "maxScore": { "type": "integer", "default": 5 }, "defaultChannel": { "type": "string", "default": "email" }, "reminderEnabled": { "type": "boolean", "default": false }, "reminderDays": { "type": "integer", "default": 7 }, "maxReminders": { "type": "integer", "default": 2 }, "externalId": { "description": "ID dans le systeme source (ex: id Devibox) pour idempotence", "type": "string", "nullable": true }, "externalSource": { "description": "Source externe : 'devibox', 'import_csv', 'api'.", "type": "string", "nullable": true }, "sourceType": { "description": "Type de source metier : 'devis', 'chantier', 'facture', 'commande', 'sav', 'contact', 'fichier'", "type": "string", "nullable": true }, "dateReferenceField": { "description": "Nom du champ date qui sert de r\u00e9f\u00e9rence pour d\u00e9clencher l'enqu\u00eate (ex: 'date_signature', 'date_fin')", "type": "string", "nullable": true }, "triggerDays": { "description": "Nombre de jours apres la date de reference", "type": "integer", "nullable": true }, "triggerFromDate": { "description": "Date a partir de laquelle on commence a declencher", "type": "string", "format": "date-time", "nullable": true }, "triggerFilters": { "description": "JSON libre : tous les filtres metier (montant, etat, marque, etablissement...)", "type": "array", "items": { "type": "string", "nullable": true } }, "alertThreshold": { "description": "Seuil de note en-dessous duquel on declenche une alerte (0 = desactive)", "type": "integer", "default": 0 }, "everybody": { "description": "S'applique a toutes les companies du reseau (equivalent Devibox tout_reseau/everybody)", "type": "boolean", "default": false }, "acceptPhotos": { "description": "Accepter les photos en reponse", "type": "boolean", "default": false }, "allowMultiple": { "description": "Autoriser l'envoi plusieurs fois au meme destinataire (Devibox doublonsAccepted)", "type": "boolean", "default": false }, "displayOnSite": { "description": "Afficher les reponses validees sur le site public (Devibox onTheSite)", "type": "boolean", "default": false }, "recipientEmails": { "description": "Emails destinataires des notifications (separes par ',' ou ';')", "type": "string", "nullable": true }, "notifyOnCompletion": { "description": "Envoyer un email aux destinataires \u00e0 chaque r\u00e9ponse compl\u00e9t\u00e9e", "type": "boolean", "default": false } }, "type": "object" }, "Survey.jsonld-survey-invitation.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "title": { "type": "string" } }, "type": "object" } ] }, "Survey.jsonld-survey.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string", "default": "satisfaction" }, "isActive": { "type": "boolean", "default": true }, "isDefault": { "type": "boolean", "default": false }, "isNps": { "type": "boolean", "default": false }, "defaultChannel": { "type": "string", "default": "email" }, "sourceType": { "description": "Type de source metier : 'devis', 'chantier', 'facture', 'commande', 'sav', 'contact', 'fichier'", "type": "string", "nullable": true }, "alertThreshold": { "description": "Seuil de note en-dessous duquel on declenche une alerte (0 = desactive)", "type": "integer", "default": 0 }, "everybody": { "description": "S'applique a toutes les companies du reseau (equivalent Devibox tout_reseau/everybody)", "type": "boolean", "default": false }, "notifyOnCompletion": { "description": "Envoyer un email aux destinataires \u00e0 chaque r\u00e9ponse compl\u00e9t\u00e9e", "type": "boolean", "default": false } }, "type": "object" } ] }, "Survey.jsonld-survey.read": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "countryCode": { "type": "string" }, "language": { "type": "string", "nullable": true }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "type": { "type": "string", "default": "satisfaction" }, "isActive": { "type": "boolean", "default": true }, "isDefault": { "type": "boolean", "default": false }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "network": { "type": "string", "format": "iri-reference", "example": "https://example.com/", "nullable": true }, "source": { "type": "string", "nullable": true }, "emailSubject": { "type": "string", "nullable": true }, "emailContent": { "type": "string", "nullable": true }, "isNps": { "type": "boolean", "default": false }, "maxScore": { "type": "integer", "default": 5 }, "defaultChannel": { "type": "string", "default": "email" }, "reminderEnabled": { "type": "boolean", "default": false }, "reminderDays": { "type": "integer", "default": 7 }, "maxReminders": { "type": "integer", "default": 2 }, "externalId": { "description": "ID dans le systeme source (ex: id Devibox) pour idempotence", "type": "string", "nullable": true }, "externalSource": { "description": "Source externe : 'devibox', 'import_csv', 'api'.", "type": "string", "nullable": true }, "sourceType": { "description": "Type de source metier : 'devis', 'chantier', 'facture', 'commande', 'sav', 'contact', 'fichier'", "type": "string", "nullable": true }, "dateReferenceField": { "description": "Nom du champ date qui sert de r\u00e9f\u00e9rence pour d\u00e9clencher l'enqu\u00eate (ex: 'date_signature', 'date_fin')", "type": "string", "nullable": true }, "triggerDays": { "description": "Nombre de jours apres la date de reference", "type": "integer", "nullable": true }, "triggerFromDate": { "description": "Date a partir de laquelle on commence a declencher", "type": "string", "format": "date-time", "nullable": true }, "triggerFilters": { "description": "JSON libre : tous les filtres metier (montant, etat, marque, etablissement...)", "type": "array", "items": { "type": "string", "nullable": true } }, "alertThreshold": { "description": "Seuil de note en-dessous duquel on declenche une alerte (0 = desactive)", "type": "integer", "default": 0 }, "everybody": { "description": "S'applique a toutes les companies du reseau (equivalent Devibox tout_reseau/everybody)", "type": "boolean", "default": false }, "acceptPhotos": { "description": "Accepter les photos en reponse", "type": "boolean", "default": false }, "allowMultiple": { "description": "Autoriser l'envoi plusieurs fois au meme destinataire (Devibox doublonsAccepted)", "type": "boolean", "default": false }, "displayOnSite": { "description": "Afficher les reponses validees sur le site public (Devibox onTheSite)", "type": "boolean", "default": false }, "recipientEmails": { "description": "Emails destinataires des notifications (separes par ',' ou ';')", "type": "string", "nullable": true }, "notifyOnCompletion": { "description": "Envoyer un email aux destinataires \u00e0 chaque r\u00e9ponse compl\u00e9t\u00e9e", "type": "boolean", "default": false } }, "type": "object" } ] }, "SurveyInvitation-survey-invitation.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "survey": { "$ref": "#/components/schemas/Survey-survey-invitation.list" }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "clientEmail": { "type": "string" }, "clientName": { "type": "string", "nullable": true }, "token": { "type": "string" }, "status": { "type": "string", "default": "pending" }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "clientPhone": { "type": "string", "nullable": true }, "clientCompany": { "type": "string", "nullable": true }, "reminderCount": { "type": "integer", "default": 0 }, "sourceType": { "type": "string", "nullable": true }, "externalId": { "description": "ID de l'envoi dans le systeme source (ex: QualiboxEnvoi.id de Devibox) pour idempotence", "type": "string", "nullable": true }, "externalSource": { "description": "Source externe : 'devibox', etc.", "type": "string", "nullable": true }, "contextData": { "description": "Donnees metier de contexte au moment du declenchement (montant, ID devis, etc.)", "type": "array", "items": { "type": "string", "nullable": true } }, "emailStatus": { "type": "string", "default": "pending" }, "channel": { "type": "string", "default": "email" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "callStatus": { "description": "Statut de suivi des appels Call Center", "type": "string", "default": "to_contact" }, "callDate": { "description": "Date du dernier appel", "type": "string", "format": "date-time", "nullable": true }, "reminderDate": { "description": "Date de rappel programm\u00e9e", "type": "string", "format": "date-time", "nullable": true }, "callNote": { "description": "Note de l'op\u00e9rateur sur l'appel", "type": "string", "nullable": true }, "notifyReminder": { "description": "Notifier par email/SMS le jour du rappel", "type": "boolean", "default": false } }, "type": "object" }, "SurveyInvitation-survey-invitation.read": { "type": "object" }, "SurveyInvitation-survey-invitation.write": { "properties": { "survey": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "clientEmail": { "type": "string" }, "clientName": { "type": "string", "nullable": true }, "clientPhone": { "type": "string", "nullable": true }, "clientCompany": { "type": "string", "nullable": true }, "sourceType": { "type": "string", "nullable": true }, "externalId": { "description": "ID de l'envoi dans le systeme source (ex: QualiboxEnvoi.id de Devibox) pour idempotence", "type": "string", "nullable": true }, "externalSource": { "description": "Source externe : 'devibox', etc.", "type": "string", "nullable": true }, "contextData": { "description": "Donnees metier de contexte au moment du declenchement (montant, ID devis, etc.)", "type": "array", "items": { "type": "string", "nullable": true } }, "channel": { "type": "string", "default": "email" } }, "type": "object" }, "SurveyInvitation.jsonld-survey-invitation.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "survey": { "$ref": "#/components/schemas/Survey.jsonld-survey-invitation.list" }, "company": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "clientEmail": { "type": "string" }, "clientName": { "type": "string", "nullable": true }, "token": { "type": "string" }, "status": { "type": "string", "default": "pending" }, "sentAt": { "type": "string", "format": "date-time", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "clientPhone": { "type": "string", "nullable": true }, "clientCompany": { "type": "string", "nullable": true }, "reminderCount": { "type": "integer", "default": 0 }, "sourceType": { "type": "string", "nullable": true }, "externalId": { "description": "ID de l'envoi dans le systeme source (ex: QualiboxEnvoi.id de Devibox) pour idempotence", "type": "string", "nullable": true }, "externalSource": { "description": "Source externe : 'devibox', etc.", "type": "string", "nullable": true }, "contextData": { "description": "Donnees metier de contexte au moment du declenchement (montant, ID devis, etc.)", "type": "array", "items": { "type": "string", "nullable": true } }, "emailStatus": { "type": "string", "default": "pending" }, "channel": { "type": "string", "default": "email" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true }, "callStatus": { "description": "Statut de suivi des appels Call Center", "type": "string", "default": "to_contact" }, "callDate": { "description": "Date du dernier appel", "type": "string", "format": "date-time", "nullable": true }, "reminderDate": { "description": "Date de rappel programm\u00e9e", "type": "string", "format": "date-time", "nullable": true }, "callNote": { "description": "Note de l'op\u00e9rateur sur l'appel", "type": "string", "nullable": true }, "notifyReminder": { "description": "Notifier par email/SMS le jour du rappel", "type": "boolean", "default": false } }, "type": "object" } ] }, "SurveyInvitation.jsonld-survey-invitation.read": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "type": "object" } ] }, "SurveyResponse-survey-response.list": { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "invitation": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "npsScore": { "type": "integer", "nullable": true }, "globalSatisfaction": { "type": "integer", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "SurveyResponse.jsonld-survey-response.list": { "allOf": [ { "$ref": "#/components/schemas/HydraItemBaseSchema" }, { "properties": { "id": { "type": "string", "format": "uuid", "readOnly": true }, "invitation": { "type": "string", "format": "iri-reference", "example": "https://example.com/" }, "npsScore": { "type": "integer", "nullable": true }, "globalSatisfaction": { "type": "integer", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "type": "object" } ] } }, "securitySchemes": { "ApiKey": { "type": "apiKey", "description": "Cl\u00e9 API (format: qb_...)", "name": "X-Api-Key", "in": "header" }, "Bearer": { "type": "http", "description": "Token JWT (fallback)", "bearerFormat": "JWT", "scheme": "bearer" }, "apiKey": { "type": "apiKey", "description": "Value for the X-Api-Key header parameter.", "name": "X-Api-Key", "in": "header" }, "JWT": { "type": "http", "bearerFormat": "JWT", "scheme": "bearer" } } }, "security": [ { "ApiKey": [] } ], "tags": [ { "name": "Company", "description": "Resource 'Company' operations." }, { "name": "ContactRequest", "description": "Resource 'ContactRequest' operations." }, { "name": "DemandeDevis", "description": "Resource 'DemandeDevis' operations." }, { "name": "City", "description": "Resource 'City' operations." }, { "name": "Sector", "description": "Resource 'Sector' operations." }, { "name": "Network", "description": "Resource 'Network' operations." }, { "name": "Review", "description": "Resource 'Review' operations." }, { "name": "ReviewCriteria", "description": "Resource 'ReviewCriteria' operations." }, { "name": "ReviewInvitation", "description": "Resource 'ReviewInvitation' operations." }, { "name": "Survey", "description": "Resource 'Survey' operations." }, { "name": "SurveyInvitation", "description": "Resource 'SurveyInvitation' operations." }, { "name": "SurveyResponse", "description": "Resource 'SurveyResponse' operations." }, { "name": "Platform API", "description": "API pour int\u00e9grations CRM (Devibox, partenaires)" }, { "name": "Compat Devibox", "description": "Routes de compatibilit\u00e9 pour Devibox (format Hydra)" }, { "name": "Company Me", "description": "Profil de l'entreprise li\u00e9e \u00e0 la cl\u00e9 API" }, { "name": "Authentication", "description": "G\u00e9n\u00e9ration d'URLs d'auto-login" }, { "name": "Login Check", "description": "Login Check" }, { "name": "Invoices", "description": "Invoices" }, { "name": "Users", "description": "Users" }, { "name": "Companies", "description": "Companies" }, { "name": "Subscriptions", "description": "Subscriptions" } ] }