~~~~

h1. Idée abandonnée avec #16768.

~~~~

!https://perso.entrouvert.org/~fred/why-would-you-abandon-me.jpg!


~~~~

h1. Connecteur État Civil

Cette page décrit l'interface commune qui doit être utilisée par tous les connecteurs type État Civil dans Passerelle.

Déclinaison mise en place sur instance de test d'Orléans :
* formulaire = https://demarches-orleans.test.entrouvert.org/backoffice/forms/82/
* WF = https://demarches-orleans.test.entrouvert.org/backoffice/workflows/44/

h2. Les variables

|_.Nom|_.Type|_.Obligatoire|_.Valeurs possibles|_.Commentaires|
|application_id|string|*oui*||(display_id)|
|application_time|string|*oui*||(receipt_time)|
|certificate_type|string|*oui*|birth, marriage, death, other||
|certificate_type_label|string|non||e.g Acte de Naissance|
|document_type|string|*oui*|full, multilingual, with-filiation, without-filiation ||
|document_type_label|string|non|| e.g Copie intégrale, plurilingue, extrait avec filiation, extrait sans filiation|
|document_copies|integer|non|||
|event_city|string|non|||
|event_date_start|date|non||format ISO|
|event_date_end|date|non||format ISO|
|application_reason|string|non|| motif de la demande|
|application_comment|string|non||commentaire sur la demande|
|application_city|string|non|| nom de la ville à qui la demande est adressée|
|application_city_inseecode|string|non|| code INSEE de la ville à qui la demande est adressée|
|application_city_zipcode|string|non|| code postal de la ville à qui la demande est adressée|
|applicant_is_concerned|boolean|non|true,false| définit si le demandeur est aussi le titulaire de l'acte|
|application_priority|string|non||définit la priorité de la demande|

h4. Variables relatives au demandeur

|_.Nom|_.Type|_.Obligatoire|_.Valeurs possibles|_.Commentaires|
|applicant_title|string|non|mr, ms, mx||
|applicant_title_label|string|non|||
|applicant_lastname|string|*oui*|||
|applicant_firstnames|string|*oui*|||
|applicant_usual_name|string|non|||
|applicant_email|string|non|||
|applicant_phone|string|non|||
|applicant_type|string|non||mairie, avocat, notaire, administration, particulier, ...|
|applicant_status|string|*oui*|concerned, partner, parent, child, grand-parent, grand-child, heir, representative, other|personne concernée, conjoint(e),  parent, enfant, grand-père ou grand-mère, petit(e) fils/fille, héritier, représentant légal|
|applicant_status_label|string|non|||
|applicant_address_street_number|string|non|| numéro de la voie|
|applicant_address_street_type|string|non|| type de la voie|
|applicant_address_street|string|non|||
|applicant_address_complement|string|non|||
|applicant_address_city|string|non|||
|applicant_address_zipcode|string|non|||
|applicant_address_country|string|non||@Code ISO@ ou @nom du pays@ en fonction du connecteur|

h4. Variables relatives à l'intéressé

|_.Nom|_.Type|_.Obligatoire|_.Valeurs possibles|_.Commentaires|
|concerned_title|string|non|mr, ms, mx||
|concerned_title_label|string|non||e.g monsieur, madame, neutre|
|concerned_firstnames|string|*oui*|||
|concerned_lastname|string|*oui*|||
|concerned_usual_name|string|non|||
|concerned_birthdate|date|non||format ISO|
|concerned_birthcountry|string|non||@Code ISO@ ou @nom du pays@ en fonction du connecteur|
|concerned_birthcity|string|non|||
|concerned_birthcounty|string|non||Département|
|concerned_sex|string|non|m, f, o|Homme, femme ou autre|
|concerned_citizenship|string|non|||

h4. Variables relatives au partenaire de l'intéressé

|_.Nom|_.Type|_.Obligatoire|_.Valeurs possibles|_.Commentaires|
|partner_title|string|non|mr, ms, mx||
|partner_title_label|string|non||e.g monsieur, madame, neutre|
|partner_firstnames|string|non|||
|partner_lastname|string|non|||
|partner_usual_name|string|non|||
|partner_birthdate|date|non||format ISO|
|partner_birthcountry|string|non|||
|partner_birthcity|string|non|||
|partner_birthcounty|string|non||Département|
|partner_sex|string|non|m, f, o|Homme, femme ou autre|
|partner_citizenship|string|non|||

h4. Variables relatives aux parents de l'intéréssé ou de son/sa partenaire

|_.Nom|_.Type|_.Obligatoire|_.Valeurs possibles|_.Commentaires|
|{concerned,partner}_{parent1,parent2}_title|string|non|mr, ms, mx|monsieur, madame, neutre|
|{concerned,partner}_{parent1,parent2}_firstnames|string|non|||
|{concerned,partner}_{parent1,parent2}_lastname|string|non|||
|{concerned,partner}_{parent1,parent2}_sex|string|non|m, f, o|Homme, femme ou autre|

h2. Les URL

h3. Création d'une demande

* @/<connector>/<slug>/create/@

Avec le payload json:
<pre>
{
  "display_id": 123, 
  "receipt_time": "2017-07-01T00:00:00",
  "certificate_type": "Acte de Mariage",
  "certificate_type_raw": "MAR",
  "document_type": "Extrait avec filiation",
  "document_type_raw": "EF",
  "document_copies": 3,
  "concerned_firstnames": "Johnny Jumper",
  "concerned_lastname": "Doe",
  "concerned_birthdate": "1980-07-07",
  "concerned_birthcity": "Nantes",
  "concerned_birthcountry": "France",
  "applicant_firstnames": "Kevin",
  "applicant_lastname": "Troll",
  "applicant_address_street": "27 Blvd Henry Orion",
  "applicant_address_city": "Nantes",
  "applicant_address_zipcode": 44000,
  "concerned_parent2_firstnames": "Kim",
  "concerned_parent2_lastname": "Sung-Ho",
  "partner_firstnames": "Chelsea Ruth",
  "partner_lastname": "Whatever",
  "event_date": "2014-05-07"
}
</pre>

Le retour attendu est un json contenant la clé @demand_id@ i.e. :
<pre>
{
 "err": 0,
 "data": {
     "demand_id": "123-MAR-0"
 }
}
</pre>

h3. Récupération du statut d'une demande

Dans le cas où le connecteur peut le permettre, l'URL de récupération du statut d'une demande sera comme suit :

* @/<connector>/<slug>/status/<demand_id>/@

La réponse renvoyée doit au minimum avoir les clés @status@ et @closed@ (Boolean).

<pre>
{
  "err": 0,
  "data":{
   "status": "rejected", 
   "closed": true, 
   "comment": "Invalid demand"
  }
}
</pre>

h3. Sources de données

* *application-reasons*: @/<connector>/<slug>/datasources/application-reasons/@
<pre>
{
   "err" : 0,
   "data" : [
      {
         "id" : "id-card",
         "text" : "Carte nationale d'identité"
      },
      {
         "id" : "passport",
         "text" : "Passeport"
      },
      {
         "id" : "citizenship-certificate",
         "text" : "Certificat de nationalité française"
      },
      {
         "id" : "mariage",
         "text" : "Mariage"
      },
      {
         "text" : "Pension",
         "id" : "pension"
      },
      {
         "text" : "Procédure judiciaire",
         "id" : "judiciary"
      },
      {
         "id" : "pacs",
         "text" : "Pacte civil de solidarité"
      },
      {
         "id" : "notary-act",
         "text" : "Acte notaire"
      },
      {
         "id" : "other",
         "text" : "Autre"
      }
   ]
}
</pre>

* *applicant-status*: @/<connector>/<slug>/datasources/applicant-status/@
<pre>
{
   "data" : [
      {
         "text" : "Son fils ou sa fille",
         "id" : "child"
      },
      {
         "id" : "concerned",
         "text" : "La personne concernée par l'acte"
      },
      {
         "text" : "Son grand-père ou sa grand-mère",
         "id" : "grand-parent"
      },
      {
         "id" : "heir",
         "text" : "Son héritier"
      },
      {
         "id" : "parent",
         "text" : "Son père ou sa mère"
      },
      {
         "text" : "Son conjoint ou sa conjointe",
         "id" : "partner"
      },
      {
         "id" : "grand-child",
         "text" : "Son petit-fils ou sa petite-fille"
      },
      {
         "text" : "Son représentant légal",
         "id" : "representative"
      },
      {
         "text" : "Autre",
         "id" : "other"
      }
   ],
   "err" : 0
}
</pre>

* *certificate-types*: /<connector>/<slug>/datasources/certificate-types/ 
<pre>
{
   "err" : 0,
   "data" : [
      {
         "text" : "Naissance",
         "id" : "birth"
      },
      {
         "text" : "Mariage",
         "id" : "mariage"
      },
      {
         "id" : "death",
         "text" : "Décès"
      }
   ]
}
</pre>

* *document-types*: /<connector>/<slug>/datasources/document-types/
<pre>
{
   "err" : 0,
   "data" : [
      {
         "id" : "full",
         "text" : "Copie intégrale"
      },
      {
         "id" : "with-filiation",
         "text" : "Extrait avec filiation"
      },
      {
         "text" : "Extrait sans filiation",
         "id" : "without-filiation"
      },
      {
         "id" : "multilingual",
         "text" : "Extrait plurilingue"
      }
   ]
}
</pre>

* *titles*: /<connector>/<slug>/datasources/titles/
<pre>
{
   "data" : [
      {
         "text" : "Monsieur",
         "id" : "mr"
      },
      {
         "text" : "Madame",
         "id" : "ms"
      },
      {
         "text" : "Autre",
         "id" : "mx"
      }
   ],
   "err" : 0
}
</pre>