From 3047a1319b56f4976de52263b39a75398db43cd8 Mon Sep 17 00:00:00 2001
From: Josue Kouka
Date: Mon, 6 Aug 2018 16:28:41 +0200
Subject: [PATCH] dpark: add a detailed documentation of endpoints (#25491)
---
.../dpark/templates/dpark/dpark_detail.html | 1038 +++++++++++++++++
1 file changed, 1038 insertions(+)
create mode 100644 passerelle/contrib/dpark/templates/dpark/dpark_detail.html
diff --git a/passerelle/contrib/dpark/templates/dpark/dpark_detail.html b/passerelle/contrib/dpark/templates/dpark/dpark_detail.html
new file mode 100644
index 0000000..5e467b2
--- /dev/null
+++ b/passerelle/contrib/dpark/templates/dpark/dpark_detail.html
@@ -0,0 +1,1038 @@
+{% extends "passerelle/manage/service_view.html" %}
+{% load i18n passerelle %}
+
+{% block endpoints %}
+
+
+
+
+ {% trans 'Check WSDL availability' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="ping" as endpoint_ping %}
+ GET {{ endpoint_ping }}
+
+
+ -
+
{% trans 'Search user subscription' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="search" as endpoint_search %}
+ GET {{ endpoint_search }}
+ {% trans 'Paranmeters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ firstnames |
+ O |
+ |
+ Prénoms |
+
+
+ lastname |
+ O |
+ |
+ Noms |
+
+
+ filenumber |
+ O |
+ |
+ Numéro de dossier |
+
+
+ badgenumber |
+ N |
+ |
+ Numéro de badge |
+
+
+ cardnumber |
+ N |
+ |
+ Numéro de badge |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+ -
+
{% trans 'Link user to a subscription' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="link" as endpoint_link %}
+ GET {{ endpoint_link }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ nameid |
+ O |
+ |
+ Identifiant Publik |
+
+
+
+ firstnames |
+ O |
+ |
+ Prénoms |
+
+
+ lastname |
+ O |
+ |
+ Noms |
+
+
+ filenumber |
+ O |
+ |
+ Numéro de dossier |
+
+
+ badgenumber |
+ N |
+ |
+ Numéro de badge |
+
+
+ cardnumber |
+ N |
+ |
+ Numéro de badge |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+ -
+
{% trans 'Unlink user to subscriptions' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="unlink" as endpoint_unlink %}
+ POST {{ endpoint_unlink }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ nameid |
+ O |
+ |
+ Identifiant Publik |
+
+
+
+ firstnames |
+ |
+ |
+ Prénoms |
+
+
+ lastname |
+ |
+ |
+ Noms |
+
+
+ filenumber |
+ |
+ |
+ Numéro de dossier |
+
+
+ badgenumber |
+ |
+ |
+ Numéro de badge |
+
+
+ cardnumber |
+ |
+ |
+ Numéro de badge |
+
+
+
+ {% trans 'You can filter subscriptions by supplying non required parameters' %}
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+ -
+
{% trans 'Get subscriber informations' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="infos" as endpoint_infos %}
+ GET {{ endpoint_infos }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ nameid |
+ O |
+ |
+ Identifiant Publik |
+
+
+ firstnames |
+ O |
+ |
+ Prénoms |
+
+
+ lastname |
+ O |
+ |
+ Noms |
+
+
+ filenumber |
+ O |
+ |
+ Numéro de dossier |
+
+
+ badgenumber |
+ N |
+ |
+ Numéro de badge |
+
+
+ cardnumber |
+ N |
+ |
+ Numéro de badge |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": [
+ {
+ "adresse_boitepostalelieudit": null,
+ "adresse_codepostal": "31000",
+ "adresse_codesti": "315553609666",
+ "adresse_etageescalierappartement": null,
+ "adresse_extension": 1,
+ "adresse_immeublebatimentresidence": null,
+ "adresse_localite": "TOULOUSE",
+ "adresse_nomvoie": "All\u00e9es Jean Jaur\u00e8s",
+ "adresse_numerovoie": 80,
+ "adresse_quartier": "PERI",
+ "demande_datedebutabo": "20180625",
+ "demande_datefinabo": "20190624",
+ "demande_delaiautorise": 30,
+ "demande_immatvehicule1": "CX453AD",
+ "demande_immatvehicule2": null,
+ "demande_marquevehicule1": "CITROEN",
+ "demande_marquevehicule2": null,
+ "demande_modelevehicule1": "GS",
+ "demande_modelevehicule2": null,
+ "demande_numerodossier": 22952,
+ "demandeur_civilite": 1,
+ "demandeur_email": "foo@bar.org",
+ "demandeur_nomusuel": "Mercier",
+ "demandeur_prenom": "Eric",
+ "demandeur_telephonefixe": "0611111111",
+ "demandeur_telephoneportable": null
+ },
+ ],
+ "err": 0
+ }
+
+
+
+ -
+
{% trans 'Register a subscription application' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="register" as endpoint_register %}
+ POST {{ endpoint_register }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ applicant_title |
+ O |
+ 1 ou 2 |
+ Civilité du demandeur. 1 pour Monsieur, 2 pour Madame |
+
+
+ applicant_lastname |
+ O |
+ |
+ Nom du demandeur |
+
+
+ applicant_firstnames |
+ O |
+ |
+ Prénoms du demandeur |
+
+
+ applicant_phone |
+ |
+ |
+ Téléphone fixe du demandeur |
+
+
+ applicant_mobilephone |
+ |
+ |
+ Téléphone mobile du demandeur |
+
+
+ applicant_email |
+ O |
+ |
+ Courriel du demandeur |
+
+
+ address_complement1 |
+ |
+ |
+ Etage, escalier ou numero d'appartement |
+
+
+ address_complement2 |
+ |
+ |
+ Immeuble, batiment ou residence |
+
+
+ address_streetno |
+ |
+ |
+ Numero de voie |
+
+
+ address_streetext |
+ |
+ 1,2,3,4 |
+ Extension de rue avec 1 pour Vide, 2 pour BIS, 3 pour TER et 4 pour QUATER |
+
+
+ address_streetname |
+ |
+ |
+ Nom de la voie |
+
+
+ address_sticode |
+ O |
+ |
+ Code STI de l'adresse |
+
+
+ address_place |
+ |
+ |
+ Boite postale, lieu-dit |
+
+
+ address_zipcode |
+ O |
+ |
+ Code postal |
+
+
+ address_locality |
+ O |
+ |
+ Localité |
+
+
+ address_district |
+ O |
+ |
+ Quartier |
+
+
+ application_id |
+ O |
+ |
+ Numero de la demande |
+
+
+ application_type |
+ O |
+ 1,2 |
+ Type de demande avec 1 pour Badge et 2 pour Carte |
+
+
+ filenumber |
+ |
+ |
+ Numéro de dossier Dpark. Si renseigné, la demande est un renouvellement |
+
+
+ application_car1_exemption |
+ O |
+ |
+ Cas d'éligibilité du véhicule 1 (cf cas éligibilité) |
+
+
+ application_car1_model |
+ O |
+ |
+ Modele du véhicule 1 |
+
+
+ application_car1_brand |
+ O |
+ |
+ Marque du véhicule 1 |
+
+
+ application_car1_plate |
+ O |
+ |
+ Immatriculation du véhicule 1 |
+
+
+ application_car2_exemption |
+ |
+ |
+ Cas d'éligibilité du véhicule 2 (cf cas éligibilité) |
+
+
+ application_car2_model |
+ |
+ |
+ Modele du véhicule 2 |
+
+
+ application_car2_brand |
+ |
+ |
+ Marque du véhicule 2 |
+
+
+ application_car2_plate |
+ |
+ |
+ Immatriculation du véhicule 2 |
+
+
+ application_thirdparty_subscription |
+ O |
+ True,False |
+ Abonnement tiers |
+
+
+ application_payment_type |
+ O |
+ 5,10 |
+ Type de paiement, avec 5 pour prélevement mensualisé et 10 pour carte bancaire via internet |
+
+
+ application_bank_name |
+ |
+ |
+ Nom de la banque du demandeur |
+
+
+ application_bank_address1 |
+ |
+ |
+ Ligne 1 de l'adresse de la banque |
+
+
+ application_bank_address2 |
+ |
+ |
+ Ligne 2 de l'adresse de la banque |
+
+
+ application_bank_zipcode |
+ |
+ |
+ Code postal de la banque |
+
+
+ application_bank_city |
+ |
+ |
+ Ville ou se situe l'agence bancaire |
+
+
+ application_bank_iban |
+ |
+ |
+ Numéro IBAN du compte bancaire |
+
+
+ application_bank_bic |
+ |
+ |
+ Numéro d'identification de la banque |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": {
+ "numerodossier": "22334",
+ "numerodemande": "59492"
+ },
+ "err": 0
+ }
+
+
+
+ -
+
{% trans 'Send supporting documents' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="send-files" as endpoint_send_files %}
+ POST {{ endpoint_send_files }}
+
+
+
+
+ Code |
+ Slug |
+ Description |
+
+
+
+
+ 2 |
+ justif_domicile |
+ Justificatif de domicile ( moins 3 mois) |
+
+
+ 4 |
+ assurance |
+ Attestation d'assurance (Conducteur principal) |
+
+
+ 6 |
+ cartegrise |
+ Carte grise |
+
+
+ 8 |
+ carte_medecin |
+ Carte d'ordre des medecins |
+
+
+ 9 |
+ immat_artisanat_d1 |
+ Immatriculation Chambre Métiers et de l'Artisanat ( D1 ) |
+
+
+ 10 |
+ agrement |
+ Agrément : Assoc ou Entreprise |
+
+
+ 11 |
+ attest_employeur |
+ Attestation employeur (Usage privé et pro ) |
+
+
+ 13 |
+ taxe_habitat |
+ Taxe d'Habitation ou Bail ou Acte notarié |
+
+
+ 14 |
+ abt_transport |
+ Abt Annuel transport en commun ( Tisséo, SNCF actif pro) |
+
+
+ 16 |
+ contrat_locvehicule |
+ Contrat de location (Véhicule) |
+
+
+ 17 |
+ impot_revenu |
+ Impôt sur le revenu |
+
+
+ 18 |
+ carteverte |
+ Attestation d'Assurance (Carte Verte) |
+
+
+ 19 |
+ decla_impot |
+ Déclaration Impôt revenu (Enfant rattaché) |
+
+
+ 20 |
+ assurance_pro |
+ Attestation d'Assurance (Usage Professionnel) |
+
+
+ 21 |
+ cotis_urssaf |
+ Cotisation à l’URSSAF |
+
+
+ 22 |
+ ordonnance |
+ Ordonnance (Attest sur l'honneur Médecin) |
+
+
+ 25 |
+ attest_employeurpro |
+ Attestation Employeur (Usage Pro du Véhicule Perso) |
+
+
+ 26 |
+ attest_honneur |
+ Attestation sur l'honneur (Professionnel de l’Urgence) |
+
+
+ 27 |
+ attest_cpam |
+ Attestation CPAM avec le numéro de conventionnement (TAP) |
+
+
+ 28 |
+ cartegrise_qe |
+ Carte grise avec mention de la qualité électrique |
+
+
+ 29 |
+ contrat_livraison |
+ Contrat de livraison entre le pro et le commerce ou attest livraison régulière (signature du pro et du commerçant |
+
+
+ 30 |
+ immat_artisanat |
+ Immatriculation au registre des métiers et de l'artisanat ou au registre du commerce |
+
+
+ 31 |
+ immat_artisanat_ape |
+ Immatriculation au registre des métiers et de l'artisanat ou au registre du commerce (avec mention code APE) |
+
+
+
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ application_external_id |
+ O |
+ |
+ Numéro de télédossier reçu lors de l'enregistrement de la demande e.g E-8-0AA666BB |
+
+
+ application_id |
+ O |
+ |
+ Numéro de demande e.g 59492 |
+
+
+ document_slug |
+ |
+ |
+ Type de document |
+
+
+ document_slug,1 |
+ |
+ |
+ Type de document |
+
+
+ document_slug,N |
+ |
+ |
+ Type de document |
+
+
+
+ Dans le cas ou l'on veut envoyer plusieur fois le meme type de document, déclare plusieurs variables dont les noms sont document_slug,numero e.g
+
+ {
+ "cartegrise,1": ....,
+ "cartegrise,2": ....
+ }
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+
+ {% trans 'Check if address is eligible' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="address-eligibility" as endpoint_address_eligibility %}
+ GET {{ endpoint_address_eligibility }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ address_sticode |
+ O |
+ |
+ Code STI |
+
+
+ address_locality |
+ O |
+ |
+ Nom de la localité |
+
+
+ address_zipcode |
+ O |
+ |
+ Code postal |
+
+
+ address_complement1 |
+ |
+ |
+ Premier complement d'adresse: etage appartememt, escalier |
+
+
+ address_complement2 |
+ |
+ |
+ Second complement d'adresse: immeuble, batiment, residence |
+
+
+ address_streetno |
+ |
+ |
+ Numero de rue |
+
+
+ address_streetext |
+ |
+ |
+ Numero d'extension de rue |
+
+
+ address_streetname |
+ |
+ |
+ Nom de rue |
+ |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+
+ {% trans 'Get payment information' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="payment-info" rest='abcde/' as endpoint_payment_info %}
+ GET {{ endpoint_payment_info }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ filenumber |
+ |
+ |
+ Numéro de dossier |
+
+
+
+ Si un numéro de dossier est passé (filenumber), seul les informations relatives à ce numéro de dossier seront remontées
+ {% trans 'Response' %}
+
+ {
+ "data": [
+ {
+ "typepaiement_text": "Carte Bancaire via Internet",
+ "numerodemande": 61718,
+ "montant": 135,
+ "numeroteledossierphase1": "E-8-N5UTAK6P",
+ "typepaiement": 10
+ }
+ ],
+ "err": 0
+ }
+
+
+
+
+ {% trans 'Notify a payment' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="notify-payment" as endpoint_notify_payment %}
+ POST {{ endpoint_notify_payment }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ application_external_id |
+ O |
+ |
+ Numero de teledossier |
+
+
+ application_id |
+ O |
+ |
+ Numero de demande |
+
+
+ filenumer |
+ O |
+ |
+ Numero de dossier |
+
+
+ nameid |
+ O |
+ |
+ Identifiant de l'utilisateur |
+
+
+ total_amount |
+ O |
+ |
+ Montant total |
+
+
+ transaction_datetime |
+ O |
+ |
+ Date et heure de la transaction |
+
+
+ transaction_id |
+ O |
+ |
+ Numero de transaction |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+
+ {% trans 'Check if renewal time has not expired' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="check-renewal-time" as endpoint_check_renewal_time %}
+ GET {{ endpoint_check_renewal_time }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ filenumber |
+ O |
+ |
+ Numéro de dossier |
+
+
+ firstnames |
+ O |
+ |
+ Prénoms de l'abonné |
+
+
+ lastname |
+ O |
+ |
+ Nom de l'abonne |
+
+
+ badgenumber |
+ |
+ |
+ Numéro de badge |
+
+
+ cardnumber |
+ |
+ |
+ Numéro de carte |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+
+ {% trans 'Check if renewal request is not a duplicate' %}
+ {% trans 'Request' %}
+ {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="check-renewal-duplicate" as endpoint_check_renewal_duplicate %}
+ GET {{ endpoint_check_renewal_duplicate }}
+ {% trans 'Parameters' %}
+
+
+
+ {% trans 'Name' %} |
+ {% trans 'Required' %} |
+ {% trans 'Values' %} |
+ {% trans 'Description' %} |
+
+
+
+
+ filenumber |
+ O |
+ |
+ Numéro de dossier |
+
+
+ firstnames |
+ O |
+ |
+ Prénoms de l'abonné |
+
+
+ lastname |
+ O |
+ |
+ Nom de l'abonne |
+
+
+ badgenumber |
+ |
+ |
+ Numéro de badge |
+
+
+ cardnumber |
+ |
+ |
+ Numéro de carte |
+
+
+
+ {% trans 'Response' %}
+
+ {
+ "data": True,
+ "err": 0
+ }
+
+
+
+
+{% endblock %}
+
+{% block security %}
+{% access_rights_table resource=object permission='can_access' %}
+{% endblock %}
--
2.18.0