{ "openapi": "3.1.0", "info": { "title": "Pearl-Jam-API", "version": "5.38.8" }, "security": [ { "oauth2": [ "read", "write" ] } ], "tags": [ { "name": "04. Interviewers", "description": "Endpoints for interviewers" }, { "name": "07. State-count", "description": "Endpoints for state counts" }, { "name": "13. Reporting", "description": "Endpoints for reporting" }, { "name": "03. Users", "description": "Endpoints for users" }, { "name": "11. Enums", "description": "Endpoints for enums" }, { "name": "12. Messages", "description": "Endpoints for messages" }, { "name": "01. Campaigns", "description": "Endpoints for campaigns" }, { "name": "02. Survey-units", "description": "Endpoints for survey-units" }, { "name": "06. Closing causes", "description": "Endpoints for closing causes" }, { "name": "05. Organization-units", "description": "Endpoints for organization-units" } ], "paths": { "/api/user/{userId}/organization-unit/{ouId}": { "put": { "tags": [ "03. Users" ], "summary": "Assign User to Organization Unit", "operationId": "assignUserToOU", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "ouId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } } }, "/api/user/{id}": { "get": { "tags": [ "03. Users" ], "summary": "Get User by id", "operationId": "getUserById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } }, "put": { "tags": [ "03. Users" ], "summary": "Update User", "operationId": "updateUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } }, "delete": { "tags": [ "03. Users" ], "summary": "Delete User", "operationId": "deleteUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/survey-unit/{id}": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get detail of specific survey unit ", "operationId": "getSurveyUnitById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitInterviewerResponseDto" } } } } } }, "put": { "tags": [ "02. Survey-units" ], "summary": "Update the Survey Unit", "operationId": "updateSurveyUnit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyUnitUpdateDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitDetailDto" } } } } } }, "delete": { "tags": [ "02. Survey-units" ], "summary": "Delete survey-unit", "operationId": "deleteSurveyUnit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/survey-unit/{id}/viewed": { "put": { "tags": [ "02. Survey-units" ], "summary": "Update the state of Survey Units listed in request body", "operationId": "updateSurveyUnitViewed", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/survey-unit/{id}/state/{state}": { "put": { "tags": [ "02. Survey-units" ], "summary": "Update the state of Survey Units listed in request body", "operationId": "updateSurveyUnitState", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] } } ], "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/survey-unit/{id}/comment": { "put": { "tags": [ "02. Survey-units" ], "summary": "Update the comment of a survey unit", "operationId": "updateSurveyUnitComment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/survey-unit/{id}/closing-cause/{closingCause}": { "put": { "tags": [ "02. Survey-units" ], "summary": "Add Closing cause", "operationId": "updateClosingCause", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "closingCause", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/survey-unit/{id}/close/{closingCause}": { "put": { "tags": [ "02. Survey-units" ], "summary": "Closes a survey unit", "operationId": "closeSurveyUnit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "closingCause", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/preferences": { "put": { "tags": [ "preference-controller" ], "summary": "Update current user preferences with campaigns listed in request body", "operationId": "updatePreferences", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/message/{id}/interviewer/{idep}/read": { "put": { "tags": [ "12. Messages" ], "summary": "Mark a message as read", "operationId": "postMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "idep", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true } }, "/api/message/{id}/interviewer/{idep}/delete": { "put": { "tags": [ "12. Messages" ], "summary": "Mark a message as deleted", "operationId": "postDeletedMessage", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "idep", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true } }, "/api/interviewer/{id}": { "get": { "tags": [ "04. Interviewers" ], "summary": "Get interviewer by Id", "operationId": "getInterviewer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InterviewerContextDto" } } } } } }, "put": { "tags": [ "04. Interviewers" ], "summary": "Update interviewer", "operationId": "updateInterviewer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InterviewerContextDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InterviewerContextDto" } } } } } }, "delete": { "tags": [ "04. Interviewers" ], "summary": "Delete interviewer", "operationId": "deleteInterviewer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/campaign/{id}": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get target campaign", "operationId": "getCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignResponseDto" } } } } } }, "put": { "tags": [ "01. Campaigns" ], "summary": "Update campaign (label, email, configurations, visibilities, communication-informations, referents)", "operationId": "updateCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignUpdateDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "01. Campaigns" ], "summary": "Delete a campaign", "operationId": "deleteCampaignById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "force", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } } } }, "/api/campaign/{idCampaign}/organizational-unit/{idOu}/visibility": { "put": { "tags": [ "01. Campaigns" ], "summary": "Update the visibility of a campaign for an organizational unit", "operationId": "updateVisibility", "parameters": [ { "name": "idCampaign", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "idOu", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisibilityUpdateDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/verify-name": { "post": { "tags": [ "12. Messages" ], "summary": "Update Messages with campaigns or interviewers listed in request body", "operationId": "postMessage_1", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsTextDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/user": { "get": { "tags": [ "03. Users" ], "summary": "Get current user", "operationId": "getCurrentUser", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } }, "post": { "tags": [ "03. Users" ], "summary": "Create User", "operationId": "createUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/UserDto" } } } } } } }, "/api/survey-units": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get SurveyUnits", "operationId": "getListSurveyUnit", "parameters": [ { "name": "extended", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitDto" } } } } } } }, "post": { "tags": [ "02. Survey-units" ], "summary": "Create survey-units", "operationId": "postSurveyUnits", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitCreationDto" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/survey-units/states": { "post": { "tags": [ "02. Survey-units" ], "operationId": "addStateToMultipleSurveyUnits", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyUnitsNewStateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/survey-units/interviewers": { "post": { "tags": [ "02. Survey-units" ], "summary": "Assign SurveyUnits to interviewers", "operationId": "postSurveyUnitInterviewerLinks", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitInterviewerLinkDto" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/survey-units/closures": { "post": { "tags": [ "02. Survey-units" ], "operationId": "addClosingCauseToMultipleSurveyUnits", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseSurveyUnitsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/survey-unit/{id}/temp-zone": { "post": { "tags": [ "02. Survey-units" ], "summary": "Post survey-unit to temp-zone", "operationId": "postSurveyUnitByIdInTempZone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonNode" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/organization-units": { "get": { "tags": [ "05. Organization-units" ], "summary": "Get all organization-units", "operationId": "getOrganizationUnits", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationUnitContextDto" } } } } } } }, "post": { "tags": [ "05. Organization-units" ], "summary": "Create Context with Organizational Unit and users associated", "operationId": "postContext", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationUnitContextDto" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/organization-unit": { "post": { "tags": [ "05. Organization-units" ], "summary": "Create Organizational Unit and users associated", "operationId": "postOrganizationUnit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUnitContextDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "deprecated": true } }, "/api/organization-unit/{id}/users": { "post": { "tags": [ "05. Organization-units" ], "summary": "Create users by organization-unit", "operationId": "postUsersByOrganizationUnit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserContextDto" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } } } }, "/api/message": { "post": { "tags": [ "12. Messages" ], "summary": "Post a message", "operationId": "postMessage_2", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true } }, "/api/mail": { "post": { "tags": [ "12. Messages" ], "summary": "Post a mail to admins", "operationId": "postMailMessage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/interviewers": { "get": { "tags": [ "04. Interviewers" ], "summary": "Get interviewers", "operationId": "getListInterviewers", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InterviewerDto" } } } } } } }, "post": { "tags": [ "04. Interviewers" ], "summary": "Post interviewers", "operationId": "postInterviewers", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InterviewerContextDto" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/api/campaign": { "post": { "tags": [ "01. Campaigns" ], "summary": "Create a Campaign", "operationId": "createCampaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCreateDto" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/admin/survey-units/details": { "post": { "tags": [ "02. Survey-units" ], "summary": "Get detail as admin of specific survey units", "operationId": "getAdminSurveyUnitsByIds", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitInterviewerResponseDto" } } } } } } } }, "/api/admin/reporting/snapshots": { "post": { "tags": [ "13. Reporting" ], "summary": "Trigger snapshot computation for a given day (admin only)", "operationId": "computeSnapshot", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "204": { "description": "No Content" } } } }, "/campaigns/{id}/ongoing": { "get": { "tags": [ "01. Campaigns" ], "summary": "Check if campaign is on-going", "operationId": "isOngoing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/OngoingDto" } } } } } } }, "/api/survey-units/{surveyUnitId}/history": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey unit history", "description": "Return states and communications of a survey unit", "operationId": "getSurveyUnitHistory", "parameters": [ { "name": "surveyUnitId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitHistoryResponse" } } } } } } }, "/api/survey-units/to-review": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey units to review with pagination", "description": "Returns a paginated list of survey units that need to be reviewed", "operationId": "getSurveyUnitsToReview", "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index (0..N)", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "size", "in": "query", "description": "The size of the page to be returned", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1 } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "viewed", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitToReviewPageResponse" } } } } } } }, "/api/survey-units/to-close": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey units to close for management UI", "operationId": "getSurveyUnitsToClose", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitToClose" } } } } } } } }, "/api/survey-units/to-close/export": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey units to close csv table", "operationId": "getSurveyUnitsToCloseExport", "parameters": [ { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/survey-units/temp-zone": { "get": { "tags": [ "02. Survey-units" ], "summary": "GET all survey-units in temp-zone", "operationId": "getSurveyUnitsInTempZone", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true } }, "/api/survey-units/closable": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get closable survey units", "operationId": "getClosableSurveyUnits", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClosableSurveyUnitDto" } } } } } }, "deprecated": true } }, "/api/survey-units/assigned": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey units assigned with pagination", "description": "Returns a paginated list of survey units assigned to the organization-unit of the user", "operationId": "getSurveyUnitsAssigned", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index (0..N)", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "size", "in": "query", "description": "The size of the page to be returned", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1 } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitAssignedPageResponse" } } } } } } }, "/api/survey-units/assigned/export": { "get": { "tags": [ "02. Survey-units" ], "summary": "Export assigned survey units as CSV file", "operationId": "exportSurveyUnitAssignedAsCsv", "parameters": [ { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "campaignId", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/survey-unit/{id}/states": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get states of given survey unit", "operationId": "getStatesBySurveyUnitId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitStatesDto" } } } } }, "deprecated": true } }, "/api/reporting/interviewers/{interviewerId}/campaigns/progress": { "get": { "tags": [ "13. Reporting" ], "summary": "Get interviewer campaigns reporting", "operationId": "getInterviewerCampaignsProgress", "parameters": [ { "name": "interviewerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignProgressInterviewer" } } } } } } } }, "/api/reporting/interviewers/{interviewerId}/campaigns/progress/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export interviewer campaigns progress as CSV file", "operationId": "exportInterviewerCampaignsProgressAsCsv", "parameters": [ { "name": "interviewerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/interviewers/{interviewerId}/campaigns/collection": { "get": { "tags": [ "13. Reporting" ], "summary": "Get interviewer campaigns reporting", "operationId": "getInterviewerCampaignsCollection", "parameters": [ { "name": "interviewerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignCollectionInterviewer" } } } } } } } }, "/api/reporting/interviewers/{interviewerId}/campaigns/collection/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export interviewer campaigns collection as CSV file", "operationId": "exportInterviewerCampaignsCollectionAsCsv", "parameters": [ { "name": "interviewerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/interviewers/{interviewerId}/campaign/closing-causes": { "get": { "tags": [ "13. Reporting" ], "summary": "Endpoint for retrieving closing causes for interviewer campaigns", "operationId": "getInterviewerClosingCausesByCampaign", "parameters": [ { "name": "interviewerId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/InterviewerCampaignsClosingCausesResponse" } } } } } } }, "/api/reporting/campaigns/{campaignId}/organization-units/progress": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaign progress for each organization unit from daily stats snapshot", "operationId": "getCampaignProgressForOUsFromStats", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignProgressByOrganizationUnits" } } } } } } }, "/api/reporting/campaigns/{campaignId}/organization-units/progress/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaign progress by organization units as CSV file", "operationId": "exportOrganizationUnitProgressAsCsv", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/campaigns/{campaignId}/organization-units/collection": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaign collection for each organization unit from daily stats snapshot", "operationId": "getCampaignProgressForOUsFromStats_1", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignCollectionByOrganizationUnits" } } } } } } }, "/api/reporting/campaigns/{campaignId}/organization-units/collection/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaign collection by organization units as CSV file", "operationId": "exportOrganizationUnitCollectionAsCsv", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/campaigns/{campaignId}/interviewers/progress": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaign progress for each interviewer from daily stats snapshot", "operationId": "getCampaignProgressForInterviewersFromStats", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignProgressByInterviewers" } } } } } } }, "/api/reporting/campaigns/{campaignId}/interviewers/progress/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaign progress by interviewers as CSV file", "operationId": "exportInterviewerProgressAsCsv", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/campaigns/{campaignId}/interviewers/collection": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaign collection for each interviewer from daily stats snapshot", "operationId": "getCampaignProgressForInterviewersFromStats_1", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignCollectionByInterviewers" } } } } } } }, "/api/reporting/campaigns/{campaignId}/interviewers/collection/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaign collection by interviewers as CSV file", "operationId": "exportInterviewerCollectionAsCsv", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/campaigns/{campaignId}/interviewers/closing-causes": { "get": { "tags": [ "13. Reporting" ], "summary": "Endpoint for retrieving closing causes of interviewers for a campaign", "operationId": "getCampaignClosingCausesStatusByInterviewer", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignClosingCausesByInterviewers" } } } } } } }, "/api/reporting/campaigns/summary": { "get": { "tags": [ "13. Reporting" ], "summary": "Get summary of campaigns (based on my preferences), including state counts", "operationId": "getCampaignSummaryWithStateCount", "parameters": [ { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignSummaryProgress" } } } } } } } }, "/api/reporting/campaigns/progress": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaigns reporting", "operationId": "getCampaignsProgress", "parameters": [ { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignProgress" } } } } } } } }, "/api/reporting/campaigns/progress/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaigns progress as CSV file", "operationId": "exportCampaignsProgressAsCsv", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/reporting/campaigns/collection": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaigns reporting", "operationId": "getCampaignsCollection", "parameters": [ { "name": "day", "in": "query", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignCollection" } } } } } } } }, "/api/reporting/campaigns/collection/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaigns collection as CSV file", "operationId": "exportCampaignsCollectionAsCsv", "parameters": [ { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/messages/{id}": { "get": { "tags": [ "12. Messages" ], "summary": "Get a message", "operationId": "getMessages", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageDto" } } } } } }, "deprecated": true } }, "/api/message-history": { "get": { "tags": [ "12. Messages" ], "summary": "Get the message history", "operationId": "getMessageHistory", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageDto" } } } } } }, "deprecated": true } }, "/api/interviewers/survey-units/state-count": { "get": { "tags": [ "07. State-count" ], "summary": "Get interviewersStateCount", "operationId": "getInterviewersStateCount", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountDto" } } } } } }, "deprecated": true } }, "/api/interviewer/{id}/campaigns": { "get": { "tags": [ "04. Interviewers" ], "summary": "Get interviewer campaigns", "operationId": "getListCampaigns", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignVisibilityPeriodDto" } } } } } } } }, "/api/interviewer/campaigns": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get interviewer related Campaigns", "operationId": "getInterviewerCampaigns", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignDto" } } } } } } } }, "/api/interrogations": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get SurveyUnits", "operationId": "getListSurveyUnit_1", "parameters": [ { "name": "extended", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitDto" } } } } } } } }, "/api/healthcheck": { "get": { "tags": [ "09. HealthCheck" ], "summary": "Healthcheck, check if api is alive", "operationId": "healthCheck", "responses": { "200": { "description": "OK" } } } }, "/api/enum/state": { "get": { "tags": [ "11. Enums" ], "summary": "Get enum", "operationId": "getStateEnum", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] } } } } } }, "deprecated": true } }, "/api/enum/contact-outcome": { "get": { "tags": [ "11. Enums" ], "summary": "Get enum", "operationId": "getContactOutcomeEnum", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "DUU", "NUH", "DCD", "NOA" ] } } } } } }, "deprecated": true } }, "/api/enum/contact-attempt": { "get": { "tags": [ "11. Enums" ], "summary": "Get enum", "operationId": "getContactAttemptEnum", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "INA", "APT", "REF", "TUN", "NOC", "MES", "UCD", "NLH", "NPS", "PUN" ] } } } } } }, "deprecated": true } }, "/api/check-habilitation": { "get": { "tags": [ "02. Survey-units" ], "summary": "Check habilitation", "operationId": "checkHabilitation", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "role", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/HabilitationDto" } } } } } } }, "/api/campaigns": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get user preferred Campaigns", "operationId": "getUserPreferredCampaigns", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignDto" } } } } } }, "deprecated": true } }, "/api/campaigns/{id}/referents": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get referents of targeted campaign", "operationId": "getReferents", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReferentDto" } } } } } }, "deprecated": true } }, "/api/campaigns/{id}": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get target campaign", "operationId": "getCampaign_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignResponseDto" } } } } } } }, "/api/campaigns/survey-units/state-count": { "get": { "tags": [ "07. State-count" ], "summary": "Get campaignStateCount", "operationId": "getCampaignsStateCount", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountDto" } } } } } }, "deprecated": true } }, "/api/campaigns/survey-units/contact-outcomes": { "get": { "tags": [ "contact-outcome-controller" ], "summary": "Get campaignStateCount", "operationId": "getCampaignsContactOutcomeTypeCount", "parameters": [ { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactOutcomeTypeCountDto" } } } } } } } }, "/api/campaigns/preferences": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get user related Campaigns", "operationId": "getUserCampaigns", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignPreferenceDto" } } } } } } } }, "/api/campaigns/phase": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get user related Campaigns for specific phase", "operationId": "getUserCampaignsForSpecificPhase", "parameters": [ { "name": "campaignPhase", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "INITIAL_ASSIGNMENT", "COLLECTION_IN_PROGRESS", "COLLECTION_COMPLETED" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignModel" } } } } } } } }, "/api/campaigns/ongoing": { "get": { "tags": [ "01. Campaigns" ], "summary": "get ongoing sensitive campaigns", "operationId": "getCampaignSensitivityDto", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignSensitivityDto" } } } } } } } }, "/api/campaigns/commons/{id}": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get commons campaign", "operationId": "getCommonsCampaignsById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCommonsDto" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignCommonsDto" } } } } } } }, "/api/campaigns/commons/ongoing": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get commons ongoing campaigns", "operationId": "getCommonsOngoingCampaigns", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignCommonsDto" } } } } } } } }, "/api/campaign/{id}/visibilities": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get campaign visibilities", "operationId": "getVisibilities", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VisibilityCampaignDto" } } } } } } } }, "/api/campaign/{id}/survey-units": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get Survey Units in target campaign", "operationId": "getSurveyUnitByCampaignId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitCampaignDto" }, "uniqueItems": true } } } } } } }, "/api/campaign/{id}/survey-units/state-count": { "get": { "tags": [ "07. State-count" ], "summary": "Get campaignStateCount", "operationId": "getCampaignStateCount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/StateCountCampaignDto" } } } } }, "deprecated": true } }, "/api/campaign/{id}/survey-units/not-attributed": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get numberSUNotAttributed", "operationId": "getNbSUNotAttributed", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CountDto" } } } } }, "deprecated": true } }, "/api/campaign/{id}/survey-units/not-attributed/state-count": { "get": { "tags": [ "07. State-count" ], "summary": "Get state count for non attributted SUs", "operationId": "getNbSUNotAttributedStateCount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/StateCountDto" } } } } } } }, "/api/campaign/{id}/survey-units/not-attributed/contact-outcomes": { "get": { "tags": [ "contact-outcome-controller" ], "summary": "Get Contact-outcomes count for non attributted SUs", "operationId": "getNbSUNotAttributedContactOutcomes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContactOutcomeTypeCountDto" } } } } } } }, "/api/campaign/{id}/survey-units/interviewer/{idep}/state-count": { "get": { "tags": [ "07. State-count" ], "summary": "Get interviewerStateCount", "operationId": "getInterviewerStateCount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "idep", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/StateCountDto" } } } } } } }, "/api/campaign/{id}/survey-units/interviewer/{idep}/contact-outcomes": { "get": { "tags": [ "contact-outcome-controller" ], "summary": "Get contact-outcome type for an interviewer on a specific campaign", "operationId": "getContactOuctomeByCampaignAndInterviewer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "idep", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContactOutcomeTypeCountDto" } } } } } } }, "/api/campaign/{id}/survey-units/interviewer/{idep}/closing-causes": { "get": { "tags": [ "06. Closing causes" ], "summary": "Get interviewerStateCount", "operationId": "getClosingCauseCount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "idep", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ClosingCauseCountDto" } } } } }, "deprecated": true } }, "/api/campaign/{id}/survey-units/contact-outcomes": { "get": { "tags": [ "contact-outcome-controller" ], "summary": "Get campaignStateCount", "operationId": "getContactOutcomeTypeCountByCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ContactOutcomeTypeCountCampaignDto" } } } } } } }, "/api/campaign/{id}/survey-units/completed": { "get": { "tags": [ "02. Survey-units" ], "operationId": "getCompletedSurveyUnitsForCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "page", "in": "query", "description": "Zero-based page index (0..N)", "required": false, "schema": { "type": "integer", "default": 0, "minimum": 0 } }, { "name": "size", "in": "query", "description": "The size of the page to be returned", "required": false, "schema": { "type": "integer", "default": 20, "minimum": 1 } }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitCompleted" } } } } } } }, "/api/campaign/{id}/survey-units/completed/export": { "get": { "tags": [ "02. Survey-units" ], "operationId": "getExportCompletedSurveyUnitsForCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/campaign/{id}/survey-units/abandoned": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get numberSUAbandoned", "operationId": "getNbSUAbandoned", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CountDto" } } } } }, "deprecated": true } }, "/api/campaign/{id}/portal-data": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get campaign portal data", "operationId": "getPortalData", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalDataDto" } } } } } } }, "/api/campaign/{id}/organization": { "get": { "tags": [ "13. Reporting" ], "summary": "Get campaign organization", "operationId": "getCampaignOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/CampaignOrganization" } } } } } } }, "/api/campaign/{id}/organization/export": { "get": { "tags": [ "13. Reporting" ], "summary": "Export campaign organization as CSV file", "operationId": "exportCampaignOrganizationAsCsv", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "date", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string", "format": "byte" } } } } } } }, "/api/campaign/{id}/interviewers": { "get": { "tags": [ "04. Interviewers" ], "summary": "Get interviewers for target campaign", "operationId": "getInterviewersByCampaignForCurrentUser", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InterviewerDto" } } } } } }, "deprecated": true } }, "/api/campaign/{id}/interviewers/state-count": { "get": { "tags": [ "07. State-count" ], "summary": "Get interviewersStateCount", "operationId": "getInterviewersStateCountByCampaign", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountDto" } } } } } } } }, "/api/campaign/{id}/communication-templates": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get campaign communication templates", "operationId": "getCommunicationTemplates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationTemplateResponseDto" } } } } } } } }, "/api/admin/survey-units": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey units id", "operationId": "getAllSurveyUnitsId", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } }, "deprecated": true } }, "/api/admin/survey-unit/{id}": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get detail as admin of specific survey unit ", "operationId": "getAdminSurveyUnitById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SurveyUnitInterviewerResponseDto" } } } } }, "deprecated": true } }, "/api/admin/interviewers": { "get": { "tags": [ "04. Interviewers" ], "summary": "Get all interviewers", "operationId": "getCompleteListInterviewers", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InterviewerContextDto" } } } } } } } }, "/api/admin/campaigns": { "get": { "tags": [ "01. Campaigns" ], "summary": "Get Campaigns", "operationId": "getAllCampaigns", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignDto" } } } } } } } }, "/api/admin/campaign/{id}/survey-units": { "get": { "tags": [ "02. Survey-units" ], "summary": "Get survey units id by campaign", "operationId": "getAllSurveyUnitsIdByCampaignId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/api/organization-unit/{id}": { "delete": { "tags": [ "05. Organization-units" ], "summary": "Delete an organization-unit", "operationId": "deleteOrganizationUnit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } } } } }, "deprecated": true } } }, "components": { "schemas": { "OrganizationUnitDto": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id" ] }, "UserDto": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "organizationUnit": { "$ref": "#/components/schemas/OrganizationUnitDto" }, "localOrganizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationUnitDto" } } }, "required": [ "firstName", "id", "lastName", "organizationUnit" ] }, "AddressDto": { "type": "object", "properties": { "l1": { "type": "string" }, "l2": { "type": "string" }, "l3": { "type": "string" }, "l4": { "type": "string" }, "l5": { "type": "string" }, "l6": { "type": "string" }, "l7": { "type": "string" }, "elevator": { "type": "boolean" }, "building": { "type": "string" }, "floor": { "type": "string" }, "door": { "type": "string" }, "staircase": { "type": "string" }, "cityPriorityDistrict": { "type": "boolean" } } }, "CommentDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INTERVIEWER", "MANAGEMENT" ] }, "value": { "type": "string", "maxLength": 999, "minLength": 0 } }, "required": [ "type", "value" ] }, "CommunicationRequestCreateDto": { "type": "object", "properties": { "communicationTemplateId": { "type": "string" }, "creationTimestamp": { "type": "integer", "format": "int64" }, "reason": { "type": "string", "enum": [ "REFUSAL", "UNREACHABLE" ] } }, "required": [ "communicationTemplateId", "creationTimestamp", "reason" ] }, "ContactAttemptDto": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "status": { "type": "string", "enum": [ "INA", "APT", "REF", "TUN", "NOC", "MES", "UCD", "NLH", "NPS", "PUN" ] }, "medium": { "type": "string", "enum": [ "TEL", "EMAIL", "FIELD" ] } } }, "ContactOutcomeDto": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "type": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "DUU", "NUH", "DCD", "NOA" ] }, "totalNumberOfContactAttempts": { "type": "integer", "format": "int32" } } }, "NextContactHistoryDto": { "type": "object", "properties": { "persons": { "type": "array", "items": { "$ref": "#/components/schemas/NextContactHistoryPersonDto" } } } }, "NextContactHistoryPersonDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "enum": [ "MISTER", "MISS" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "preferredContact": { "type": "boolean" } }, "required": [ "firstName", "lastName", "title" ] }, "PersonDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "enum": [ "MISTER", "MISS" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "birthdate": { "type": "integer", "format": "int64" }, "privileged": { "type": "boolean" }, "phoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberDto" } } }, "required": [ "firstName", "lastName", "title" ] }, "PhoneNumberDto": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "FISCAL", "DIRECTORY", "INTERVIEWER" ] }, "favorite": { "type": "boolean" }, "number": { "type": "string" } } }, "RawIdentificationDto": { "type": "object", "properties": { "identification": { "type": "string", "enum": [ "IDENTIFIED", "DESTROY", "UNIDENTIFIED" ] }, "access": { "type": "string", "enum": [ "ACC", "NACC" ] }, "situation": { "type": "string", "enum": [ "ORDINARY", "ABSORBED", "NOORDINARY" ] }, "category": { "type": "string", "enum": [ "PRIMARY", "OCCASIONAL", "SECONDARY", "VACANT" ] }, "occupant": { "type": "string", "enum": [ "IDENTIFIED", "UNIDENTIFIED" ] }, "individualStatus": { "type": "string", "enum": [ "DCD", "NOIDENT", "NOFIELD", "SAME_ADDRESS", "OTHER_ADDRESS" ] }, "interviewerCanProcess": { "type": "string", "enum": [ "YES", "NO" ] }, "numberOfRespondents": { "type": "string", "enum": [ "ONE", "MANY" ] }, "presentInPreviousHome": { "type": "string", "enum": [ "AT_LEAST_ONE", "NONE" ] }, "householdComposition": { "type": "string", "enum": [ "SAME_COMPO", "OTHER_COMPO" ] } } }, "StateDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "date": { "type": "integer", "format": "int64" }, "type": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] } } }, "SurveyUnitUpdateDto": { "type": "object", "properties": { "id": { "type": "string" }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } }, "address": { "$ref": "#/components/schemas/AddressDto" }, "move": { "type": "boolean" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentDto" } }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateDto" } }, "contactAttempts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAttemptDto" } }, "contactOutcome": { "$ref": "#/components/schemas/ContactOutcomeDto" }, "identification": { "$ref": "#/components/schemas/RawIdentificationDto" }, "communicationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationRequestCreateDto" } }, "nextContactHistory": { "$ref": "#/components/schemas/NextContactHistoryDto" } } }, "CommunicationRequestResponseDto": { "type": "object", "properties": { "communicationTemplateId": { "type": "string" }, "campaignId": { "type": "string" }, "meshuggahId": { "type": "string" }, "reason": { "type": "string", "enum": [ "REFUSAL", "UNREACHABLE" ] }, "emitter": { "type": "string", "enum": [ "TOOL", "INTERVIEWER" ] }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationRequestStatusDto" } } } }, "CommunicationRequestStatusDto": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "status": { "type": "string", "enum": [ "INITIATED", "READY", "SUBMITTED", "UNDELIVERED", "FAILED", "CANCELLED" ] } } }, "IdentificationDto": {}, "PreviousContactHistoryDto": { "type": "object", "properties": { "comment": { "type": "string" }, "contactOutcomeValue": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "NUH", "NOA", "NPA", "NPI", "NPX", "ROW" ] }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/PreviousContactHistoryPersonDto" } } }, "required": [ "contactOutcomeValue" ] }, "PreviousContactHistoryPersonDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "title": { "type": "string", "enum": [ "MISTER", "MISS" ] }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthdate": { "type": "integer", "format": "int64" }, "panel": { "type": "boolean" } }, "required": [ "firstName", "lastName" ] }, "SampleIdentifiersDto": { "type": "object", "properties": { "bs": { "type": "integer", "format": "int32" }, "ec": { "type": "string" }, "le": { "type": "integer", "format": "int32" }, "noi": { "type": "integer", "format": "int32" }, "numfa": { "type": "integer", "format": "int32" }, "rges": { "type": "integer", "format": "int32" }, "ssech": { "type": "integer", "format": "int32" }, "nolog": { "type": "integer", "format": "int32" }, "nole": { "type": "integer", "format": "int32" }, "autre": { "type": "string" }, "nograp": { "type": "string" } } }, "SurveyUnitDetailDto": { "type": "object", "properties": { "id": { "type": "string" }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } }, "address": { "$ref": "#/components/schemas/AddressDto" }, "priority": { "type": "boolean" }, "move": { "type": "boolean" }, "campaign": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentDto" } }, "sampleIdentifiers": { "$ref": "#/components/schemas/SampleIdentifiersDto" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateDto" } }, "contactAttempts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAttemptDto" } }, "contactOutcome": { "$ref": "#/components/schemas/ContactOutcomeDto" }, "identification": { "$ref": "#/components/schemas/IdentificationDto" }, "communicationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationRequestResponseDto" } }, "previousContactHistory": { "$ref": "#/components/schemas/PreviousContactHistoryDto" }, "nextContactHistory": { "$ref": "#/components/schemas/NextContactHistoryDto" } } }, "InterviewerContextDto": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "title": { "type": "string", "enum": [ "MISTER", "MISS" ] } } }, "CampaignUpdateDto": { "type": "object", "properties": { "campaignLabel": { "type": "string", "minLength": 1 }, "visibilities": { "type": "array", "items": { "$ref": "#/components/schemas/VisibilityCampaignUpdateDto" } }, "referents": { "type": "array", "items": { "$ref": "#/components/schemas/ReferentDto" } }, "email": { "type": "string" }, "contactOutcomeConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "contactAttemptConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "collectNextContacts": { "type": "boolean" } }, "required": [ "campaignLabel" ] }, "ReferentDto": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "role": { "type": "string" } } }, "VisibilityCampaignUpdateDto": { "type": "object", "properties": { "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "organizationalUnit": { "type": "string", "minLength": 1 }, "useLetterCommunication": { "type": "boolean" }, "mail": { "type": "string" }, "tel": { "type": "string" } }, "required": [ "organizationalUnit" ] }, "VisibilityUpdateDto": { "type": "object", "properties": { "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "useLetterCommunication": { "type": "boolean" }, "mail": { "type": "string" }, "tel": { "type": "string" } } }, "WsTextDto": { "type": "object", "properties": { "text": { "type": "string" } } }, "ClosingCauseDto": { "type": "object", "properties": { "date": { "type": "integer", "format": "int64" }, "type": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] } } }, "SurveyUnitCreationDto": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } }, "address": { "$ref": "#/components/schemas/AddressDto" }, "organizationUnitId": { "type": "string" }, "priority": { "type": "boolean" }, "campaign": { "type": "string" }, "sampleIdentifiers": { "$ref": "#/components/schemas/SampleIdentifiersDto" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateDto" } }, "contactAttempts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAttemptDto" } }, "contactOutcome": { "$ref": "#/components/schemas/ContactOutcomeDto" }, "closingCause": { "$ref": "#/components/schemas/ClosingCauseDto" }, "identification": { "$ref": "#/components/schemas/RawIdentificationDto" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentDto" }, "uniqueItems": true }, "contactHistory": { "$ref": "#/components/schemas/PreviousContactHistoryDto" } } }, "SurveyUnitsNewStateRequest": { "type": "object", "properties": { "surveyUnitIds": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "stateType": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] } }, "required": [ "stateType", "surveyUnitIds" ] }, "SurveyUnitInterviewerLinkDto": { "type": "object", "properties": { "surveyUnitId": { "type": "string" }, "interviewerId": { "type": "string" } } }, "CloseSurveyUnitsRequest": { "type": "object", "properties": { "surveyUnitIds": { "type": "array", "items": { "type": "string" }, "minItems": 1 }, "closingCauseType": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] }, "toClose": { "type": "boolean" } }, "required": [ "closingCauseType", "surveyUnitIds" ] }, "JsonNode": { "type": "object", "properties": { "empty": { "type": "boolean" }, "array": { "type": "boolean" }, "null": { "type": "boolean" }, "object": { "type": "boolean" }, "float": { "type": "boolean" }, "long": { "type": "boolean" }, "short": { "type": "boolean" }, "boolean": { "type": "boolean" }, "integralNumber": { "type": "boolean" }, "double": { "type": "boolean" }, "valueNode": { "type": "boolean" }, "textual": { "type": "boolean", "deprecated": true }, "int": { "type": "boolean" }, "floatingPointNumber": { "type": "boolean" }, "bigDecimal": { "type": "boolean" }, "bigInteger": { "type": "boolean" }, "pojo": { "type": "boolean" }, "container": { "type": "boolean" }, "missingNode": { "type": "boolean" }, "nodeType": { "type": "string", "enum": [ "ARRAY", "BINARY", "BOOLEAN", "MISSING", "NULL", "NUMBER", "OBJECT", "POJO", "STRING" ] }, "string": { "type": "boolean" }, "number": { "type": "boolean" }, "binary": { "type": "boolean" }, "embeddedValue": { "type": "boolean" } } }, "OrganizationUnitContextDto": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": [ "LOCAL", "NATIONAL" ] }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserContextDto" } }, "organisationUnitRef": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "label", "type" ] }, "UserContextDto": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "organizationUnit": { "$ref": "#/components/schemas/OrganizationUnitDto" }, "localOrganizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationUnitDto" } } } }, "MessageDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "text": { "type": "string" }, "sender": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "string" } }, "typedRecipients": { "type": "array", "items": { "$ref": "#/components/schemas/VerifyNameResponseDto" } }, "date": { "type": "integer", "format": "int64" }, "status": { "type": "string" } } }, "VerifyNameResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "label": { "type": "string" } } }, "MailDto": { "type": "object", "properties": { "content": { "type": "string" }, "subject": { "type": "string" } }, "required": [ "content", "subject" ] }, "CampaignCreateDto": { "type": "object", "properties": { "campaign": { "type": "string", "minLength": 1 }, "campaignLabel": { "type": "string", "minLength": 1 }, "visibilities": { "type": "array", "items": { "$ref": "#/components/schemas/VisibilityCampaignCreateDto" }, "minItems": 1 }, "communicationTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationTemplateCreateDto" } }, "referents": { "type": "array", "items": { "$ref": "#/components/schemas/ReferentDto" } }, "email": { "type": "string" }, "identificationConfiguration": { "type": "string", "enum": [ "IASCO", "HOUSEF2F", "HOUSETEL", "HOUSETELWSR", "INDF2F", "INDF2FNOR", "INDTEL", "INDTELNOR", "SRCVREINT", "NOIDENT" ] }, "contactOutcomeConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "contactAttemptConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "sensitivity": { "type": "boolean" }, "collectNextContacts": { "type": "boolean" } }, "required": [ "campaign", "campaignLabel", "visibilities" ] }, "CommunicationTemplateCreateDto": { "type": "object", "properties": { "meshuggahId": { "type": "string" }, "medium": { "type": "string", "enum": [ "LETTER", "EMAIL" ] }, "type": { "type": "string", "enum": [ "REMINDER", "NOTICE" ] } }, "required": [ "medium", "meshuggahId", "type" ] }, "VisibilityCampaignCreateDto": { "type": "object", "properties": { "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "organizationalUnit": { "type": "string", "minLength": 1 }, "useLetterCommunication": { "type": "boolean" }, "mail": { "type": "string" }, "tel": { "type": "string" } }, "required": [ "collectionEndDate", "collectionStartDate", "endDate", "identificationPhaseStartDate", "interviewerStartDate", "mail", "managementStartDate", "organizationalUnit", "tel", "useLetterCommunication" ] }, "CommunicationTemplateResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "campaignId": { "type": "string" }, "meshuggahId": { "type": "string" }, "medium": { "type": "string", "enum": [ "LETTER", "EMAIL" ] }, "type": { "type": "string", "enum": [ "REMINDER", "NOTICE" ] } } }, "SurveyUnitInterviewerResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } }, "address": { "$ref": "#/components/schemas/AddressDto" }, "priority": { "type": "boolean" }, "move": { "type": "boolean" }, "campaign": { "type": "string" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentDto" } }, "sampleIdentifiers": { "$ref": "#/components/schemas/SampleIdentifiersDto" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateDto" } }, "contactAttempts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactAttemptDto" } }, "contactOutcome": { "$ref": "#/components/schemas/ContactOutcomeDto" }, "identification": { "$ref": "#/components/schemas/IdentificationDto" }, "communicationTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationTemplateResponseDto" } }, "communicationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationRequestResponseDto" } }, "previousContactHistory": { "$ref": "#/components/schemas/PreviousContactHistoryDto" }, "nextContactHistory": { "$ref": "#/components/schemas/NextContactHistoryDto" } } }, "OngoingDto": { "type": "object", "properties": { "ongoing": { "type": "boolean" } } }, "SurveyUnitCommunicationResponse": { "type": "object", "properties": { "type": { "type": "string" }, "date": { "type": "integer", "format": "int64" }, "reason": { "type": "string" } } }, "SurveyUnitHistoryResponse": { "type": "object", "properties": { "surveyUnitId": { "type": "string" }, "surveyUnitDisplayName": { "type": "string" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitStateResponse" } }, "communications": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitCommunicationResponse" } } } }, "SurveyUnitStateResponse": { "type": "object", "properties": { "type": { "type": "string" }, "date": { "type": "integer", "format": "int64" } } }, "SurveyUnitToReviewPageResponse": { "type": "object", "properties": { "content": { "type": "array", "description": "List of survey units to review", "items": { "$ref": "#/components/schemas/SurveyUnitToReviewResponse" } }, "page": { "type": "integer", "format": "int32", "description": "Current page number", "example": 0 }, "size": { "type": "integer", "format": "int32", "description": "Number of items per page", "example": 20 }, "totalElements": { "type": "integer", "format": "int64", "description": "Total number of items", "example": 100 }, "totalPages": { "type": "integer", "format": "int32", "description": "Total number of pages", "example": 5 } } }, "SurveyUnitToReviewResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "Survey unit identifier", "example": "SU-12345" }, "surveyUnitDisplayName": { "type": "string", "description": "Survey unit display name", "example": "SU12345" }, "campaignLabel": { "type": "string", "description": "Campaign label", "example": "Campaign 2024" }, "contactOutcome": { "type": "string", "description": "Contact outcome", "example": "CONTACTED" }, "interviewerLabel": { "type": "string", "description": "Interviewer name", "example": "John Doe" }, "viewed": { "type": "boolean", "description": "Whether the survey unit has been viewed", "example": false }, "readOnlyUrl": { "type": "string", "description": "URL to view the survey unit in read-only mode", "example": "/read-only/SU-12345" }, "lastComment": { "type": "string", "description": "Last comment on the survey unit", "example": "Need to call back" } } }, "SurveyUnitToClose": { "type": "object", "properties": { "campaignLabel": { "type": "string" }, "surveyUnitId": { "type": "string" }, "surveyUnitDisplayName": { "type": "string" }, "interviewerLabel": { "type": "string" }, "ssech": { "type": "integer", "format": "int32" }, "identificationState": { "type": "string" }, "contactOutcome": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "DUU", "NUH", "DCD", "NOA" ] }, "questionnaireState": { "type": "string" }, "closingCause": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] } } }, "ClosableContactOutcomeDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "DUU", "NUH", "DCD", "NOA" ] } } }, "ClosableInterviewerDto": { "type": "object", "properties": { "interviewerFirstName": { "type": "string" }, "interviewerLastName": { "type": "string" } } }, "ClosableSurveyUnitDto": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "ssech": { "type": "integer", "format": "int32" }, "location": { "type": "string" }, "city": { "type": "string" }, "finalizationDate": { "type": "integer", "format": "int64" }, "campaign": { "type": "string" }, "closingCause": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] }, "state": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] }, "questionnaireState": { "type": "string" }, "contactOutcome": { "$ref": "#/components/schemas/ClosableContactOutcomeDto" }, "identificationState": { "type": "string", "enum": [ "MISSING", "FINISHED", "ONGOING" ] }, "interviewer": { "$ref": "#/components/schemas/ClosableInterviewerDto" } } }, "SurveyUnitAssignedPageResponse": { "type": "object", "properties": { "content": { "type": "array", "description": "List of survey units assigned", "items": { "$ref": "#/components/schemas/SurveyUnitAssignedResponse" } }, "page": { "type": "integer", "format": "int32", "description": "Current page number", "example": 0 }, "size": { "type": "integer", "format": "int32", "description": "Number of items per page", "example": 20 }, "totalElements": { "type": "integer", "format": "int64", "description": "Total number of items", "example": 100 }, "totalPages": { "type": "integer", "format": "int32", "description": "Total number of pages", "example": 5 } } }, "SurveyUnitAssignedResponse": { "type": "object", "properties": { "surveyUnitId": { "type": "string" }, "surveyUnitDisplayName": { "type": "string" }, "interviewerLabel": { "type": "string" }, "ssech": { "type": "string" }, "location": { "type": "string" }, "city": { "type": "string" }, "questionnaireState": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] }, "closingCause": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] } } }, "SurveyUnitStatesDto": { "type": "object", "properties": { "id": { "type": "string" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StateDto" } } } }, "CampaignProgressInterviewer": { "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignLabel": { "type": "string" }, "progressRate": { "type": "number", "format": "float" }, "states": { "$ref": "#/components/schemas/StatesInterviewerProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "CommunicationsProgress": { "type": "object", "properties": { "noticeLetter": { "type": "integer", "format": "int64" }, "reminderLetter": { "type": "integer", "format": "int64" } } }, "StatesInterviewerProgress": { "type": "object", "properties": { "allocatedInterviewers": { "type": "integer", "format": "int64" }, "notStarted": { "type": "integer", "format": "int64" }, "inProgress": { "type": "integer", "format": "int64" }, "pendingTransmission": { "type": "integer", "format": "int64" }, "toReview": { "type": "integer", "format": "int64" }, "validated": { "type": "integer", "format": "int64" }, "preparingContact": { "type": "integer", "format": "int64" }, "withContact": { "type": "integer", "format": "int64" }, "withAppointment": { "type": "integer", "format": "int64" }, "started": { "type": "integer", "format": "int64" } } }, "CampaignCollectionInterviewer": { "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignLabel": { "type": "string" }, "allocatedInterviewers": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "ClosingCausesProgress": { "type": "object", "properties": { "absenceInterviewer": { "type": "integer", "format": "int64" }, "otherReasons": { "type": "integer", "format": "int64" }, "totalClosed": { "type": "integer", "format": "int64" } } }, "CollectionRates": { "type": "object", "properties": { "collection": { "type": "number", "format": "float" }, "waste": { "type": "number", "format": "float" }, "outOfScope": { "type": "number", "format": "float" } } }, "ContactOutcomesProgress": { "type": "object", "properties": { "accepted": { "type": "integer", "format": "int64" }, "refused": { "type": "integer", "format": "int64" }, "unreachable": { "type": "integer", "format": "int64" }, "outOfScope": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "InterviewerCampaignsClosingCauses": { "type": "object", "properties": { "campaignLabel": { "type": "string" }, "allocated": { "type": "integer", "format": "int64" }, "closingCauses": { "$ref": "#/components/schemas/InterviewerCampaignsClosingCausesForSurveyUnit" } } }, "InterviewerCampaignsClosingCausesForSurveyUnit": { "type": "object", "properties": { "interviewerAbsence": { "type": "integer", "format": "int64" }, "notProcessedByInterviewer": { "type": "integer", "format": "int64" }, "exceptionalReason": { "type": "integer", "format": "int64" }, "rightOfWithdrawal": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "InterviewerCampaignsClosingCausesResponse": { "type": "object", "properties": { "interviewerCampaignSurveyUnits": { "type": "array", "items": { "$ref": "#/components/schemas/InterviewerCampaignsClosingCauses" } }, "interviewerCampaignsTotalSurveyUnit": { "$ref": "#/components/schemas/InterviewerCampaignsClosingCausesTotalSurveyUnit" } } }, "InterviewerCampaignsClosingCausesTotal": { "type": "object", "properties": { "interviewerAbsence": { "type": "integer", "format": "int64" }, "notProcessedByInterviewer": { "type": "integer", "format": "int64" }, "exceptionalReason": { "type": "integer", "format": "int64" }, "rightOfWithdrawal": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "InterviewerCampaignsClosingCausesTotalSurveyUnit": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "closingCauses": { "$ref": "#/components/schemas/InterviewerCampaignsClosingCausesTotal" } } }, "CampaignProgressByOrganizationUnits": { "type": "object", "properties": { "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignProgressByOrganizationUnitsOU" } }, "campaign": { "$ref": "#/components/schemas/CampaignProgressByOrganizationUnitsCampaign" } } }, "CampaignProgressByOrganizationUnitsCampaign": { "type": "object", "properties": { "progressRate": { "type": "number", "format": "float" }, "states": { "$ref": "#/components/schemas/StatesProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "CampaignProgressByOrganizationUnitsOU": { "type": "object", "properties": { "organizationUnitLabel": { "type": "string" }, "progressRate": { "type": "number", "format": "float" }, "states": { "$ref": "#/components/schemas/StatesProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "StatesProgress": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "notStarted": { "type": "integer", "format": "int64" }, "inProgress": { "type": "integer", "format": "int64" }, "pendingTransmission": { "type": "integer", "format": "int64" }, "toReview": { "type": "integer", "format": "int64" }, "validated": { "type": "integer", "format": "int64" }, "preparingContact": { "type": "integer", "format": "int64" }, "withContact": { "type": "integer", "format": "int64" }, "withAppointment": { "type": "integer", "format": "int64" }, "started": { "type": "integer", "format": "int64" } } }, "CampaignCollectionByOrganizationUnits": { "type": "object", "properties": { "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignCollectionByOrganizationUnitsOU" } }, "campaign": { "$ref": "#/components/schemas/CampaignCollectionByOrganizationUnitsCampaign" } } }, "CampaignCollectionByOrganizationUnitsCampaign": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "CampaignCollectionByOrganizationUnitsOU": { "type": "object", "properties": { "organizationUnitLabel": { "type": "string" }, "allocated": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "CampaignProgressByInterviewers": { "type": "object", "properties": { "interviewers": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignProgressByInterviewersInterviewer" } }, "site": { "$ref": "#/components/schemas/CampaignProgressByInterviewersOU" }, "campaign": { "$ref": "#/components/schemas/CampaignProgressByInterviewersCampaign" } } }, "CampaignProgressByInterviewersCampaign": { "type": "object", "properties": { "progressRate": { "type": "number", "format": "float" }, "states": { "$ref": "#/components/schemas/StatesProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "CampaignProgressByInterviewersInterviewer": { "type": "object", "properties": { "interviewerLabel": { "type": "string" }, "progressRate": { "type": "number", "format": "float" }, "states": { "$ref": "#/components/schemas/StatesProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "CampaignProgressByInterviewersOU": { "type": "object", "properties": { "progressRate": { "type": "number", "format": "float" }, "unaffected": { "type": "integer", "format": "int64" }, "states": { "$ref": "#/components/schemas/StatesProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "CampaignCollectionByInterviewers": { "type": "object", "properties": { "interviewers": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignCollectionByInterviewersInterviewer" } }, "site": { "$ref": "#/components/schemas/CampaignCollectionByInterviewersOU" }, "campaign": { "$ref": "#/components/schemas/CampaignCollectionByInterviewersCampaign" } } }, "CampaignCollectionByInterviewersCampaign": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "CampaignCollectionByInterviewersInterviewer": { "type": "object", "properties": { "interviewerLabel": { "type": "string" }, "allocated": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "CampaignCollectionByInterviewersOU": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "unaffected": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "CampaignClosingCausesByInterviewer": { "type": "object", "properties": { "interviewerId": { "type": "string" }, "interviewerLabel": { "type": "string" }, "surveyUnits": { "$ref": "#/components/schemas/CampaignClosingCausesByInterviewersSurveyUnits" } } }, "CampaignClosingCausesByInterviewerClosingCause": { "type": "object", "properties": { "interviewerAbsence": { "type": "integer", "format": "int64" }, "notProcessedByInterviewer": { "type": "integer", "format": "int64" }, "exceptionalReason": { "type": "integer", "format": "int64" }, "rightOfWithdrawal": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "CampaignClosingCausesByInterviewers": { "type": "object", "properties": { "interviewers": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignClosingCausesByInterviewer" } }, "total": { "$ref": "#/components/schemas/CampaignClosingCausesByInterviewersTotalInterviewers" } } }, "CampaignClosingCausesByInterviewersSurveyUnits": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "closingCauses": { "$ref": "#/components/schemas/CampaignClosingCausesByInterviewerClosingCause" } } }, "CampaignClosingCausesByInterviewersTotalInterviewer": { "type": "object", "properties": { "interviewerAbsence": { "type": "integer", "format": "int64" }, "notProcessedByInterviewer": { "type": "integer", "format": "int64" }, "exceptionalReason": { "type": "integer", "format": "int64" }, "rightOfWithdrawal": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "CampaignClosingCausesByInterviewersTotalInterviewers": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "closingCauses": { "$ref": "#/components/schemas/CampaignClosingCausesByInterviewersTotalInterviewer" } } }, "CampaignSummaryProgress": { "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignLabel": { "type": "string" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "campaignPhase": { "type": "string", "enum": [ "INITIAL_ASSIGNMENT", "COLLECTION_IN_PROGRESS", "COLLECTION_COMPLETED" ] }, "states": { "$ref": "#/components/schemas/StatesSummaryProgress" } } }, "StatesSummaryProgress": { "type": "object", "properties": { "allocated": { "type": "integer", "format": "int64" }, "toProcessInterviewer": { "type": "integer", "format": "int64" }, "toReview": { "type": "integer", "format": "int64" }, "completed": { "type": "integer", "format": "int64" }, "notAssigned": { "type": "integer", "format": "int64" } } }, "CampaignProgress": { "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignLabel": { "type": "string" }, "progressRate": { "type": "number", "format": "float" }, "states": { "$ref": "#/components/schemas/StatesProgress" }, "communications": { "$ref": "#/components/schemas/CommunicationsProgress" } } }, "CampaignCollection": { "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignLabel": { "type": "string" }, "allocated": { "type": "integer", "format": "int64" }, "rates": { "$ref": "#/components/schemas/CollectionRates" }, "outcomes": { "$ref": "#/components/schemas/ContactOutcomesProgress" }, "closingCauses": { "$ref": "#/components/schemas/ClosingCausesProgress" } } }, "InterviewerDto": { "type": "object", "properties": { "id": { "type": "string" }, "interviewerFirstName": { "type": "string" }, "interviewerLastName": { "type": "string" }, "surveyUnitCount": { "type": "integer", "format": "int64" } } }, "CampaignDto": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "email": { "type": "string" }, "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "allocated": { "type": "integer", "format": "int64" }, "toProcessInterviewer": { "type": "integer", "format": "int64" }, "toAffect": { "type": "integer", "format": "int64" }, "toFollowUp": { "type": "integer", "format": "int64" }, "toReview": { "type": "integer", "format": "int64" }, "finalized": { "type": "integer", "format": "int64" }, "identificationConfiguration": { "type": "string", "enum": [ "IASCO", "HOUSEF2F", "HOUSETEL", "HOUSETELWSR", "INDF2F", "INDF2FNOR", "INDTEL", "INDTELNOR", "SRCVREINT", "NOIDENT" ] }, "contactAttemptConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "contactOutcomeConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "collectNextContacts": { "type": "boolean" }, "referents": { "type": "array", "items": { "$ref": "#/components/schemas/ReferentDto" } }, "campaignStats": { "type": "array", "items": { "type": "array", "items": {} }, "writeOnly": true } } }, "StateCountDto": { "type": "object", "properties": { "idDem": { "type": "string" }, "labelDem": { "type": "string" }, "interviewer": { "$ref": "#/components/schemas/InterviewerContextDto" }, "campaign": { "$ref": "#/components/schemas/CampaignDto" }, "nvmCount": { "type": "integer", "format": "int64" }, "nnsCount": { "type": "integer", "format": "int64" }, "anvCount": { "type": "integer", "format": "int64" }, "vinCount": { "type": "integer", "format": "int64" }, "vicCount": { "type": "integer", "format": "int64" }, "prcCount": { "type": "integer", "format": "int64" }, "aocCount": { "type": "integer", "format": "int64" }, "apsCount": { "type": "integer", "format": "int64" }, "insCount": { "type": "integer", "format": "int64" }, "wftCount": { "type": "integer", "format": "int64" }, "wfsCount": { "type": "integer", "format": "int64" }, "tbrCount": { "type": "integer", "format": "int64" }, "finCount": { "type": "integer", "format": "int64" }, "cloCount": { "type": "integer", "format": "int64" }, "nvaCount": { "type": "integer", "format": "int64" }, "npaCount": { "type": "integer", "format": "int64" }, "npiCount": { "type": "integer", "format": "int64" }, "npxCount": { "type": "integer", "format": "int64" }, "rowCount": { "type": "integer", "format": "int64" }, "noticeCount": { "type": "integer", "format": "int64" }, "reminderCount": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "CampaignVisibilityPeriodDto": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "managementStartDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" } } }, "SurveyUnitDto": { "type": "object", "properties": { "id": { "type": "string" }, "campaign": { "type": "string" }, "campaignLabel": { "type": "string" }, "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "identificationConfiguration": { "type": "string", "enum": [ "IASCO", "HOUSEF2F", "HOUSETEL", "HOUSETELWSR", "INDF2F", "INDF2FNOR", "INDTEL", "INDTELNOR", "SRCVREINT", "NOIDENT" ] }, "contactOutcomeConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "contactAttemptConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "collectNextContacts": { "type": "boolean" }, "useLetterCommunication": { "type": "boolean" }, "persons": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDto" } }, "address": { "$ref": "#/components/schemas/AddressDto" } } }, "HabilitationDto": { "type": "object", "properties": { "habilitated": { "type": "boolean" } } }, "CampaignResponseDto": { "type": "object", "properties": { "id": { "type": "string" }, "campaign": { "type": "string" }, "campaignLabel": { "type": "string" }, "visibilities": { "type": "array", "items": { "$ref": "#/components/schemas/VisibilityCampaignDto" } }, "referents": { "type": "array", "items": { "$ref": "#/components/schemas/ReferentDto" } }, "email": { "type": "string" }, "identificationConfiguration": { "type": "string", "enum": [ "IASCO", "HOUSEF2F", "HOUSETEL", "HOUSETELWSR", "INDF2F", "INDF2FNOR", "INDTEL", "INDTELNOR", "SRCVREINT", "NOIDENT" ] }, "contactOutcomeConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "contactAttemptConfiguration": { "type": "string", "enum": [ "F2F", "TEL" ] }, "sensitivity": { "type": "boolean" } } }, "VisibilityCampaignDto": { "type": "object", "properties": { "organizationalUnit": { "type": "string" }, "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "useLetterCommunication": { "type": "boolean" }, "mail": { "type": "string" }, "tel": { "type": "string" } } }, "ContactOutcomeTypeCountDto": { "type": "object", "properties": { "idDem": { "type": "string" }, "labelDem": { "type": "string" }, "campaign": { "$ref": "#/components/schemas/CampaignDto" }, "inaCount": { "type": "integer", "format": "int64" }, "refCount": { "type": "integer", "format": "int64" }, "impCount": { "type": "integer", "format": "int64" }, "ucdCount": { "type": "integer", "format": "int64" }, "utrCount": { "type": "integer", "format": "int64" }, "alaCount": { "type": "integer", "format": "int64" }, "dcdCount": { "type": "integer", "format": "int64" }, "nuhCount": { "type": "integer", "format": "int64" }, "dukCount": { "type": "integer", "format": "int64" }, "duuCount": { "type": "integer", "format": "int64" }, "noaCount": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "CampaignPreferenceDto": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "preference": { "type": "boolean" } } }, "CampaignModel": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } } }, "CampaignSensitivityDto": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "sensitivity": { "type": "boolean" } }, "required": [ "id" ] }, "CampaignCommonsDto": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "campaignId": { "type": "string", "minLength": 1 }, "dataCollectionTarget": { "type": "string", "minLength": 1 }, "sensitivity": { "type": "boolean" }, "collectMode": { "type": "string", "minLength": 1 } }, "required": [ "campaignId", "collectMode", "dataCollectionTarget", "id", "sensitivity" ] }, "InterviewerCampaignDto": { "type": "object", "properties": { "id": { "type": "string" }, "interviewerFirstName": { "type": "string" }, "interviewerLastName": { "type": "string" } } }, "SurveyUnitCampaignContactOutcomeDto": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "DUU", "NUH", "DCD", "NOA" ] } } }, "SurveyUnitCampaignDto": { "type": "object", "properties": { "id": { "type": "string" }, "displayName": { "type": "string" }, "ssech": { "type": "integer", "format": "int32" }, "location": { "type": "string" }, "city": { "type": "string" }, "finalizationDate": { "type": "integer", "format": "int64" }, "closingCause": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] }, "contactOutcome": { "$ref": "#/components/schemas/SurveyUnitCampaignContactOutcomeDto" }, "state": { "type": "string", "enum": [ "NVM", "NNS", "ANV", "VIN", "VIC", "PRC", "AOC", "APS", "INS", "WFT", "WFS", "TBR", "FIN", "CLO", "NVA" ] }, "reading": { "type": "boolean" }, "viewed": { "type": "boolean" }, "interviewer": { "$ref": "#/components/schemas/InterviewerCampaignDto" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentDto" } } } }, "StateCountCampaignDto": { "type": "object", "properties": { "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/StateCountDto" } }, "france": { "$ref": "#/components/schemas/StateCountDto" } } }, "CountDto": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "ClosingCauseCountDto": { "type": "object", "properties": { "npiCount": { "type": "integer", "format": "int64" }, "npaCount": { "type": "integer", "format": "int64" }, "npxCount": { "type": "integer", "format": "int64" }, "rowCount": { "type": "integer", "format": "int64" }, "total": { "type": "integer", "format": "int64" } } }, "ContactOutcomeTypeCountCampaignDto": { "type": "object", "properties": { "organizationUnits": { "type": "array", "items": { "$ref": "#/components/schemas/ContactOutcomeTypeCountDto" } }, "france": { "$ref": "#/components/schemas/ContactOutcomeTypeCountDto" } } }, "SurveyUnitCompleted": { "type": "object", "properties": { "content": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyUnitCompletedResponse" } }, "page": { "type": "integer", "format": "int32", "description": "Current page number", "example": 0 }, "size": { "type": "integer", "format": "int32", "description": "Number of items per page", "example": 20 }, "totalElements": { "type": "integer", "format": "int64", "description": "Total number of items", "example": 100 }, "totalPages": { "type": "integer", "format": "int32", "description": "Total number of pages", "example": 5 } } }, "SurveyUnitCompletedResponse": { "type": "object", "properties": { "surveyUnitId": { "type": "string" }, "surveyUnitDisplayName": { "type": "string" }, "interviewerLabel": { "type": "string" }, "endDate": { "type": "string" }, "contactOutcome": { "type": "string", "enum": [ "INA", "REF", "IMP", "UCD", "UTR", "ALA", "DUK", "DUU", "NUH", "DCD", "NOA" ] }, "closingCauseType": { "type": "string", "enum": [ "NPA", "NPI", "NPX", "ROW" ] }, "viewed": { "type": "boolean" }, "readOnlyUrl": { "type": "string" }, "comment": { "type": "string" } } }, "InterviewerPortalDto": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "count": { "type": "integer", "format": "int32" } } }, "PortalDataDto": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "email": { "type": "string" }, "managementStartDate": { "type": "integer", "format": "int64" }, "interviewerStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "referents": { "type": "array", "items": { "$ref": "#/components/schemas/ReferentDto" } }, "interviewers": { "type": "array", "items": { "$ref": "#/components/schemas/InterviewerPortalDto" } }, "abandoned": { "type": "integer", "format": "int32" }, "unallocated": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "CampaignOrganization": { "type": "object", "properties": { "campaignId": { "type": "string" }, "campaignLabel": { "type": "string" }, "campaignEmail": { "type": "string" }, "managementStartDate": { "type": "integer", "format": "int64" }, "identificationPhaseStartDate": { "type": "integer", "format": "int64" }, "collectionStartDate": { "type": "integer", "format": "int64" }, "collectionEndDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" }, "phase": { "type": "string", "enum": [ "INITIAL_ASSIGNMENT", "COLLECTION_IN_PROGRESS", "COLLECTION_COMPLETED" ] }, "referents": { "type": "array", "items": { "$ref": "#/components/schemas/CampaignOrganizationReferent" } }, "interviewers": { "type": "array", "items": { "$ref": "#/components/schemas/UserOrganizationUnitsInterviewer" } }, "surveyUnits": { "$ref": "#/components/schemas/UserOrganizationUnitsSurveyUnitCount" } } }, "CampaignOrganizationReferent": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "role": { "type": "string" } } }, "UserOrganizationUnitsInterviewer": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "surveyUnits": { "type": "integer", "format": "int64" } } }, "UserOrganizationUnitsSurveyUnitCount": { "type": "object", "properties": { "totalSite": { "type": "integer", "format": "int64" }, "notAffected": { "type": "integer", "format": "int64" } } } }, "securitySchemes": { "oauth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "http://localhost:7080/realms/sabiane/protocol/openid-connect/auth", "tokenUrl": "http://localhost:7080/realms/sabiane/protocol/openid-connect/token", "refreshUrl": "http://localhost:7080/realms/sabiane/protocol/openid-connect/token", "scopes": {} } } } } } }