{ "swagger": "2.0", "info": { "version": "v1", "title": "Powalco.Services" }, "host": "services.powalco.be", "schemes": [ "https" ], "paths": { "/api/attachments/create/{id}": { "post": { "tags": [ "Attachments" ], "summary": "Add an attachment to an item", "operationId": "Attachments_Create", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "path", "description": "Item identifier", "required": true, "type": "integer", "format": "int32" }, { "name": "info", "in": "formData", "description": "Attachment info", "required": false, "schema": { "$ref": "#/definitions/AttachmentInfo" }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/attachments/createitemurl/{id}": { "post": { "tags": [ "Attachments" ], "summary": "Add an url attachment to an item", "operationId": "Attachments_CreateItemUrl", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "type": "integer", "format": "int32" }, { "name": "itemUrls", "in": "body", "description": "ItemUrls collection", "required": true, "schema": { "$ref": "#/definitions/CreateUrlAttachmentParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Attachments/GetAttachments": { "post": { "tags": [ "Attachments" ], "summary": "Get attachments", "operationId": "Attachments_GetAttachments", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetAttachmentsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/SiteAttachmentsResponse" } } } } } }, "/api/Authorization/Introspect": { "get": { "tags": [ "Authorization" ], "summary": "OAuth introspection", "operationId": "Authorization_Introspect", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "token", "in": "query", "description": "Site or organisation token", "required": true, "type": "string" }, { "name": "uuid", "in": "query", "description": "Site or organisation uuid", "required": false, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IntrospectResponse" } } } } }, "/api/Authorization/GetToken": { "get": { "tags": [ "Authorization" ], "summary": "Get a session token for API calls on organisations or sites", "operationId": "Authorization_GetToken", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "type", "in": "query", "description": "Session token type", "required": true, "type": "string", "enum": [ "Organisation", "Site" ] }, { "name": "id", "in": "query", "description": "Sub-organisation name or site Powalco ID", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetTokenResponse" } } } } }, "/api/da/create": { "post": { "tags": [ "AuthorizationDossier" ], "summary": "Create a DA", "operationId": "AuthorizationDossier_Create", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Initiated", "Validation", "Instruction", "Decision", "Advice", "Meeting", "DecisionDelayed", "OnHold", "Authorized", "PartAuthorized", "Refused", "RefusedDefault", "Appeal", "AppealRefused", "AppealPartAuthorized", "AppealAuthorized", "ExtendedAuthorization", "AuthorizationExpired", "AuthorizationExpiredFinal", "ConfirmedRefused", "ConfirmedPartAuthorized", "ConfirmedAuthorized", "Closed", "Canceled" ], "type": "string" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "CancelDate": { "format": "date-time", "description": "Annulé", "type": "string" }, "SendDAtoGCCActual": { "format": "date-time", "description": "Pour validation (T7)", "type": "string" }, "SendDAtoGCCDue": { "format": "date-time", "description": "Date limite de Pour validation (T7)", "type": "string" }, "RemarksGCCActual": { "format": "date-time", "description": "Remarques de validation (T8)", "type": "string" }, "RemarksGCCDue": { "format": "date-time", "description": "Date limite de Remarques de validation (T8)", "type": "string" }, "SendToGDVCompetentActual": { "format": "date-time", "description": "Demande d'autorisation (T9)", "type": "string" }, "SendToGDVCompetentDue": { "format": "date-time", "description": "Date limite de Demande d'autorisation (T9)", "type": "string" }, "AcceptDAbyGDVActual": { "format": "date-time", "description": "Accusé de réception (T10)", "type": "string" }, "AcceptDAbyGDVDue": { "format": "date-time", "description": "Date limite d'accusé de réception (T10)", "type": "string" }, "TransferDate": { "format": "date-time", "description": "Transfert", "type": "string" }, "ExtraInfoDate": { "format": "date-time", "description": "Demandes complémentaires", "type": "string" }, "SendToOtherGDVActual": { "format": "date-time", "description": "Pour avis (T11)", "type": "string" }, "SendToOtherGDVDue": { "format": "date-time", "description": "Date limite de Pour avis (T11)", "type": "string" }, "RemarksOtherGDVActual": { "format": "date-time", "description": "Avis (T12)", "type": "string" }, "RemarksOtherGDVDue": { "format": "date-time", "description": "Date limite d'Avis (T12)", "type": "string" }, "MeetingAllGDVActual": { "format": "date-time", "description": "Pour réunion (T13)", "type": "string" }, "MeetingAllGDVDue": { "format": "date-time", "description": "Date limite de Pour réunion (T13)", "type": "string" }, "AnswerGDVtoPilotActual": { "format": "date-time", "description": "Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDelayActual": { "format": "date-time", "description": "Décision d'autorisation (T14\")", "type": "string" }, "AnswerGDVtoPilotDelayDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14\")", "type": "string" }, "ReminderDecisionDate": { "format": "date-time", "description": "Date limite de Rappel (T15)", "type": "string" }, "ProlongationActual": { "format": "date-time", "description": "Demande de prolongation (T16')", "type": "string" }, "ProlongationDue": { "format": "date-time", "description": "Date limite de Demande de prolongation (T16')", "type": "string" }, "ProlongationAuthorisationActual": { "format": "date-time", "description": "Prolongation (T17)", "type": "string" }, "ProlongationAuthorisationDue": { "format": "date-time", "description": "Date limite de Prolongation (T17)", "type": "string" }, "ExpiredAuthorisationActual": { "format": "date-time", "description": "Péremption (T18)", "type": "string" }, "ExpiredAuthorisationDue": { "format": "date-time", "description": "Date limite de Péremption (T18)", "type": "string" }, "RecoursActual": { "format": "date-time", "description": "Recours (T19)", "type": "string" }, "RecoursDue": { "format": "date-time", "description": "Date limite de Recours (T19)", "type": "string" }, "DecisionRecoursActual": { "format": "date-time", "description": "Décision de recours (T21)", "type": "string" }, "DecisionRecoursDue": { "format": "date-time", "description": "Date limite de Décision de recours (T21)", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Organisation": { "description": "Organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Id of Organisation", "type": "integer" }, "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "Email": { "description": "Email", "type": "string" }, "Gender": { "description": "Gender", "enum": [ "None", "Male", "Female" ], "type": "string" }, "Telephone": { "description": "Telephone", "type": "string" }, "Function": { "description": "Function", "type": "string" }, "Street": { "description": "Street", "type": "string" }, "Number": { "description": "Number", "type": "string" }, "City": { "description": "City", "type": "string" }, "Zip": { "description": "Zip", "type": "string" }, "FirstNameGDV": { "description": "FirstNameGDV", "type": "string" }, "LastNameGDV": { "description": "LastNameGDV", "type": "string" }, "EmailGDV": { "description": "EmailGDV", "type": "string" }, "GenderGDV": { "description": "GenderGDV", "enum": [ "None", "Male", "Female" ], "type": "string" }, "TelephoneGDV": { "description": "TelephoneGDV", "type": "string" }, "FunctionGDV": { "description": "FunctionGDV", "type": "string" }, "StreetGDV": { "description": "StreetGDV", "type": "string" }, "NumberGDV": { "description": "NumberGDV", "type": "string" }, "ZipGDV": { "description": "ZipGDV", "type": "string" }, "CityGDV": { "description": "CityGDV", "type": "string" }, "InternalRef": { "description": "Référence interne gestionnaire", "type": "string" }, "FreezeDuration": { "description": "Durée de validité de la zone gelée", "enum": [ "None", "TwoYears", "FiveYears" ], "type": "string" }, "RejectReason": { "description": "Raison du refus", "enum": [ "None", "NoReply", "Safety", "Health", "Mobility", "Viability" ], "type": "string" }, "RejectComments": { "description": "Commentaires sur la raison du refus", "type": "string" }, "Comments": { "description": "Commentaires", "type": "string" }, "DemandeAvisReject": { "description": "Commentaires de notifications", "type": "string" }, "ContactPerson": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ContactPersonGDV": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ConditionsPartAuthorized": { "description": "Conditions particulières d'autorisation", "type": "string" }, "AuthorizationAttached": { "description": "Document d'autorisation annexé", "type": "boolean" }, "ExtraWorkReason": { "description": "Raison de demande complémentaire", "type": "string" }, "AnswerExtraRequest": { "description": "Réponse sur la demande complémentaire", "type": "string" }, "InTransfer": { "description": "In transfer", "type": "boolean" } } } } } } } } }, "/api/da/get": { "get": { "tags": [ "AuthorizationDossier" ], "summary": "Get DA fields", "operationId": "AuthorizationDossier_Get", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Initiated", "Validation", "Instruction", "Decision", "Advice", "Meeting", "DecisionDelayed", "OnHold", "Authorized", "PartAuthorized", "Refused", "RefusedDefault", "Appeal", "AppealRefused", "AppealPartAuthorized", "AppealAuthorized", "ExtendedAuthorization", "AuthorizationExpired", "AuthorizationExpiredFinal", "ConfirmedRefused", "ConfirmedPartAuthorized", "ConfirmedAuthorized", "Closed", "Canceled" ], "type": "string" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "CancelDate": { "format": "date-time", "description": "Annulé", "type": "string" }, "SendDAtoGCCActual": { "format": "date-time", "description": "Pour validation (T7)", "type": "string" }, "SendDAtoGCCDue": { "format": "date-time", "description": "Date limite de Pour validation (T7)", "type": "string" }, "RemarksGCCActual": { "format": "date-time", "description": "Remarques de validation (T8)", "type": "string" }, "RemarksGCCDue": { "format": "date-time", "description": "Date limite de Remarques de validation (T8)", "type": "string" }, "SendToGDVCompetentActual": { "format": "date-time", "description": "Demande d'autorisation (T9)", "type": "string" }, "SendToGDVCompetentDue": { "format": "date-time", "description": "Date limite de Demande d'autorisation (T9)", "type": "string" }, "AcceptDAbyGDVActual": { "format": "date-time", "description": "Accusé de réception (T10)", "type": "string" }, "AcceptDAbyGDVDue": { "format": "date-time", "description": "Date limite d'accusé de réception (T10)", "type": "string" }, "TransferDate": { "format": "date-time", "description": "Transfert", "type": "string" }, "ExtraInfoDate": { "format": "date-time", "description": "Demandes complémentaires", "type": "string" }, "SendToOtherGDVActual": { "format": "date-time", "description": "Pour avis (T11)", "type": "string" }, "SendToOtherGDVDue": { "format": "date-time", "description": "Date limite de Pour avis (T11)", "type": "string" }, "RemarksOtherGDVActual": { "format": "date-time", "description": "Avis (T12)", "type": "string" }, "RemarksOtherGDVDue": { "format": "date-time", "description": "Date limite d'Avis (T12)", "type": "string" }, "MeetingAllGDVActual": { "format": "date-time", "description": "Pour réunion (T13)", "type": "string" }, "MeetingAllGDVDue": { "format": "date-time", "description": "Date limite de Pour réunion (T13)", "type": "string" }, "AnswerGDVtoPilotActual": { "format": "date-time", "description": "Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDelayActual": { "format": "date-time", "description": "Décision d'autorisation (T14\")", "type": "string" }, "AnswerGDVtoPilotDelayDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14\")", "type": "string" }, "ReminderDecisionDate": { "format": "date-time", "description": "Date limite de Rappel (T15)", "type": "string" }, "ProlongationActual": { "format": "date-time", "description": "Demande de prolongation (T16')", "type": "string" }, "ProlongationDue": { "format": "date-time", "description": "Date limite de Demande de prolongation (T16')", "type": "string" }, "ProlongationAuthorisationActual": { "format": "date-time", "description": "Prolongation (T17)", "type": "string" }, "ProlongationAuthorisationDue": { "format": "date-time", "description": "Date limite de Prolongation (T17)", "type": "string" }, "ExpiredAuthorisationActual": { "format": "date-time", "description": "Péremption (T18)", "type": "string" }, "ExpiredAuthorisationDue": { "format": "date-time", "description": "Date limite de Péremption (T18)", "type": "string" }, "RecoursActual": { "format": "date-time", "description": "Recours (T19)", "type": "string" }, "RecoursDue": { "format": "date-time", "description": "Date limite de Recours (T19)", "type": "string" }, "DecisionRecoursActual": { "format": "date-time", "description": "Décision de recours (T21)", "type": "string" }, "DecisionRecoursDue": { "format": "date-time", "description": "Date limite de Décision de recours (T21)", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Organisation": { "description": "Organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Id of Organisation", "type": "integer" }, "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "Email": { "description": "Email", "type": "string" }, "Gender": { "description": "Gender", "enum": [ "None", "Male", "Female" ], "type": "string" }, "Telephone": { "description": "Telephone", "type": "string" }, "Function": { "description": "Function", "type": "string" }, "Street": { "description": "Street", "type": "string" }, "Number": { "description": "Number", "type": "string" }, "City": { "description": "City", "type": "string" }, "Zip": { "description": "Zip", "type": "string" }, "FirstNameGDV": { "description": "FirstNameGDV", "type": "string" }, "LastNameGDV": { "description": "LastNameGDV", "type": "string" }, "EmailGDV": { "description": "EmailGDV", "type": "string" }, "GenderGDV": { "description": "GenderGDV", "enum": [ "None", "Male", "Female" ], "type": "string" }, "TelephoneGDV": { "description": "TelephoneGDV", "type": "string" }, "FunctionGDV": { "description": "FunctionGDV", "type": "string" }, "StreetGDV": { "description": "StreetGDV", "type": "string" }, "NumberGDV": { "description": "NumberGDV", "type": "string" }, "ZipGDV": { "description": "ZipGDV", "type": "string" }, "CityGDV": { "description": "CityGDV", "type": "string" }, "InternalRef": { "description": "Référence interne gestionnaire", "type": "string" }, "FreezeDuration": { "description": "Durée de validité de la zone gelée", "enum": [ "None", "TwoYears", "FiveYears" ], "type": "string" }, "RejectReason": { "description": "Raison du refus", "enum": [ "None", "NoReply", "Safety", "Health", "Mobility", "Viability" ], "type": "string" }, "RejectComments": { "description": "Commentaires sur la raison du refus", "type": "string" }, "Comments": { "description": "Commentaires", "type": "string" }, "DemandeAvisReject": { "description": "Commentaires de notifications", "type": "string" }, "ContactPerson": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ContactPersonGDV": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ConditionsPartAuthorized": { "description": "Conditions particulières d'autorisation", "type": "string" }, "AuthorizationAttached": { "description": "Document d'autorisation annexé", "type": "boolean" }, "ExtraWorkReason": { "description": "Raison de demande complémentaire", "type": "string" }, "AnswerExtraRequest": { "description": "Réponse sur la demande complémentaire", "type": "string" }, "InTransfer": { "description": "In transfer", "type": "boolean" } } } } } } } } }, "/api/da/getdasdata": { "post": { "tags": [ "AuthorizationDossier" ], "summary": "Get DAs fields", "operationId": "AuthorizationDossier_GetDAsData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetDAsFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/da/update": { "post": { "tags": [ "AuthorizationDossier" ], "summary": "Update DA fields", "operationId": "AuthorizationDossier_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "fields", "in": "formData", "description": "Dossier fields", "required": false, "schema": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Initiated", "Validation", "Instruction", "Decision", "Advice", "Meeting", "DecisionDelayed", "OnHold", "Authorized", "PartAuthorized", "Refused", "RefusedDefault", "Appeal", "AppealRefused", "AppealPartAuthorized", "AppealAuthorized", "ExtendedAuthorization", "AuthorizationExpired", "AuthorizationExpiredFinal", "ConfirmedRefused", "ConfirmedPartAuthorized", "ConfirmedAuthorized", "Closed", "Canceled" ], "type": "string" }, "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "Email": { "description": "Email", "type": "string" }, "Gender": { "description": "Gender", "enum": [ "None", "Male", "Female" ], "type": "string" }, "Telephone": { "description": "Telephone", "type": "string" }, "Function": { "description": "Function", "type": "string" }, "Street": { "description": "Street", "type": "string" }, "Number": { "description": "Number", "type": "string" }, "City": { "description": "City", "type": "string" }, "Zip": { "description": "Zip", "type": "string" }, "FirstNameGDV": { "description": "FirstNameGDV", "type": "string" }, "LastNameGDV": { "description": "LastNameGDV", "type": "string" }, "EmailGDV": { "description": "EmailGDV", "type": "string" }, "GenderGDV": { "description": "GenderGDV", "enum": [ "None", "Male", "Female" ], "type": "string" }, "TelephoneGDV": { "description": "TelephoneGDV", "type": "string" }, "FunctionGDV": { "description": "FunctionGDV", "type": "string" }, "StreetGDV": { "description": "StreetGDV", "type": "string" }, "NumberGDV": { "description": "NumberGDV", "type": "string" }, "ZipGDV": { "description": "ZipGDV", "type": "string" }, "CityGDV": { "description": "CityGDV", "type": "string" }, "InternalRef": { "description": "Référence interne gestionnaire", "type": "string" }, "FreezeDuration": { "description": "Durée de validité de la zone gelée", "enum": [ "None", "TwoYears", "FiveYears" ], "type": "string" }, "RejectReason": { "description": "Raison du refus", "enum": [ "None", "NoReply", "Safety", "Health", "Mobility", "Viability" ], "type": "string" }, "RejectComments": { "description": "Commentaires sur la raison du refus", "type": "string" }, "Comments": { "description": "Commentaires", "type": "string" }, "DemandeAvisReject": { "description": "Commentaires de notifications", "type": "string" }, "ContactPerson": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ContactPersonGDV": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ConditionsPartAuthorized": { "description": "Conditions particulières d'autorisation", "type": "string" }, "AuthorizationAttached": { "description": "Document d'autorisation annexé", "type": "boolean" }, "ExtraWorkReason": { "description": "Raison de demande complémentaire", "type": "string" }, "AnswerExtraRequest": { "description": "Réponse sur la demande complémentaire", "type": "string" }, "InTransfer": { "description": "In transfer", "type": "boolean" } } }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": false, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateResponse" } } } } }, "/api/da/getdossiers": { "get": { "tags": [ "AuthorizationDossier" ], "summary": "Get sites for applicable DA", "operationId": "AuthorizationDossier_GetApplicable", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ApplicableAuthDossierResponse" } } } } } }, "/api/da/reply": { "post": { "tags": [ "AuthorizationDossier" ], "summary": "Reply authorization request", "operationId": "AuthorizationDossier_Reply", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "reply", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RequestReplyParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/da/getgdvs": { "get": { "tags": [ "AuthorizationDossier" ], "summary": "Get DA GDV concerne", "operationId": "AuthorizationDossier_GetGdvs", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ImpactedGDV" } } } } } }, "/api/da/setgdvcompetent": { "post": { "tags": [ "AuthorizationDossier" ], "summary": "Set competent gdv for da", "operationId": "AuthorizationDossier_SetGdvCompetent", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "query", "description": "Competent organisation id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/da/sendtogdv": { "post": { "tags": [ "AuthorizationDossier" ], "summary": "SendToGDV request", "operationId": "AuthorizationDossier_SendToGdv", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/dac/create": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Create a DAC", "operationId": "CoordinationDossier_Create", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Started", "Ongoing", "EnvoiPilote", "Coordination", "NoCoordination", "Closed", "Canceled" ], "type": "string" }, "StartDate": { "format": "date-time", "description": "Date début de chantier", "type": "string" }, "EndDate": { "format": "date-time", "description": "Date fin de chantier", "type": "string" }, "OrganisationsParticipants": { "description": "Organisations participants" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "CancelDate": { "format": "date-time", "description": "Annulé", "type": "string" }, "StartDateDAC": { "format": "date-time", "description": "Appel (T2)", "type": "string" }, "LastReplyActual": { "format": "date-time", "description": "Réponse à l'appel (T3)", "type": "string" }, "LastReplyDue": { "format": "date-time", "description": "Date limite de réponse à l'appel (T3)", "type": "string" }, "MeetingActual": { "format": "date-time", "description": "Dernière réunion de coordination (T4')", "type": "string" }, "MeetingDue": { "format": "date-time", "description": "Date limite de dernière réunion de coordination (T4')", "type": "string" }, "PvfSendActual": { "format": "date-time", "description": "PV final (T5)", "type": "string" }, "PvfSendDue": { "format": "date-time", "description": "Date limite de PV final (T5)", "type": "string" }, "PvfCommentsActual": { "format": "date-time", "description": "Remarques PV final (T6)", "type": "string" }, "PvfCommentsDue": { "format": "date-time", "description": "Date limite des remarques PV final (T6)", "type": "string" }, "PilotDate": { "format": "date-time", "description": "Invitation pilote", "type": "string" }, "PilotRefused": { "format": "date-time", "description": "Refus de Pilotage", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Responsible": { "format": "int32", "description": "Responsable de dossier", "type": "integer" }, "PendingInvitations": { "format": "int32", "description": "Invitations en cours", "type": "integer" }, "NameCCC": { "description": "Nom", "type": "string" }, "DescriptionCCC": { "description": "Description", "type": "string" }, "PilotOrganisation": { "description": "Organisation pilote", "type": "string" }, "PilotOrganisationID": { "format": "int32", "description": "Id of PilotOrganisation", "type": "integer" }, "PilotContact": { "format": "int32", "description": "Contact organisation pilote", "type": "integer" }, "DatesQualif": { "description": "Qualificatif des dates", "enum": [ "None", "Prevision", "Realisation" ], "type": "string" }, "InternalReference": { "description": "Ref. Interne", "type": "string" }, "SiteDuration": { "format": "int32", "description": "Estimation des travaux en jours ouvrables", "type": "integer" } } } } } } } } }, "/api/dac/get": { "get": { "tags": [ "CoordinationDossier" ], "summary": "Get DAC fields", "operationId": "CoordinationDossier_Get", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Started", "Ongoing", "EnvoiPilote", "Coordination", "NoCoordination", "Closed", "Canceled" ], "type": "string" }, "StartDate": { "format": "date-time", "description": "Date début de chantier", "type": "string" }, "EndDate": { "format": "date-time", "description": "Date fin de chantier", "type": "string" }, "OrganisationsParticipants": { "description": "Organisations participants" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "CancelDate": { "format": "date-time", "description": "Annulé", "type": "string" }, "StartDateDAC": { "format": "date-time", "description": "Appel (T2)", "type": "string" }, "LastReplyActual": { "format": "date-time", "description": "Réponse à l'appel (T3)", "type": "string" }, "LastReplyDue": { "format": "date-time", "description": "Date limite de réponse à l'appel (T3)", "type": "string" }, "MeetingActual": { "format": "date-time", "description": "Dernière réunion de coordination (T4')", "type": "string" }, "MeetingDue": { "format": "date-time", "description": "Date limite de dernière réunion de coordination (T4')", "type": "string" }, "PvfSendActual": { "format": "date-time", "description": "PV final (T5)", "type": "string" }, "PvfSendDue": { "format": "date-time", "description": "Date limite de PV final (T5)", "type": "string" }, "PvfCommentsActual": { "format": "date-time", "description": "Remarques PV final (T6)", "type": "string" }, "PvfCommentsDue": { "format": "date-time", "description": "Date limite des remarques PV final (T6)", "type": "string" }, "PilotDate": { "format": "date-time", "description": "Invitation pilote", "type": "string" }, "PilotRefused": { "format": "date-time", "description": "Refus de Pilotage", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Responsible": { "format": "int32", "description": "Responsable de dossier", "type": "integer" }, "PendingInvitations": { "format": "int32", "description": "Invitations en cours", "type": "integer" }, "NameCCC": { "description": "Nom", "type": "string" }, "DescriptionCCC": { "description": "Description", "type": "string" }, "PilotOrganisation": { "description": "Organisation pilote", "type": "string" }, "PilotOrganisationID": { "format": "int32", "description": "Id of PilotOrganisation", "type": "integer" }, "PilotContact": { "format": "int32", "description": "Contact organisation pilote", "type": "integer" }, "DatesQualif": { "description": "Qualificatif des dates", "enum": [ "None", "Prevision", "Realisation" ], "type": "string" }, "InternalReference": { "description": "Ref. Interne", "type": "string" }, "SiteDuration": { "format": "int32", "description": "Estimation des travaux en jours ouvrables", "type": "integer" } } } } } } } } }, "/api/dac/getdacsdata": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Get DACs fields", "operationId": "CoordinationDossier_GetDACsData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetDACsFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/dac/getcccsdata": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Get CCCs fields", "operationId": "CoordinationDossier_GetCCCsData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCCCsFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/dac/update": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Update DAC fields", "operationId": "CoordinationDossier_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "fields", "in": "formData", "description": "Dossier fields", "required": false, "schema": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Started", "Ongoing", "EnvoiPilote", "Coordination", "NoCoordination", "Closed", "Canceled" ], "type": "string" }, "StartDate": { "format": "date-time", "description": "Date début de chantier", "type": "string" }, "EndDate": { "format": "date-time", "description": "Date fin de chantier", "type": "string" }, "OrganisationsParticipants": { "description": "Organisations participants" }, "NameCCC": { "description": "Nom", "type": "string" }, "DescriptionCCC": { "description": "Description", "type": "string" }, "PilotContact": { "format": "int32", "description": "Contact organisation pilote", "type": "integer" }, "DatesQualif": { "description": "Qualificatif des dates", "enum": [ "None", "Prevision", "Realisation" ], "type": "string" }, "InternalReference": { "description": "Ref. Interne", "type": "string" }, "SiteDuration": { "format": "int32", "description": "Estimation des travaux en jours ouvrables", "type": "integer" } } }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": false, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateResponse" } } } } }, "/api/dac/getinvitations": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Get DAC invitations", "operationId": "CoordinationDossier_GetInvitations", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "organisations", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invitation" } } } } } }, "/api/dac/getorginvitations": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Get invitations for issuer organisation", "operationId": "CoordinationDossier_GetOrgInvitations", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Invitation" } } } } } }, "/api/dac/getccc": { "get": { "tags": [ "CoordinationDossier" ], "summary": "Get CCC fields", "operationId": "CoordinationDossier_GetCCC", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "CCC fields", "type": "object", "properties": { "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" }, "CreatedOn": { "format": "date-time", "description": "CreatedOn", "type": "string" }, "UpdatedOn": { "format": "date-time", "description": "UpdatedOn", "type": "string" }, "ZcExists": { "description": "ZC exists", "type": "boolean" }, "ZpExists": { "description": "ZP exists", "type": "boolean" }, "ZcccExists": { "description": "ZCCC exists", "type": "boolean" }, "ProposedFlux": { "description": "Flux proposé", "enum": [ "None", "InformationJPlus1", "InformationJMinus5", "SimpleAuthorization", "Coordination", "Programmation" ], "type": "string" }, "ProposedFluxCopy": { "description": "ProposedFluxCopy", "enum": [ "None", "InformationJPlus1", "InformationJMinus5", "SimpleAuthorization", "Coordination", "Programmation" ], "type": "string" }, "Reason": { "description": "Raison", "type": "string" }, "AssociateSite": { "description": "Confirmation d'association", "type": "boolean" }, "IsProject": { "description": "Projet", "type": "boolean" }, "MandatedSocieties": { "description": "Société Mandatée" }, "IsPlansReadyActual": { "description": "Plans de récolement prêts", "type": "boolean" }, "KlimRequestId": { "description": "Klim request id" }, "KlimRequestLink": { "description": "Klim request link", "type": "string" }, "KlimRequestStatusUpdated": { "format": "date-time", "description": "Klim request status updated", "type": "string" }, "KlimRequestStatus": { "description": "Klim request status", "enum": [ "None", "WorkZoneDrawn", "Canceled", "Completed", "Published", "Abandoned", "WorkFlowStarted", "PartiallyConfirmed", "Finished" ], "type": "string" }, "KlimPlanRequestNotif": { "description": "Demande de Correctif", "type": "boolean" }, "IntersectSiteZG": { "description": "Intersection entre le chantier et une zone gelée", "type": "boolean" }, "OrganisationsSummary": { "description": "Organisations summary" }, "GdvCurrentCompetent": { "description": "GDV compétent organisation", "type": "string" }, "GdvCurrentCompetentID": { "format": "int32", "description": "Id of GdvCurrentCompetent", "type": "integer" }, "ButtonsChangeDates": { "description": "ButtonsChangeDates" }, "Type": { "description": "Type", "enum": [ "None", "Initial", "Associated", "Coordination", "Project" ], "type": "string" }, "StartDateFrozen": { "format": "date-time", "description": "Début de validé de la ZP Gelée", "type": "string" }, "EndDateFrozen": { "format": "date-time", "description": "Fin de validé de la ZP Gelée", "type": "string" }, "FrozenStatus": { "description": "Statut ZG", "enum": [ "none", "future", "active", "inactive", "canceled" ], "type": "string" }, "DateLastModified": { "format": "date-time", "description": "Dernière modification des dates", "type": "string" }, "DatesQualif": { "description": "Qualificatif des dates", "enum": [ "None", "Prevision", "Realisation" ], "type": "string" }, "ZonesModified": { "format": "date-time", "description": "Date de dernière modification des zones", "type": "string" }, "WorkTypes": { "description": "Type de travaux" }, "OtherWorkTypeComment": { "description": "Commentaires autre type de travaux", "type": "string" }, "Fluids": { "description": "Fluide" }, "LastUpdatedZc": { "format": "date-time", "description": "Date de dernière modification de la \"Zone d'ouverture du chantier\" (ZC)", "type": "string" }, "LastUpdatedZp": { "format": "date-time", "description": "Date de dernière modification de la \"Zone d'ouverture du périmètre\" (ZP)", "type": "string" }, "WorkDescription": { "description": "Description détaillée des travaux", "type": "string" }, "Constraints": { "description": "Contraintes internes et externes", "type": "string" }, "ArchElements": { "description": "Eléments architecturaux", "type": "string" }, "Name": { "description": "Nom du chantier", "type": "string" }, "Duration": { "format": "int32", "description": "Durée des travaux", "type": "integer" }, "InternalReference": { "description": "Ref. Interne", "type": "string" }, "ImpactedOrganisations": { "description": "Organisations impactées" }, "ImpactedStreets": { "description": "Rues impactées" }, "ImpactedCommunes": { "description": "ImpactedCommunes" }, "ContactPerson": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ContactPersonExec": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "Waranty": { "description": "Cautionnement chantier", "type": "boolean" }, "IsCleaned": { "description": "Сhantier nettoyé par Powalco", "type": "boolean" }, "CreatorFirstName": { "description": "CreatorFirstName", "type": "string" }, "CreatorLastName": { "description": "CreatorLastName", "type": "string" }, "CreatorEmail": { "description": "CreatorEmail", "type": "string" }, "CreatorPhone": { "description": "CreatorPhone", "type": "string" }, "StartDate": { "format": "date-time", "description": "Date début de chantier", "type": "string" }, "EndDate": { "format": "date-time", "description": "Date fin de chantier", "type": "string" }, "Zip": { "description": "Code postal", "type": "string" }, "City": { "description": "Commune", "type": "string" }, "Locality": { "description": "Localité", "type": "string" }, "Street": { "description": "Rue", "type": "string" }, "Number": { "description": "Numéro", "type": "string" }, "X": { "description": "Coordonnée X" }, "Y": { "description": "Coordonnée Y" }, "MinX": { "description": "Min X" }, "MaxX": { "description": "Max X" }, "MinY": { "description": "Min Y" }, "MaxY": { "description": "Max Y" }, "ContactGender": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "ContactLastName": { "description": "Nom", "type": "string" }, "ContactFirstName": { "description": "Prénom", "type": "string" }, "ContactFunction": { "description": "Fonction", "type": "string" }, "ContactTelephone": { "description": "Téléphone", "type": "string" }, "ContactEmail": { "description": "Adresse email", "type": "string" }, "ContactAddress": { "description": "Adresse postale", "type": "string" }, "ContactGenderExec": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "ContactLastNameExec": { "description": "Nom", "type": "string" }, "ContactFirstNameExec": { "description": "Prénom", "type": "string" }, "ContactFunctionExec": { "description": "Fonction", "type": "string" }, "ContactTelephoneExec": { "description": "Téléphone", "type": "string" }, "ContactEmailExec": { "description": "Adresse email", "type": "string" }, "ContactAddressExec": { "description": "Adresse postale", "type": "string" }, "Phasing": { "description": "Phasage", "type": "string" }, "UrgentDispenses": { "description": "Travaux urgents", "enum": [ "None", "Yes", "No" ], "type": "string" }, "JusticeDepenses": { "description": "Décision de justice", "enum": [ "None", "Yes", "No" ], "type": "string" }, "CEEDispenses": { "description": "Mise en demeure CEE", "enum": [ "None", "Yes", "No" ], "type": "string" }, "DomPubliqueDispenses": { "description": "Ouverture du domaine public", "enum": [ "None", "Yes", "No" ], "type": "string" }, "VoiriesDispenses": { "description": "Renouvellement de voiries", "enum": [ "None", "Yes", "No" ], "type": "string" }, "EntretienDispenses": { "description": "Entretien des voies navigables", "enum": [ "None", "Yes", "No" ], "type": "string" }, "CirculationDispenses": { "description": "Ouverture des voies de circulation", "enum": [ "None", "Yes", "No" ], "type": "string" }, "StrategiqueDispenses": { "description": "Inscrit dans le plan stratégique, budget, programme d'investissement", "enum": [ "None", "Yes", "No" ], "type": "string" }, "StructurantDispenses": { "description": "Réseau structurant ou assimilé", "enum": [ "None", "Yes", "No" ], "type": "string" }, "ConcernedRegioPublicDomainDispenses": { "description": "Concerne le domaine public Regional ", "enum": [ "None", "Yes", "No" ], "type": "string" }, "SurfaceCalc": { "description": "Surface ZC (m²) calculée" }, "SurfaceObserv": { "description": "Surface ZC (m²) constatée" }, "PerimeterCalc": { "description": "Périmètre ZP (m) calculée" }, "PerimeterObserv": { "description": "Périmètre ZP (m) constatée" }, "LengthObserv": { "description": "Longueur ZC (m) constatée" }, "AddressCalc": { "format": "int32", "description": "\\# de point d'adresse ZP calculé", "type": "integer" }, "AddressObserv": { "format": "int32", "description": "\\# de point d'adresse ZP constaté", "type": "integer" }, "PubBuildingCalc": { "format": "int32", "description": "\\# Batiment public ZP calculé", "type": "integer" }, "PubBuildingObserv": { "format": "int32", "description": "\\# Batiment public ZP constaté", "type": "integer" }, "DensityCalc": { "description": "Densité calculée" }, "DensityObserv": { "description": "Densité constatée" }, "ItemNumber": { "format": "int32", "description": "ItemNumber", "type": "integer" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "Annulation": { "format": "date-time", "description": "Annulé", "type": "string" }, "Programmation": { "format": "date-time", "description": "Programmé (T1)", "type": "string" }, "Information": { "format": "date-time", "description": "Informé (T1')", "type": "string" }, "InviteSocMan": { "format": "date-time", "description": "Date d'invitation de la société mandatée", "type": "string" }, "StartDateDAC": { "format": "date-time", "description": "Appel (T2)", "type": "string" }, "MeetingActual": { "format": "date-time", "description": "Dernière réunion de coordination (T4')", "type": "string" }, "MeetingDue": { "format": "date-time", "description": "Date limite de dernière réunion de coordination (T4')", "type": "string" }, "SendDAtoGCCActual": { "format": "date-time", "description": "Pour validation (T7)", "type": "string" }, "SendDAtoGCCDue": { "format": "date-time", "description": "Date limite de Pour validation (T7)", "type": "string" }, "SendToGDVCompetentActual": { "format": "date-time", "description": "Demande d'autorisation (T9)", "type": "string" }, "SendToGDVCompetentDue": { "format": "date-time", "description": "Date limite de Demande d'autorisation (T9)", "type": "string" }, "AnswerGDVtoPilotActual": { "format": "date-time", "description": "Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDelayActual": { "format": "date-time", "description": "Décision d'autorisation (T14\")", "type": "string" }, "AnswerGDVtoPilotDelayDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14\")", "type": "string" }, "RecoursActual": { "format": "date-time", "description": "Recours (T19)", "type": "string" }, "RecoursDue": { "format": "date-time", "description": "Date limite de Recours (T19)", "type": "string" }, "DecisionRecoursActual": { "format": "date-time", "description": "Décision de recours (T21)", "type": "string" }, "DecisionRecoursDue": { "format": "date-time", "description": "Date limite de Décision de recours (T21)", "type": "string" }, "StartWorkActual": { "format": "date-time", "description": "En éxécution (T16)", "type": "string" }, "StartWorkDue": { "format": "date-time", "description": "Date communiquée d'En éxécution (T16)", "type": "string" }, "DeclareEndOfSiteActual": { "format": "date-time", "description": "Exécuté (T47)", "type": "string" }, "DeclareEndOfSiteDue": { "format": "date-time", "description": "Date limite d'Exécuté (T47)", "type": "string" }, "PlansReadyActual": { "format": "date-time", "description": "A clôturer (T48)", "type": "string" }, "PlansReadyDue": { "format": "date-time", "description": "Date limite de A clôturer (T48)", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Organisation": { "description": "Organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Id of Organisation", "type": "integer" }, "OrganisationsParticipants": { "description": "Organisations participants" }, "Cmh": { "description": "CMH", "type": "boolean" }, "CmhOrganisation": { "description": "Organisation CMH" }, "GdvType": { "description": "Type de GDV", "enum": [ "None", "SPW", "COM", "AU", "PA" ], "type": "string" }, "GdvOrganisation": { "description": "GDV compétent organisation", "type": "string" }, "GdvOrganisationID": { "format": "int32", "description": "Id of GdvOrganisation", "type": "integer" }, "Archive_Address": { "description": "Address (for archive)", "type": "string" }, "Archive_ParentOrganisationName": { "description": "Parent organisation name (for archive)", "type": "string" }, "Archive_ParentOrganisationUuid": { "description": "Parent organisation uuid (for archive)", "type": "string" }, "Archive_CCCNumber": { "description": "Number of CCC (for archive)", "type": "string" }, "SiteStatus": { "description": "SiteStatus", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" } } } } } } } } }, "/api/dac/reply": { "post": { "tags": [ "CoordinationDossier" ], "summary": "Reply invitation", "operationId": "CoordinationDossier_Reply", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "reply", "in": "formData", "description": "Reply", "required": true, "schema": { "$ref": "#/definitions/InvitationReplyParameters" }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": false, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/de/create": { "post": { "tags": [ "ExecutionDossier" ], "summary": "Create a DE", "operationId": "ExecutionDossier_Create", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Initiated", "Started", "Execution", "EndWorks", "ComplementaryWorks", "EndSite", "ToClose", "Closed", "Canceled" ], "type": "string" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "CanceledActual": { "format": "date-time", "description": "Annulé", "type": "string" }, "ExpiredAuthorisationActual": { "format": "date-time", "description": "Péremption (T18)", "type": "string" }, "ExpiredAuthorisationDue": { "format": "date-time", "description": "Date limite de Péremption (T18)", "type": "string" }, "StartActual": { "format": "date-time", "description": "Lancé (T25)", "type": "string" }, "StartWorkActual": { "format": "date-time", "description": "En éxécution (T16)", "type": "string" }, "StartWorkDue": { "format": "date-time", "description": "Date communiquée d'En éxécution (T16)", "type": "string" }, "EntryInventoryActual": { "format": "date-time", "description": "EDL entrée (T24)", "type": "string" }, "InvitationEdl": { "format": "date-time", "description": "Invitation à un EDL de sortie (T38)", "type": "string" }, "MeetingEdl": { "format": "date-time", "description": "Première réunion à un EDL de sortie (T39)", "type": "string" }, "ExitInventoryActual": { "format": "date-time", "description": "EDL sortie (T40)", "type": "string" }, "ExitInventoryDue": { "format": "date-time", "description": "Date limite d'EDL sortie (T40)", "type": "string" }, "RequestExtraWorkActual": { "format": "date-time", "description": "Travaux complémentaires", "type": "string" }, "DeclareEndOfSiteActual": { "format": "date-time", "description": "Exécuté (T47)", "type": "string" }, "DeclareEndOfSiteDue": { "format": "date-time", "description": "Date limite d'Exécuté (T47)", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Organisation": { "description": "Organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Id of Organisation", "type": "integer" }, "RemarksExecution": { "description": "Commentaires d’exécution", "type": "string" }, "RemarksValidation": { "description": "Remarque de validation", "type": "string" }, "RemarksValidationEdlEntry": { "description": "Remarque de validation sur EDL entré", "type": "string" }, "RemarksValidationEdlExit": { "description": "Remarque de validation sur EDL sortie", "type": "string" }, "Comments": { "description": "Commentaire", "type": "string" } } } } } } } } }, "/api/de/get": { "get": { "tags": [ "ExecutionDossier" ], "summary": "Get DE fields", "operationId": "ExecutionDossier_Get", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Initiated", "Started", "Execution", "EndWorks", "ComplementaryWorks", "EndSite", "ToClose", "Closed", "Canceled" ], "type": "string" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "CanceledActual": { "format": "date-time", "description": "Annulé", "type": "string" }, "ExpiredAuthorisationActual": { "format": "date-time", "description": "Péremption (T18)", "type": "string" }, "ExpiredAuthorisationDue": { "format": "date-time", "description": "Date limite de Péremption (T18)", "type": "string" }, "StartActual": { "format": "date-time", "description": "Lancé (T25)", "type": "string" }, "StartWorkActual": { "format": "date-time", "description": "En éxécution (T16)", "type": "string" }, "StartWorkDue": { "format": "date-time", "description": "Date communiquée d'En éxécution (T16)", "type": "string" }, "EntryInventoryActual": { "format": "date-time", "description": "EDL entrée (T24)", "type": "string" }, "InvitationEdl": { "format": "date-time", "description": "Invitation à un EDL de sortie (T38)", "type": "string" }, "MeetingEdl": { "format": "date-time", "description": "Première réunion à un EDL de sortie (T39)", "type": "string" }, "ExitInventoryActual": { "format": "date-time", "description": "EDL sortie (T40)", "type": "string" }, "ExitInventoryDue": { "format": "date-time", "description": "Date limite d'EDL sortie (T40)", "type": "string" }, "RequestExtraWorkActual": { "format": "date-time", "description": "Travaux complémentaires", "type": "string" }, "DeclareEndOfSiteActual": { "format": "date-time", "description": "Exécuté (T47)", "type": "string" }, "DeclareEndOfSiteDue": { "format": "date-time", "description": "Date limite d'Exécuté (T47)", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Organisation": { "description": "Organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Id of Organisation", "type": "integer" }, "RemarksExecution": { "description": "Commentaires d’exécution", "type": "string" }, "RemarksValidation": { "description": "Remarque de validation", "type": "string" }, "RemarksValidationEdlEntry": { "description": "Remarque de validation sur EDL entré", "type": "string" }, "RemarksValidationEdlExit": { "description": "Remarque de validation sur EDL sortie", "type": "string" }, "Comments": { "description": "Commentaire", "type": "string" } } } } } } } } }, "/api/de/getdesdata": { "post": { "tags": [ "ExecutionDossier" ], "summary": "Get DEs fields", "operationId": "ExecutionDossier_GetDEsData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetDEsFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/de/update": { "post": { "tags": [ "ExecutionDossier" ], "summary": "Update DE fields", "operationId": "ExecutionDossier_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "fields", "in": "formData", "description": "Dossier fields", "required": false, "schema": { "description": "Dossier fields", "type": "object", "properties": { "ToBeExecutedBy": { "description": "ToBeExecutedBy" }, "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Initiated", "Started", "Execution", "EndWorks", "ComplementaryWorks", "EndSite", "ToClose", "Closed", "Canceled" ], "type": "string" }, "RemarksExecution": { "description": "Commentaires d’exécution", "type": "string" }, "Comments": { "description": "Commentaire", "type": "string" } } }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": false, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateResponse" } } } } }, "/api/de/getgdvs": { "get": { "tags": [ "ExecutionDossier" ], "summary": "Get DE GDV concerne", "operationId": "ExecutionDossier_GetGdvs", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/ImpactedGDV" } } } } } }, "/api/de/setgdvcompetent": { "post": { "tags": [ "ExecutionDossier" ], "summary": "Set competent gdv for de", "operationId": "ExecutionDossier_SetGdvCompetent", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "query", "description": "Competent organisation id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/generic/statushistory": { "post": { "tags": [ "Generic" ], "summary": "Get status history", "operationId": "Generic_GetStatusHistory", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetStatusHistoryFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetStatusHistoryResponse" } } } } } }, "/api/edl/get": { "post": { "tags": [ "Inventory" ], "summary": "Get DE edls", "operationId": "Inventory_GetEdls", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Edl" } } } } } }, "/api/edl/update": { "post": { "tags": [ "Inventory" ], "summary": "Create/Update EDL", "operationId": "Inventory_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "parameters", "in": "formData", "description": "Parameters", "required": true, "schema": { "$ref": "#/definitions/UpdateEdlParameters" }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": false, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateResponse" } } } } }, "/api/notif/getdata": { "post": { "tags": [ "Notification" ], "summary": "Get Notifications fields", "operationId": "Notification_GetNotifsData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetNotifsFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/Organisations/GetUsers": { "get": { "tags": [ "Organisations" ], "summary": "Get users for your organisation", "operationId": "Organisations_GetUsers", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/Organisations/UpdateUser": { "post": { "tags": [ "Organisations" ], "summary": "Update organisation user", "operationId": "Organisations_UpdateUser", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "userId", "in": "query", "description": "UserId", "required": true, "type": "integer", "format": "int32" }, { "name": "fields", "in": "formData", "description": "User fields", "required": false, "schema": { "description": "User fields", "type": "object", "properties": { "Status": { "description": "Status", "enum": [ "None", "Inactive", "Active", "Registered", "NewRegistration" ], "type": "string" }, "Street": { "description": "Street", "type": "string" }, "Number": { "description": "Number", "type": "string" }, "City": { "description": "City", "type": "string" }, "Zip": { "description": "Zip", "type": "string" }, "FirstName": { "description": "FirstName", "type": "string" }, "LastName": { "description": "LastName", "type": "string" }, "Email": { "description": "Adresse e-mail de contact", "type": "string" }, "Roles": { "description": "Role = ['None', 'Registration', 'Coordination', 'RequestAuthorisation', 'Information', 'Authorisation', 'Appeal', 'Cancellation', 'Execution', 'Administration', 'Mandated', 'Readonly', 'SmReadonly']", "default": [ "None", "Registration", "Coordination", "RequestAuthorisation", "Information", "Authorisation", "Appeal", "Cancellation", "Execution", "Administration", "Mandated", "Readonly", "SmReadonly" ], "type": "array", "items": { "type": "string" } }, "Gender": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "Telephone": { "description": "Numéro de téléphone", "type": "string" }, "TelephoneExtra": { "description": "Numéro de téléphone (extra)", "type": "string" }, "Country": { "description": "Pays", "type": "string" }, "DomainName": { "description": "Nom du domaine", "type": "string" }, "Userinfo": { "description": "Utilisateur info", "type": "string" }, "Function": { "description": "Fonction", "type": "string" } } }, "type": "object" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateUserResponse" } } } } }, "/api/Organisations/RemoveUser": { "post": { "tags": [ "Organisations" ], "summary": "Remove user from your organisation", "operationId": "Organisations_RemoveUser", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "user", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Organisations/ListAll": { "get": { "tags": [ "Organisations" ], "summary": "Get all active organisations", "operationId": "Organisations_ListAll", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/Organisation" } } } } } }, "/open/{type}/{id}": { "get": { "tags": [ "Redirect" ], "summary": "Redirect to a site (child) item", "operationId": "Redirect_Open", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "type", "in": "path", "description": "Type (item/site/sites/...)", "required": true, "type": "string", "enum": [ "Item", "Site", "Sites", "Dossiers", "DAC", "Invitations", "DA", "DE", "EDL", "CCC", "Upload" ] }, { "name": "id", "in": "path", "description": "Powalco identifier of the site", "required": true, "type": "string" } ], "responses": { "301": { "description": "Redirect to the detail page of the item" } } } }, "/resolve/{type}/{id}": { "get": { "tags": [ "Redirect" ], "summary": "Get the item identifier and URL of a site (child) item", "operationId": "Redirect_Resolve", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "type", "in": "path", "description": "Type (item/site/sites/...)", "required": true, "type": "string", "enum": [ "Item", "Site", "Sites", "Dossiers", "DAC", "Invitations", "DA", "DE", "EDL", "CCC", "Upload" ] }, { "name": "id", "in": "path", "description": "Powalco identifier of the site", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResolveResponse" } } } } }, "/api/Sites/GetData": { "get": { "tags": [ "Sites" ], "summary": "Get site fields", "operationId": "Sites_GetData", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "ID": { "format": "int32", "description": "Item identifier ", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Site fields", "type": "object", "properties": { "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" }, "CreatedOn": { "format": "date-time", "description": "CreatedOn", "type": "string" }, "UpdatedOn": { "format": "date-time", "description": "UpdatedOn", "type": "string" }, "ZcExists": { "description": "ZC exists", "type": "boolean" }, "ZpExists": { "description": "ZP exists", "type": "boolean" }, "ZcccExists": { "description": "ZCCC exists", "type": "boolean" }, "ProposedFlux": { "description": "Flux proposé", "enum": [ "None", "InformationJPlus1", "InformationJMinus5", "SimpleAuthorization", "Coordination", "Programmation" ], "type": "string" }, "ProposedFluxCopy": { "description": "ProposedFluxCopy", "enum": [ "None", "InformationJPlus1", "InformationJMinus5", "SimpleAuthorization", "Coordination", "Programmation" ], "type": "string" }, "Reason": { "description": "Raison", "type": "string" }, "AssociateSite": { "description": "Confirmation d'association", "type": "boolean" }, "IsProject": { "description": "Projet", "type": "boolean" }, "MandatedSocieties": { "description": "Société Mandatée" }, "IsPlansReadyActual": { "description": "Plans de récolement prêts", "type": "boolean" }, "KlimRequestId": { "description": "Klim request id" }, "KlimRequestLink": { "description": "Klim request link", "type": "string" }, "KlimRequestStatusUpdated": { "format": "date-time", "description": "Klim request status updated", "type": "string" }, "KlimRequestStatus": { "description": "Klim request status", "enum": [ "None", "WorkZoneDrawn", "Canceled", "Completed", "Published", "Abandoned", "WorkFlowStarted", "PartiallyConfirmed", "Finished" ], "type": "string" }, "KlimPlanRequestNotif": { "description": "Demande de Correctif", "type": "boolean" }, "IntersectSiteZG": { "description": "Intersection entre le chantier et une zone gelée", "type": "boolean" }, "OrganisationsSummary": { "description": "Organisations summary" }, "GdvCurrentCompetent": { "description": "GDV compétent organisation", "type": "string" }, "GdvCurrentCompetentID": { "format": "int32", "description": "Id of GdvCurrentCompetent", "type": "integer" }, "ButtonsChangeDates": { "description": "ButtonsChangeDates" }, "Type": { "description": "Type", "enum": [ "None", "Initial", "Associated", "Coordination", "Project" ], "type": "string" }, "StartDateFrozen": { "format": "date-time", "description": "Début de validé de la ZP Gelée", "type": "string" }, "EndDateFrozen": { "format": "date-time", "description": "Fin de validé de la ZP Gelée", "type": "string" }, "FrozenStatus": { "description": "Statut ZG", "enum": [ "none", "future", "active", "inactive", "canceled" ], "type": "string" }, "DateLastModified": { "format": "date-time", "description": "Dernière modification des dates", "type": "string" }, "DatesQualif": { "description": "Qualificatif des dates", "enum": [ "None", "Prevision", "Realisation" ], "type": "string" }, "ZonesModified": { "format": "date-time", "description": "Date de dernière modification des zones", "type": "string" }, "WorkTypes": { "description": "Type de travaux" }, "OtherWorkTypeComment": { "description": "Commentaires autre type de travaux", "type": "string" }, "Fluids": { "description": "Fluide" }, "LastUpdatedZc": { "format": "date-time", "description": "Date de dernière modification de la \"Zone d'ouverture du chantier\" (ZC)", "type": "string" }, "LastUpdatedZp": { "format": "date-time", "description": "Date de dernière modification de la \"Zone d'ouverture du périmètre\" (ZP)", "type": "string" }, "WorkDescription": { "description": "Description détaillée des travaux", "type": "string" }, "Constraints": { "description": "Contraintes internes et externes", "type": "string" }, "ArchElements": { "description": "Eléments architecturaux", "type": "string" }, "Name": { "description": "Nom du chantier", "type": "string" }, "Duration": { "format": "int32", "description": "Durée des travaux", "type": "integer" }, "InternalReference": { "description": "Ref. Interne", "type": "string" }, "ImpactedOrganisations": { "description": "Organisations impactées" }, "ImpactedStreets": { "description": "Rues impactées" }, "ImpactedCommunes": { "description": "ImpactedCommunes" }, "ContactPerson": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ContactPersonExec": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "Waranty": { "description": "Cautionnement chantier", "type": "boolean" }, "IsCleaned": { "description": "Сhantier nettoyé par Powalco", "type": "boolean" }, "CreatorFirstName": { "description": "CreatorFirstName", "type": "string" }, "CreatorLastName": { "description": "CreatorLastName", "type": "string" }, "CreatorEmail": { "description": "CreatorEmail", "type": "string" }, "CreatorPhone": { "description": "CreatorPhone", "type": "string" }, "StartDate": { "format": "date-time", "description": "Date début de chantier", "type": "string" }, "EndDate": { "format": "date-time", "description": "Date fin de chantier", "type": "string" }, "Zip": { "description": "Code postal", "type": "string" }, "City": { "description": "Commune", "type": "string" }, "Locality": { "description": "Localité", "type": "string" }, "Street": { "description": "Rue", "type": "string" }, "Number": { "description": "Numéro", "type": "string" }, "X": { "description": "Coordonnée X" }, "Y": { "description": "Coordonnée Y" }, "MinX": { "description": "Min X" }, "MaxX": { "description": "Max X" }, "MinY": { "description": "Min Y" }, "MaxY": { "description": "Max Y" }, "ContactGender": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "ContactLastName": { "description": "Nom", "type": "string" }, "ContactFirstName": { "description": "Prénom", "type": "string" }, "ContactFunction": { "description": "Fonction", "type": "string" }, "ContactTelephone": { "description": "Téléphone", "type": "string" }, "ContactEmail": { "description": "Adresse email", "type": "string" }, "ContactAddress": { "description": "Adresse postale", "type": "string" }, "ContactGenderExec": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "ContactLastNameExec": { "description": "Nom", "type": "string" }, "ContactFirstNameExec": { "description": "Prénom", "type": "string" }, "ContactFunctionExec": { "description": "Fonction", "type": "string" }, "ContactTelephoneExec": { "description": "Téléphone", "type": "string" }, "ContactEmailExec": { "description": "Adresse email", "type": "string" }, "ContactAddressExec": { "description": "Adresse postale", "type": "string" }, "Phasing": { "description": "Phasage", "type": "string" }, "UrgentDispenses": { "description": "Travaux urgents", "enum": [ "None", "Yes", "No" ], "type": "string" }, "JusticeDepenses": { "description": "Décision de justice", "enum": [ "None", "Yes", "No" ], "type": "string" }, "CEEDispenses": { "description": "Mise en demeure CEE", "enum": [ "None", "Yes", "No" ], "type": "string" }, "DomPubliqueDispenses": { "description": "Ouverture du domaine public", "enum": [ "None", "Yes", "No" ], "type": "string" }, "VoiriesDispenses": { "description": "Renouvellement de voiries", "enum": [ "None", "Yes", "No" ], "type": "string" }, "EntretienDispenses": { "description": "Entretien des voies navigables", "enum": [ "None", "Yes", "No" ], "type": "string" }, "CirculationDispenses": { "description": "Ouverture des voies de circulation", "enum": [ "None", "Yes", "No" ], "type": "string" }, "StrategiqueDispenses": { "description": "Inscrit dans le plan stratégique, budget, programme d'investissement", "enum": [ "None", "Yes", "No" ], "type": "string" }, "StructurantDispenses": { "description": "Réseau structurant ou assimilé", "enum": [ "None", "Yes", "No" ], "type": "string" }, "ConcernedRegioPublicDomainDispenses": { "description": "Concerne le domaine public Regional ", "enum": [ "None", "Yes", "No" ], "type": "string" }, "SurfaceCalc": { "description": "Surface ZC (m²) calculée" }, "SurfaceObserv": { "description": "Surface ZC (m²) constatée" }, "PerimeterCalc": { "description": "Périmètre ZP (m) calculée" }, "PerimeterObserv": { "description": "Périmètre ZP (m) constatée" }, "LengthObserv": { "description": "Longueur ZC (m) constatée" }, "AddressCalc": { "format": "int32", "description": "\\# de point d'adresse ZP calculé", "type": "integer" }, "AddressObserv": { "format": "int32", "description": "\\# de point d'adresse ZP constaté", "type": "integer" }, "PubBuildingCalc": { "format": "int32", "description": "\\# Batiment public ZP calculé", "type": "integer" }, "PubBuildingObserv": { "format": "int32", "description": "\\# Batiment public ZP constaté", "type": "integer" }, "DensityCalc": { "description": "Densité calculée" }, "DensityObserv": { "description": "Densité constatée" }, "ItemNumber": { "format": "int32", "description": "ItemNumber", "type": "integer" }, "Overdue": { "description": "Liste des dates limites dépassées" }, "Annulation": { "format": "date-time", "description": "Annulé", "type": "string" }, "Programmation": { "format": "date-time", "description": "Programmé (T1)", "type": "string" }, "Information": { "format": "date-time", "description": "Informé (T1')", "type": "string" }, "InviteSocMan": { "format": "date-time", "description": "Date d'invitation de la société mandatée", "type": "string" }, "StartDateDAC": { "format": "date-time", "description": "Appel (T2)", "type": "string" }, "MeetingActual": { "format": "date-time", "description": "Dernière réunion de coordination (T4')", "type": "string" }, "MeetingDue": { "format": "date-time", "description": "Date limite de dernière réunion de coordination (T4')", "type": "string" }, "SendDAtoGCCActual": { "format": "date-time", "description": "Pour validation (T7)", "type": "string" }, "SendDAtoGCCDue": { "format": "date-time", "description": "Date limite de Pour validation (T7)", "type": "string" }, "SendToGDVCompetentActual": { "format": "date-time", "description": "Demande d'autorisation (T9)", "type": "string" }, "SendToGDVCompetentDue": { "format": "date-time", "description": "Date limite de Demande d'autorisation (T9)", "type": "string" }, "AnswerGDVtoPilotActual": { "format": "date-time", "description": "Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14)", "type": "string" }, "AnswerGDVtoPilotDelayActual": { "format": "date-time", "description": "Décision d'autorisation (T14\")", "type": "string" }, "AnswerGDVtoPilotDelayDue": { "format": "date-time", "description": "Date limite de Décision d'autorisation (T14\")", "type": "string" }, "RecoursActual": { "format": "date-time", "description": "Recours (T19)", "type": "string" }, "RecoursDue": { "format": "date-time", "description": "Date limite de Recours (T19)", "type": "string" }, "DecisionRecoursActual": { "format": "date-time", "description": "Décision de recours (T21)", "type": "string" }, "DecisionRecoursDue": { "format": "date-time", "description": "Date limite de Décision de recours (T21)", "type": "string" }, "StartWorkActual": { "format": "date-time", "description": "En éxécution (T16)", "type": "string" }, "StartWorkDue": { "format": "date-time", "description": "Date communiquée d'En éxécution (T16)", "type": "string" }, "DeclareEndOfSiteActual": { "format": "date-time", "description": "Exécuté (T47)", "type": "string" }, "DeclareEndOfSiteDue": { "format": "date-time", "description": "Date limite d'Exécuté (T47)", "type": "string" }, "PlansReadyActual": { "format": "date-time", "description": "A clôturer (T48)", "type": "string" }, "PlansReadyDue": { "format": "date-time", "description": "Date limite de A clôturer (T48)", "type": "string" }, "Closed": { "format": "date-time", "description": "Clôturé (T49)", "type": "string" }, "Organisation": { "description": "Organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Id of Organisation", "type": "integer" }, "OrganisationsParticipants": { "description": "Organisations participants" }, "Cmh": { "description": "CMH", "type": "boolean" }, "CmhOrganisation": { "description": "Organisation CMH" } } } } } } } } }, "/api/Sites/GetSitesData": { "post": { "tags": [ "Sites" ], "summary": "Get sites fields", "operationId": "Sites_GetSitesData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetSitesFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/Sites/Update": { "post": { "tags": [ "Sites" ], "summary": "Update site fields", "operationId": "Sites_Update", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "fields", "in": "formData", "description": "Site fields", "required": false, "schema": { "description": "Site fields", "type": "object", "properties": { "Title": { "description": "Title", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" }, "ProposedFluxCopy": { "description": "ProposedFluxCopy", "enum": [ "None", "InformationJPlus1", "InformationJMinus5", "SimpleAuthorization", "Coordination", "Programmation" ], "type": "string" }, "AssociateSite": { "description": "Confirmation d'association", "type": "boolean" }, "MandatedSocieties": { "description": "Société Mandatée" }, "IntersectSiteZG": { "description": "Intersection entre le chantier et une zone gelée", "type": "boolean" }, "OrganisationsSummary": { "description": "Organisations summary" }, "ButtonsChangeDates": { "description": "ButtonsChangeDates" }, "DatesQualif": { "description": "Qualificatif des dates", "enum": [ "None", "Prevision", "Realisation" ], "type": "string" }, "WorkTypes": { "description": "Type de travaux" }, "OtherWorkTypeComment": { "description": "Commentaires autre type de travaux", "type": "string" }, "Fluids": { "description": "Fluide" }, "WorkDescription": { "description": "Description détaillée des travaux", "type": "string" }, "Constraints": { "description": "Contraintes internes et externes", "type": "string" }, "ArchElements": { "description": "Eléments architecturaux", "type": "string" }, "Name": { "description": "Nom du chantier", "type": "string" }, "Duration": { "format": "int32", "description": "Durée des travaux", "type": "integer" }, "InternalReference": { "description": "Ref. Interne", "type": "string" }, "ContactPerson": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "ContactPersonExec": { "format": "int32", "description": "Utilisateur", "type": "integer" }, "Waranty": { "description": "Cautionnement chantier", "type": "boolean" }, "IsCleaned": { "description": "Сhantier nettoyé par Powalco", "type": "boolean" }, "CreatorFirstName": { "description": "CreatorFirstName", "type": "string" }, "CreatorLastName": { "description": "CreatorLastName", "type": "string" }, "CreatorEmail": { "description": "CreatorEmail", "type": "string" }, "CreatorPhone": { "description": "CreatorPhone", "type": "string" }, "StartDate": { "format": "date-time", "description": "Date début de chantier", "type": "string" }, "EndDate": { "format": "date-time", "description": "Date fin de chantier", "type": "string" }, "Zip": { "description": "Code postal", "type": "string" }, "City": { "description": "Commune", "type": "string" }, "Locality": { "description": "Localité", "type": "string" }, "Street": { "description": "Rue", "type": "string" }, "Number": { "description": "Numéro", "type": "string" }, "X": { "description": "Coordonnée X" }, "Y": { "description": "Coordonnée Y" }, "MinX": { "description": "Min X" }, "MaxX": { "description": "Max X" }, "MinY": { "description": "Min Y" }, "MaxY": { "description": "Max Y" }, "ContactGender": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "ContactLastName": { "description": "Nom", "type": "string" }, "ContactFirstName": { "description": "Prénom", "type": "string" }, "ContactFunction": { "description": "Fonction", "type": "string" }, "ContactTelephone": { "description": "Téléphone", "type": "string" }, "ContactEmail": { "description": "Adresse email", "type": "string" }, "ContactAddress": { "description": "Adresse postale", "type": "string" }, "ContactGenderExec": { "description": "Titres et qualités", "enum": [ "None", "Male", "Female" ], "type": "string" }, "ContactLastNameExec": { "description": "Nom", "type": "string" }, "ContactFirstNameExec": { "description": "Prénom", "type": "string" }, "ContactFunctionExec": { "description": "Fonction", "type": "string" }, "ContactTelephoneExec": { "description": "Téléphone", "type": "string" }, "ContactEmailExec": { "description": "Adresse email", "type": "string" }, "ContactAddressExec": { "description": "Adresse postale", "type": "string" }, "Phasing": { "description": "Phasage", "type": "string" }, "UrgentDispenses": { "description": "Travaux urgents", "enum": [ "None", "Yes", "No" ], "type": "string" }, "JusticeDepenses": { "description": "Décision de justice", "enum": [ "None", "Yes", "No" ], "type": "string" }, "CEEDispenses": { "description": "Mise en demeure CEE", "enum": [ "None", "Yes", "No" ], "type": "string" }, "DomPubliqueDispenses": { "description": "Ouverture du domaine public", "enum": [ "None", "Yes", "No" ], "type": "string" }, "VoiriesDispenses": { "description": "Renouvellement de voiries", "enum": [ "None", "Yes", "No" ], "type": "string" }, "EntretienDispenses": { "description": "Entretien des voies navigables", "enum": [ "None", "Yes", "No" ], "type": "string" }, "CirculationDispenses": { "description": "Ouverture des voies de circulation", "enum": [ "None", "Yes", "No" ], "type": "string" }, "StrategiqueDispenses": { "description": "Inscrit dans le plan stratégique, budget, programme d'investissement", "enum": [ "None", "Yes", "No" ], "type": "string" }, "StructurantDispenses": { "description": "Réseau structurant ou assimilé", "enum": [ "None", "Yes", "No" ], "type": "string" }, "ConcernedRegioPublicDomainDispenses": { "description": "Concerne le domaine public Regional ", "enum": [ "None", "Yes", "No" ], "type": "string" }, "SurfaceObserv": { "description": "Surface ZC (m²) constatée" }, "PerimeterObserv": { "description": "Périmètre ZP (m) constatée" }, "LengthObserv": { "description": "Longueur ZC (m) constatée" }, "AddressObserv": { "format": "int32", "description": "\\# de point d'adresse ZP constaté", "type": "integer" }, "PubBuildingObserv": { "format": "int32", "description": "\\# Batiment public ZP constaté", "type": "integer" }, "DensityObserv": { "description": "Densité constatée" }, "OrganisationsParticipants": { "description": "Organisations participants" }, "CmhOrganisation": { "description": "Organisation CMH" }, "GdvType": { "description": "Type de GDV", "enum": [ "None", "SPW", "COM", "AU", "PA" ], "type": "string" }, "SiteStatus": { "description": "SiteStatus", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" } } }, "type": "object" }, { "name": "file", "in": "formData", "description": "Attachment file", "required": false, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateResponse" } } } } }, "/api/Sites/SetPlanRecolement": { "post": { "tags": [ "Sites" ], "summary": "Switch plan de recolement for site", "operationId": "Sites_SetPlanRecolement", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "isSet", "in": "query", "description": "Is set?", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/Cancel": { "post": { "tags": [ "Sites" ], "summary": "Cancel site", "operationId": "Sites_Cancel", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "reason", "in": "body", "description": "Cancellation reason", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/Upload": { "post": { "tags": [ "Sites" ], "summary": "Bulk upload sites", "description": "The sites are not created immediately when the 'async' flag is set.\r\nUse the api/sites/uploadstatus method to retrieve the status of an ongoing upload", "operationId": "Sites_Upload", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "async", "in": "query", "description": "Asynchronouse mode (default: false)", "required": false, "type": "boolean" }, { "name": "debug", "in": "query", "description": "Debug mode", "required": false, "type": "boolean" }, { "name": "file", "in": "formData", "description": "Bulk upload file (XML)", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UploadResponse" } } } } }, "/api/Sites/UploadStatus": { "get": { "tags": [ "Sites" ], "summary": "Get bulk upload status", "description": "Use the session identifier that is returned by the api/sites/upload method", "operationId": "Sites_UploadStatus", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "session", "in": "query", "description": "Session identifier", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UploadResponse" } } } } }, "/api/Sites/UpdateGeometry": { "post": { "tags": [ "Sites" ], "summary": "Update site geometry", "operationId": "Sites_UpdateGeometry", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "file", "in": "formData", "description": "Geometry file (XML)", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/BulkUpdate": { "post": { "tags": [ "Sites" ], "summary": "Bulk update sites", "description": "", "operationId": "Sites_BulkUpdate", "consumes": [ "multipart/form-data" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "file", "in": "formData", "description": "Bulk upload file (XML)", "required": true, "type": "file" } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/SiteResponse" } } } } } }, "/api/Sites/UpdateCoordinates": { "get": { "tags": [ "Sites" ], "summary": "Updates coordinates on site based on address fields", "operationId": "Sites_UpdateCoordinates", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/UpdateCoordinatesResponse" } } } } } }, "/api/Sites/CreateZcccFromChildSites": { "post": { "tags": [ "Sites" ], "summary": "Create ZCCC for CCC site", "operationId": "Sites_CreateZcccFromChildSites", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/SaveSiteWithGestionnairesDeVoirie": { "post": { "tags": [ "Sites" ], "summary": "", "operationId": "Sites_SaveSiteWithGestionnairesDeVoirie", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "organisationId", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "gdvSiteDatas", "in": "body", "description": "", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/GdvSiteData" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/SaveSiteWithOrganisation": { "post": { "tags": [ "Sites" ], "summary": "", "operationId": "Sites_SaveSiteWithOrganisation", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "organisationId", "in": "query", "description": "", "required": true, "type": "string", "format": "uuid" }, { "name": "gdvSiteDatas", "in": "body", "description": "", "required": true, "schema": { "type": "array", "items": { "$ref": "#/definitions/GdvSiteImpactData" } } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/SaveGeoDataToArchivedItem": { "post": { "tags": [ "Sites" ], "summary": "Updates the archived document for this site with GEO data", "operationId": "Sites_SaveGeoDataToArchivedItem", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "siteId", "in": "query", "description": "The siteId for which to update the archived document", "required": true, "type": "integer", "format": "int32" }, { "name": "siteGeoData", "in": "body", "description": "A json structure with GEO data to be contained in the archive", "required": true, "schema": { "$ref": "#/definitions/SiteGeoData" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/Sites/GetArchivedAttachment": { "get": { "tags": [ "Sites" ], "summary": "Gets the archived attachment based on the attachment id", "operationId": "Sites_GetArchivedAttachment", "consumes": [], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "attachmentId", "in": "query", "description": "", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/tasks/getdata": { "post": { "tags": [ "Tasks" ], "summary": "Get Tasks fields", "operationId": "Tasks_GetTasksData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTasksFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/tasks/reply": { "post": { "tags": [ "Tasks" ], "summary": "Change task reply", "operationId": "Tasks_Reply", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "reply", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ReplyParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } }, "/api/validations/getdata": { "post": { "tags": [ "Validations" ], "summary": "Get Validations fields", "operationId": "Validations_GetTasksData", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "filter", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetValidationsFieldsFilter" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "array", "items": { "$ref": "#/definitions/GetFieldsResponse" } } } } } }, "/api/validations/reply": { "post": { "tags": [ "Validations" ], "summary": "Change validation reply", "operationId": "Validations_Reply", "consumes": [ "application/json", "text/json", "text/html", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", "text/json", "text/html", "application/xml", "text/xml" ], "parameters": [ { "name": "id", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "reply", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ValidationReplyParameters" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } } } } }, "definitions": { "AttachmentInfo": { "description": "Attachment information", "type": "object", "properties": { "Description": { "description": "Attachment description", "type": "string" } } }, "CreateUrlAttachmentParameters": { "description": "", "type": "object", "properties": { "Urls": { "description": "", "type": "array", "items": { "$ref": "#/definitions/UrlAttachment" } } } }, "UrlAttachment": { "description": "", "type": "object", "properties": { "Url": { "description": "", "type": "string" }, "Description": { "description": "", "type": "string" } } }, "GetAttachmentsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" } }, "StartDateFrom": { "format": "date-time", "description": "", "type": "string" }, "StartDateTo": { "format": "date-time", "description": "", "type": "string" }, "EndDateFrom": { "format": "date-time", "description": "", "type": "string" }, "EndDateTo": { "format": "date-time", "description": "", "type": "string" }, "T40From": { "format": "date-time", "description": "", "type": "string" }, "T40To": { "format": "date-time", "description": "", "type": "string" }, "T5PVfinalFrom": { "format": "date-time", "description": "", "type": "string" }, "T5PVfinalTo": { "format": "date-time", "description": "", "type": "string" } } }, "SiteAttachmentsResponse": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "string" }, "Items": { "description": "", "type": "array", "items": { "$ref": "#/definitions/ItemAttachments" } } } }, "ItemAttachments": { "description": "", "type": "object", "properties": { "Title": { "description": "", "type": "string" }, "List": { "description": "", "type": "string" }, "Attachments": { "description": "", "type": "array", "items": { "$ref": "#/definitions/ItemAttachmentInfo" } } } }, "ItemAttachmentInfo": { "description": "", "type": "object", "properties": { "Id": { "format": "int32", "description": "", "type": "integer" }, "Name": { "description": "", "type": "string" }, "Reason": { "description": "", "type": "string" }, "UploadDate": { "format": "date-time", "description": "", "type": "string" }, "CreatedBy": { "description": "", "type": "string" }, "Url": { "description": "", "type": "string" } } }, "IntrospectResponse": { "description": "Response of {M:Powalco.Interface.AuthorizationApi.Introspect(System.String,System.Nullable{System.Guid})}", "type": "object", "properties": { "Active": { "description": "Active", "type": "boolean" }, "Scopes": { "description": "Scopes", "type": "string" }, "ExtensionField": { "description": "Extensions field", "type": "string" }, "Organisation": { "description": "User organisation identifiers", "type": "array", "items": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } }, "Administrator": { "description": "User is global administrator", "type": "boolean" }, "UserId": { "format": "int32", "description": "UserId", "type": "integer" } } }, "GetTokenResponse": { "description": "Response of {M:Powalco.Interface.AuthorizationApi.GetToken(System.String,Powalco.Interface.AuthorizationApi.Type,System.String)}", "type": "object", "properties": { "Token": { "description": "API session token", "type": "string" }, "Expires": { "format": "date-time", "description": "Expiration date of the token", "type": "string" } } }, "GetDAsFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Initiated", "Validation", "Instruction", "Decision", "Advice", "Meeting", "DecisionDelayed", "OnHold", "Authorized", "PartAuthorized", "Refused", "RefusedDefault", "Appeal", "AppealRefused", "AppealPartAuthorized", "AppealAuthorized", "ExtendedAuthorization", "AuthorizationExpired", "AuthorizationExpiredFinal", "ConfirmedRefused", "ConfirmedPartAuthorized", "ConfirmedAuthorized", "Closed", "Canceled" ], "type": "string" } }, "LastUpdate": { "format": "date-time", "description": "Only consider items updated after the specified value. Ignored when null.", "type": "string" }, "LastUpdateFrom": { "format": "date-time", "description": "Actually same as above parameter but since we use from and to now and we dont\r\nwant to break the current usage we use this one for the \"new\" functionality.", "type": "string" }, "LastUpdateTo": { "format": "date-time", "description": "Items updated until this date.", "type": "string" } } }, "GetFieldsResponse": { "description": "Response of bulk GetFields operations", "type": "object", "properties": { "ID": { "format": "int32", "description": "Item identifier", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" }, "Fields": { "description": "Fields", "type": "object" } } }, "UpdateResponse": { "description": "Response of site/dossier fields update", "type": "object", "properties": { "ID": { "format": "int32", "description": "Dossier item identifier", "type": "integer" }, "Url": { "description": "Dossier item URL", "type": "string" } } }, "ApplicableAuthDossierResponse": { "description": "Response of applicable DA retrieving", "type": "object", "properties": { "Site": { "format": "int32", "description": "Site Powalco ID", "type": "integer" }, "ID": { "format": "int32", "description": "Site item ID", "type": "integer" }, "Status": { "description": "Site status", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" }, "Url": { "description": "Site item URL", "type": "string" } } }, "RequestReplyParameters": { "description": "", "type": "object", "properties": { "Reply": { "description": "", "enum": [ "Accepted", "Demand", "TransferTo" ], "type": "string" }, "Comments": { "description": "", "type": "string" }, "TransferTo": { "format": "int32", "description": "", "type": "integer" } } }, "ImpactedGDV": { "description": "Response of GDV concernes retrieving", "type": "object", "properties": { "OrganisationID": { "format": "int32", "description": "Organisation item identifier", "type": "integer" }, "Organisation": { "description": "GDV organisation", "type": "string" }, "IsCompetent": { "description": "Is gdv competent", "type": "boolean" }, "Type": { "description": "GDV type", "enum": [ "None", "SPW", "COM", "AU", "PA" ], "type": "string" }, "Surface": { "format": "double", "description": "Surface", "type": "number" } } }, "GetDACsFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Started", "Ongoing", "EnvoiPilote", "Coordination", "NoCoordination", "Closed", "Canceled" ], "type": "string" } }, "LastUpdate": { "format": "date-time", "description": "Only consider items updated after the specified value. Ignored when null.", "type": "string" }, "LastUpdateFrom": { "format": "date-time", "description": "Actually same as above parameter but since we use from and to now and we dont\r\nwant to break the current usage we use this one for the \"new\" functionality.", "type": "string" }, "LastUpdateTo": { "format": "date-time", "description": "Items updated until this date.", "type": "string" } } }, "GetCCCsFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } } } }, "Invitation": { "description": "Response of invitation retrieving", "type": "object", "properties": { "ID": { "format": "int32", "description": "Invitation item identifier", "type": "integer" }, "PowalcoId": { "description": "CI item number", "type": "string" }, "Organisation": { "description": "Invitation organisation", "type": "string" }, "OrganisationID": { "format": "int32", "description": "Invitation organisation", "type": "integer" }, "Status": { "description": "Invitation status", "enum": [ "None", "NotReplied", "Replied", "Canceled", "Closed" ], "type": "string" }, "Reply": { "description": "Reply by organisation", "enum": [ "None", "Interested", "NotInterested", "InterestedWithoutWork" ], "type": "string" }, "Date": { "format": "date-time", "description": "Invitation date", "type": "string" }, "Url": { "description": "Invitation item URL", "type": "string" } } }, "InvitationReplyParameters": { "description": "", "type": "object", "properties": { "Reply": { "description": "", "enum": [ "None", "Interested", "NotInterested", "InterestedWithoutWork" ], "type": "string" }, "Contact": { "description": "Contact person email address", "type": "string" }, "Sites": { "description": "Link sites to invitation", "type": "array", "items": { "$ref": "#/definitions/AssociatedSite" } } } }, "AssociatedSite": { "description": "", "type": "object", "properties": { "ID": { "format": "int32", "description": "Powalco ID", "type": "integer" }, "Associated": { "description": "Set site as Associated", "type": "boolean" } } }, "GetDEsFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Initiated", "Started", "Execution", "EndWorks", "ComplementaryWorks", "EndSite", "ToClose", "Closed", "Canceled" ], "type": "string" } }, "LastUpdate": { "format": "date-time", "description": "Only consider items updated after the specified value. Ignored when null.", "type": "string" }, "LastUpdateFrom": { "format": "date-time", "description": "Actually same as above parameter but since we use from and to now and we dont\r\nwant to break the current usage we use this one for the \"new\" functionality.", "type": "string" }, "LastUpdateTo": { "format": "date-time", "description": "Items updated until this date.", "type": "string" } } }, "GetStatusHistoryFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "type": "string" } }, "FromDate": { "format": "date-time", "description": "Only consider things that happened after this moment. Can be used in combination with {Powalco.Interface.GenericApi.GetStatusHistoryFilter.ToDate}. Default value is yesterday at midnight.", "type": "string" }, "ToDate": { "format": "date-time", "description": "Only consider things that happened before this moment. Can be used in combination with {Powalco.Interface.GenericApi.GetStatusHistoryFilter.FromDate}. Default value is {System.DateTime.Now}.", "type": "string" }, "Entity": { "description": "", "enum": [ "None", "Worksite", "DA", "DE", "DAC", "Notification" ], "type": "string" } } }, "GetStatusHistoryResponse": { "description": "", "type": "object", "properties": { "ID_powalco": { "description": "PowalcoID of root", "type": "string" }, "StatusPrevious": { "description": "", "type": "string" }, "StatusCurrent": { "description": "", "type": "string" }, "StatusNew": { "description": "", "type": "string" }, "StatusUpdate": { "format": "date-time", "description": "", "type": "string" }, "InternalReference": { "description": "", "type": "string" } } }, "Edl": { "description": "Response of invitation retrieving", "type": "object", "properties": { "ID": { "format": "int32", "description": "EDL item identifier", "type": "integer" }, "Url": { "description": "EDL item URL", "type": "string" }, "Organisation": { "description": "", "type": "string" }, "OrganisationID": { "format": "int32", "description": "", "type": "integer" }, "Status": { "description": "Edl status", "enum": [ "None", "NotStarted", "PVEnvoyer", "Closed", "Canceled", "Ongoing" ], "type": "string" }, "Type": { "description": "", "enum": [ "None", "Entry", "Exit" ], "type": "string" }, "DateTime": { "format": "date-time", "description": "", "type": "string" }, "Location": { "description": "", "type": "string" } } }, "UpdateEdlParameters": { "description": "", "type": "object", "properties": { "ID": { "format": "int32", "description": "", "type": "integer" }, "Type": { "description": "", "enum": [ "None", "Entry", "Exit" ], "type": "string" }, "Organisation": { "format": "int32", "description": "", "type": "integer" }, "DateTime": { "format": "date-time", "description": "", "type": "string" }, "Location": { "description": "", "type": "string" }, "Participants": { "description": "", "type": "array", "items": { "format": "int32", "type": "integer" } }, "SendInvitations": { "description": "", "type": "boolean" }, "SendMinutes": { "description": "", "type": "boolean" }, "PresentPerson": { "description": "", "type": "string" }, "ProcessVerbal": { "description": "", "type": "string" }, "OrdreDuJour": { "description": "", "type": "string" }, "Constat": { "description": "", "enum": [ "None", "Unilateral", "Contradictoire" ], "type": "string" }, "Comments": { "description": "", "type": "string" }, "Conclusion": { "description": "", "enum": [ "None", "TravauxComplementaires", "PristinEtat" ], "type": "string" } } }, "GetNotifsFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Send", "Canceled", "Closed" ], "type": "string" } }, "Model": { "description": "", "type": "array", "items": { "enum": [ "None", "M1", "Rejected", "Accepted", "Unpaid", "M5", "Inactive", "ResetPassword", "SendConvocationInvites", "SendConvocationMinutes", "NewAppel", "NewParent", "CreateCCCTask", "RefuseCCC", "ValidationConvocation", "CCCApproved", "InstructionDA", "DecisionDA", "OnHoldDA", "AuthorizedDA", "PartAuthorizedDA", "RefusedDA", "RefusedDefaultDA", "ExtendedDA", "CanceledDA", "AppealDA", "ExpiredDA", "AdviceDA", "EndWorksDE", "ExtraWorksDE", "InformationDE", "ValidationDA", "RejectedEDL", "SiteCanceled", "EndSiteDE", "ExecutionDE", "StartedDE", "AppealAuthorizedDA", "AppealPartAuthorizedDA", "AppealRefusedDA", "RejectAdviceDA", "SocManAdded", "InformationRefusedByGDV", "TooLateDecisionDA", "ProlongedAutorisationDA", "NewChantierInZI", "ExtentionNotApprovedDA", "ApproveExtendedDA", "InformationAcceptedByGDV", "InformationNotapplicableByGDV", "ExtraWorkResponseDE", "DAOutOfDemandeCompl", "CanceledDE", "ValidationEDL", "ConfirmedPartAuthorizedDA", "ConfirmedAuthorizedDA", "ConfirmedRefusedDA", "SendConvocationInvitesDA", "SendConvocationInvitesDE", "SendConvocationMinutesDA", "SendConvocationMinutesDE", "ApprovePourValidation", "NotApplicablePVFinalDAC", "ApprovePVFinalDAC", "ApproveValidationEDL", "NotApplicableValidationEDL", "RejectPVFinalDAC", "RejectValidationEDL", "RejectPourValidation", "CreateMeetingDA", "KlimDone", "KlimNotOk", "KlimLate", "ErrorAsync", "InstructionDATransfer", "InstructionDATransferApproved", "InstructionDATransferRejected", "DETransferInitiated", "DESiteStartDateChanged", "NotApplicablePourValidationDA", "ResponseCustomerTicketNotification", "DADecisionDelayed", "DAPourDecision", "CCCCancelled" ], "type": "string" } }, "FromDate": { "format": "date-time", "description": "", "type": "string" }, "ToDate": { "format": "date-time", "description": "", "type": "string" } } }, "UpdateUserResponse": { "description": "UpdateUser response", "type": "object", "properties": { "Id": { "format": "int32", "description": "User profile identifier", "type": "integer" } } }, "Organisation": { "description": "Organisation", "type": "object", "properties": { "Id": { "format": "int32", "description": "Organisation item identifier", "type": "integer" }, "ShadowId": { "format": "int32", "description": "Shadow organisation identifier", "type": "integer" }, "Name": { "description": "Organisation name", "type": "string" }, "Uuid": { "format": "uuid", "description": "GIM UUID", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "GdvType": { "description": "Gdv type", "type": "string" }, "OrganisationType": { "description": "Organisation type", "type": "string" } } }, "ResolveResponse": { "description": "Response data object", "type": "object", "properties": { "ID": { "format": "int32", "description": "Item identifier", "type": "integer" }, "Url": { "description": "Item URL", "type": "string" } } }, "GetSitesFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" } }, "StartDate": { "format": "date-time", "description": "", "type": "string" }, "EndDate": { "format": "date-time", "description": "", "type": "string" }, "LastUpdate": { "format": "date-time", "description": "Only consider items updated after the specified value. Ignored when null.", "type": "string" }, "LastUpdateFrom": { "format": "date-time", "description": "Actually same as above parameter but since we use from and to now and we dont\r\nwant to break the current usage we use this one for the \"new\" functionality.", "type": "string" }, "LastUpdateTo": { "format": "date-time", "description": "Items updated until this date.", "type": "string" } } }, "UploadResponse": { "description": "Response of sites/upload API method", "type": "object", "properties": { "Session": { "format": "int32", "description": "Upload session ID", "type": "integer" }, "Success": { "description": "Upload succeeded", "type": "boolean" }, "ErrorMessage": { "description": "Upload errors", "type": "string" }, "Status": { "description": "Session status", "enum": [ "None", "Started", "Open", "Ongoing", "Closed", "InError" ], "type": "string" }, "Sites": { "description": "Uploaded sites", "type": "array", "items": { "$ref": "#/definitions/SiteResponse" } } } }, "SiteResponse": { "description": "Uploaded site response", "type": "object", "properties": { "ID": { "format": "int32", "description": "Site item identifier", "type": "integer" }, "PowalcoID": { "format": "int32", "description": "Powalco ID (item number)", "type": "integer" }, "Reference": { "description": "External reference", "type": "string" }, "Status": { "description": "Status", "enum": [ "None", "Inscription", "Programmation", "Coordination", "Authorized", "Execution", "AppelCoordination", "Association", "PartAuthorized", "Refused", "ToBeClosed", "Closed", "Canceled", "Informed", "AuthorizationRequest", "Executed", "NoCoordination", "AuthorizationCanceled" ], "type": "string" }, "Error": { "description": "Upload error", "type": "string" } } }, "UpdateCoordinatesResponse": { "description": "Update coordinates response", "type": "object", "properties": { "X": { "format": "double", "description": "", "type": "number" }, "Y": { "format": "double", "description": "", "type": "number" }, "XMin": { "format": "double", "description": "", "type": "number" }, "XMax": { "format": "double", "description": "", "type": "number" }, "YMin": { "format": "double", "description": "", "type": "number" }, "YMax": { "format": "double", "description": "", "type": "number" } } }, "GdvSiteData": { "type": "object", "properties": { "siteId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" }, "surface": { "format": "double", "type": "number" } } }, "GdvSiteImpactData": { "type": "object", "properties": { "siteId": { "format": "uuid", "type": "string", "example": "00000000-0000-0000-0000-000000000000" } } }, "SiteGeoData": { "type": "object", "properties": { "geometries": { "type": "string" } } }, "GetTasksFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Ongoing", "Approved", "NotApplicable", "Rejected", "Canceled", "Closed" ], "type": "string" } }, "Type": { "description": "", "type": "array", "items": { "enum": [ "None", "CreateCCC", "InstructionDA", "AdviceDA", "ExtendDA", "CloseDE", "EndWorks", "ExtraWorks", "ApproveExtendDA", "CreateMeetingDA", "TransferDossier" ], "type": "string" } }, "FromDate": { "format": "date-time", "description": "", "type": "string" }, "ToDate": { "format": "date-time", "description": "", "type": "string" } } }, "ReplyParameters": { "description": "", "type": "object", "properties": { "Reply": { "description": "", "enum": [ "Accepted", "Rejected" ], "type": "string" }, "Comments": { "description": "", "type": "string" } } }, "GetValidationsFieldsFilter": { "description": "", "type": "object", "properties": { "PowalcoId": { "description": "", "type": "array", "items": { "type": "string" } }, "Status": { "description": "", "type": "array", "items": { "enum": [ "None", "Ongoing", "Approved", "Rejected", "Canceled", "Closed", "NotApplicable" ], "type": "string" } }, "FromDate": { "format": "date-time", "description": "", "type": "string" }, "ToDate": { "format": "date-time", "description": "", "type": "string" } } }, "ValidationReplyParameters": { "description": "", "type": "object", "properties": { "Reply": { "description": "", "enum": [ "None", "Approved", "Rejected", "NotApplicable" ], "type": "string" }, "Comments": { "description": "", "type": "string" }, "OrganisationsExtraWork": { "description": "", "type": "array", "items": { "format": "int32", "type": "integer" } } } } }, "securityDefinitions": { "Token": { "type": "apiKey", "description": "API Key Authentication", "name": "Authorization", "in": "header" } } }