CommunicationRequest

Type: object

The communication request sent by Protools to the communication service

root id
Type: stringFormat: uuid

Identifiant technique de la demande de communication / Technical identifer of the communication request

root interrogationId
Type: stringFormat: uuid

Identifiant de l'interrogation au format UUID généré par REM // Technical identifier for the interrogation

root partitionId
Type: stringFormat: uuid

Identifiant du lot au format UUID généré par le CPIE. Correspond à partitionId du fichier de contexte. // Partition identifier to which the interrogation belongs

root communicationId
Type: stringFormat: uuid

Identifiant de la communication // Identifier of communication

root usualSurveyUnitId
Type: string

Identifiant métier. Pour les enquêtes entreprises, ça correspond au siren/siret/num asso. Affiché dans les plateformes de collecte et sur les courriers entreprises. // Business name/identifier that is displayed to users for interrogation. Not necessarily unique. For display.

root corporateName
Type: string

Raison sociale de l'unité enquêtée (pas utilisé dans les enquêtes ménage). Utilisée pour affichage dans Platine et dans les courriers et les mails // Registered name of the surveyed unit (not relevant for household surveys). Used for display in Platine and in letters and emails.

root unitLabel
Type: string

Label de l'unité enquêtée (pas utilisé dans les enquêtes ménage). Utilisée pour affichage dans Platine et dans les courriers et les mails. Exemple : entreprise, établissement, association... // Registered name of the surveyed unit (not relevant for household surveys). Used for display in Platine and in letters and emails.

root previousReminderCount
Type: string

Nombre de relances précédentes // Number of previous reminders

root lastReminderLetterSentDate
Type: stringFormat: date-time

Date d'envoi de la dernière relance par courrier. // Date the last reminder letter was sent.

root formalNoticeSentDate
Type: stringFormat: date-time

Date d'envoi de la mise en demeure. // Date the formal notice was sent.

root extCommunicationData

FlexibleKeyValueMap

Type: array

Un tableau contenant plusieurs FlexibleKeyValueMapEntry

 No Additional Items

Each item of this array must be:

root extCommunicationData extCommunicationData items

root extCommunicationData extCommunicationData items oneOf EntryStringVal

EntryStringVal

Type: object
No Additional Properties

root extCommunicationData extCommunicationData items oneOf EntryStringVal type
Type: const
Specific value: "string"
root extCommunicationData extCommunicationData items oneOf EntryBooleanVal

EntryBooleanVal

Type: object
No Additional Properties

root extCommunicationData extCommunicationData items oneOf EntryBooleanVal type
Type: const
Specific value: "boolean"

root recipients
Type: array of object

Une liste de destinataires // A list of recipients

 No Additional Items

Each item of this array must be:

root recipients Recipient

Recipient

Type: object

Destinataire de la communication // recipent of the communication

 No Additional Properties

root recipients Recipient gender
Type: enum (of string)

Civilité du contact // Contact civility

Must be one of:

  • "M"
  • "MME"
  • ""

root recipients Recipient lastName
Type: string

nom de famille // Last name

root recipients Recipient addressL1
Type: string

ligne1 de l'adresse // address line 1

root recipients Recipient addressL2
Type: string

ligne2 de l'adresse // address line 2

root recipients Recipient addressL3
Type: string

ligne3 de l'adresse // address line 3

root recipients Recipient addressL4
Type: string

ligne4 de l'adresse // address line 4

root recipients Recipient addressL5
Type: string

ligne5 de l'adresse // address line 5

root recipients Recipient addressL6
Type: string

ligne6 de l'adresse // address line 6

root recipients Recipient addressL7
Type: string

ligne7 de l'adresse // address line 7

root recipients Recipient webConnectionId
Type: string

Identifiant de connexion au portail de collecte web. A remplir si connu, sinon, il est créé durant le processus d'intégration. // Web connection identifier.

root recipients Recipient zipCode
Type: string

Code postal du destinataire // Recipient Zip code

root recipients Recipient generatePassword
Type: boolean

envoi avec génération du mot de passe / send with password generation

root recipients Recipient email
Type: string

Email du destinataire // Recipient email