{{toc}}

h2. Schema des flux

{{plantuml
autonumber
participant WCS
participant Passerelle
participant RepertoireDeDepot
participant CityWeb

WCS->Passerelle: Envoie de la demande
Passerelle->RepertoireDeDepot: Depot de la demande au format zip
RepertoireDeDepot->CityWeb: Récuperation de la demande et intégration dans CityWeb
}}

h2. Variables à envoyer au connecteur en payload JSON

|_.Nom|_.Obligatoire|_.Valeurs possibles|_.Commentaires|
|applicant_address_city|non| |ville de l'adresse du demandeur|
|applicant_address_complement|non| |complément d'adresse du demandeur|
|applicant_address_country|non| |pays de l'adresse du demandeur|
|applicant_address_county|non| |département de l'adresse du demandeur|
|applicant_address_email|non| |email du demandeur|
|applicant_address_phone|non| |numéro de teléphone du demandeur|
|applicant_address_street|non| |rue de l'adresse du demandeur|
|applicant_address_zipcode|non| |code postal de l'adresse du demandeur|
|applicant_firstnames|*oui*| |prénoms du demandeur|
|applicant_lastname|*oui*| |nom du demandeur|
|applicant_usual_name|non | |nom d'usage du demandeur|
|applicant_status|oui||qualité du demandeur|
|applicant_title|non|M,Mme,Mlle|identifiant titre du demandeur|
|applicant_title_label|non| |titre du demanduer|
|application_id|*oui*| |(N ou M ou D) + année sur 4 + mois sur 2 + numéro de séquence.XML (exemple N20170800764.xml)|
|application_origin|non|internet, guichet, courier|origine de la demande|
|application_reason|non| |motif de la demande|
|application_time|*oui*|__[receipt_time]__|Date de reception de la demande dans WCS|
|certificate_type|*oui*|NAI, MAR, REC, DEC |identifiant du type de certificat|
|certificate_type_label|non| |type de certificat|
|concerned_birth_city|non| |ville de naissance de la personne concernée|
|concerned_birth_country|non| |pays de naissance de la personne concernée|
|concerned_birth_county|non| |département de naissance de la personne concernée|
|concerned_birth_date|non| |date de naissance de la personne concernée|
|concerned_firstnames|*oui*| |prénoms de la personne concernée|
|concerned_lastname|*oui*| |nom de la personne concernée|
|concerned_usual_name|non | |nom d'usage de la personne concernée|
|concerned_parent1_firstnames|non| |prénoms du 1er parent de la personne concernée|
|concerned_parent1_lastname|non| |nom du 1er parent de la personne concernée|
|concerned_parent1_name_usage|non| |nom d'usage du 1er parent de la personne concernée|
|concerned_parent1_title|non| |identifiant titre du 1er parent de la personne concernée|
|concerned_parent1_title_label|non| |titre du 1er parent de la personne concernée|
|concerned_parent1_sex|non| |sexe du 1er parent de la personne concernée|
|concerned_parent2_firstnames|non| |prénoms du 2e parent de la personne concernée|
|concerned_parent2_lastname|non| |nom du 2e parent de la personne concernée|
|concerned_parent2_name_usage|non| |nom d'usage du 2e parent de la personne concernée|
|concerned_parent2_title|non| |identifiant titre du 2e parent de la personne concernée|
|concerned_parent2_title_label|non| |titre du 2e parent de la personne concernée|
|concerned_parent2_sex|non| |sexe du 2e parent de la personne concernée|
|concerned_sex|non|M, F, NA|identifiant sexe de la personne concernée|
|concerned_sex_label|non| |libelé du sexe de la personne concernée|
|concerned_title|non|M,Mme,Mlle|identifiant titre de la personne concernée|
|concerned_title_label|non| |titre de la personne concernée|
|document_copies|*oui*| |nombre d'exemplaire|
|document_type|*oui*|CPI, EXTAF, EXTSF, EXTPL|identifiqnt du type de document|
|document_type_label|non | |type de document(Copie intégrale, Extrait avec filiation, Extrait sans filiation, ...)|
|event_city|non||ville de tenu de l'évènement|
|event_date_end|non| |date de fin de l'évènement dans le cas ou il y'en a|
|event_date_start|*oui*| |date de l'évènement ou date de début de l'évènement|
|partner_birth_city|non| |ville de naissance du partenaire de la personne concernée|
|partner_birth_country|non| |pays de naissance du partenaire de la personne concernée|
|partner_birth_county|non| |département de naissance du partenaire de la personne concernée|
|partner_birth_date|non| |date de naissance du partenaire de la personne concernée|
|partner_firstnames|non| |prénoms du partenaire de la personne concernée|
|partner_lastname|non| |nom du partenaire de la personne concernée|
|partner_usual_name|non | |nom d'usage du partenaire de la personne concernée|
|partner_parent1_firstnames|non| |prénoms du 1er parent du partenaire de la personne concernée|
|partner_parent1_lastname|non| |nom du 1er parent du partenaire de la personne concernée|
|partner_parent1_name_usage|non| |nom d'usage du 1er parent du partenaire de la personne concernée|
|partner_parent1_title|non| |identifiant titre du 1er parent du partenaire de la personne concernée|
|partner_parent1_title_label|non| |titre du 1er parent du partenaire de la personne concernée|
|partner_parent1_sex|non| |sexe du 1er parent du partenaire de la personne concernée|
|partner_parent2_firstnames|non| |prénoms du 2e parent du partenaire de la personne concernée|
|partner_parent2_lastname|non| |nom du 2e parent du partenaire de la personne concernée|
|partner_parent2_name_usage|non| |nom d'usage du 2e parent du partenaire de la personne concernée|
|partner_parent2_title|non| |identifiant titre du 2e parent du partenaire de la personne concernée|
|partner_parent2_title_label|non| |titre du 2e parent du partenaire de la personne concernée|
|partner_parent2_sex|non| |sexe du 2e parent du partenaire de la personne concernée|
|partner_sex|non|M, F, NA|identifiant sexe du partenaire de la personne concernée|
|partner_sex_label|non| |libelé du sexe du partenaire de la personne concernée|
|partner_title|non|M,Mme,Mlle|identifiant du partenaire de la personne concernée|
|partner_title_label|non| |titre du partenaire de la personne concernée|

h2. Sources de données

Le connecteurs vient avec les sources de données ci dessous :

* Civilités: [passerelle_url]cityweb/<slug>/titles/
<pre>
{"data": [{"text": "Monsieur", "id": "M"}, {"text": "Madame", "id": "Mme"}, {"text": "Mademoiselle", "id": "Mlle"}], "err": 0}
</pre>

* Sexes: [passerelle_url]cityweb/<slug>/sexes/
<pre>
{"data": [{"text": "Homme", "id": "M"}, {"text": "Femme", "id": "F"}, {"text": "Autre", "id": "NA"}], "err": 0}
</pre>

* Origines des demandes: [passerelle_url]cityweb/<slug>/origins/
<pre>
{"data": [{"text": "Internet", "id": "internet"}, {"text": "Guichet", "id": "guichet"}, {"text": "Courrier", "id": "courrier"}], "err": 0}
</pre>

* Statuts de la personne concernée par la demande: [passerelle_url]cityweb/<slug>/concerned/
<pre>
{"data": [{"text": "Reconnu", "id": "reconnu"}, {"text": "Auteur", "id": "auteur"}], "err": 0}
</pre>

* Types de certificat: [passerelle_url]cityweb/<slug>/certificate-types/
<pre>
{"data": [{"text": "Naissance", "id": "NAI"}, {"text": "Mariage", "id": "MAR"}, {"text": "Décès", "id": "DEC"}], "err": 0}
</pre>

* Types de docment: [passerelle_url]cityweb/<slug>/document-types/
<pre>
{"data": [{"text": "Copie intégrale", "id": "CPI"}, {"text": "Extrait avec filiation", "id": "EXTAF"}, {"text": "Extrait sans filiation", "id": "EXTSF"}, {"text": "Extrait plurilingue", "id": "EXTPL"}], "err": 0}
</pre>

h2. Récupération des archives des demandes

host recette: passerelle.test.entrouvert.org

<pre>
# rsync <host>:cityweb/*.zip <chemin_repertoire_local>
</pre>