Projet

Général

Profil

0001-dpark-add-a-detailed-documentation-of-endpoints-2549.patch

Josué Kouka, 06 août 2018 17:12

Télécharger (37,4 ko)

Voir les différences:

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
passerelle/contrib/dpark/templates/dpark/dpark_detail.html
1
{% extends "passerelle/manage/service_view.html" %}
2
{% load i18n passerelle %}
3

  
4
{% block endpoints %}
5

  
6
<style>
7
    table.params {text-align: center;}
8
</style>
9

  
10
<ul>
11
    <li><h3>{% trans 'Check WSDL availability' %}</h3>
12
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="ping" as endpoint_ping %}
13
        <strong>GET</strong> <a href="{{ endpoint_ping }}">{{ endpoint_ping }}</a>
14
    </li>
15

  
16
    <li>
17
        <h3>{% trans 'Search user subscription' %}</h3>
18
        <h4>{% trans 'Request' %}</h4>
19
            {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="search" as endpoint_search %}
20
            <strong>GET</strong> <a href="{{ endpoint_search }}">{{ endpoint_search }}</a>
21
        <h4>{% trans 'Paranmeters' %}</h4>
22
        <table class="main params">
23
            <thead>
24
                <tr>
25
                    <th>{% trans 'Name' %}</th>
26
                    <th>{% trans 'Required' %}</th>
27
                    <th>{% trans 'Values' %}</th>
28
                    <th>{% trans 'Description' %}</th>
29
                </tr>
30
            </thead>
31
            <tbody>
32
                <tr>
33
                    <td>firstnames</td>
34
                    <td>O</td>
35
                    <td></td>
36
                    <td>Prénoms</td>
37
                </tr>
38
                <tr>
39
                    <td>lastname</td>
40
                    <td>O</td>
41
                    <td></td>
42
                    <td>Nom</td>
43
                </tr>
44
                <tr>
45
                    <td>filenumber</td>
46
                    <td>O</td>
47
                    <td></td>
48
                    <td>Numéro de dossier</td>
49
                </tr>
50
                <tr>
51
                    <td>badgenumber</td>
52
                    <td></td>
53
                    <td></td>
54
                    <td>Numéro de badge</td>
55
                </tr>
56
                <tr>
57
                    <td>cardnumber</td>
58
                    <td></td>
59
                    <td></td>
60
                    <td>Numéro de carte</td>
61
                </tr>
62
            </tbody>
63
        </table>
64
        <h4>{% trans 'Response' %}</h4>
65
        <pre>
66
        {
67
            "data": True,
68
            "err": 0
69
        }
70
        </pre>
71
    </li>
72

  
73
    <li>
74
        <h3>{% trans 'Link user to a subscription' %}</h3>
75
        <h4>{% trans 'Request' %}</h4>
76
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="link" as endpoint_link %}
77
        <strong>GET</strong> <a href="{{ endpoint_link }}">{{ endpoint_link }}</a>
78
        <h4>{% trans 'Parameters' %}</h4>
79
        <table class="main params">
80
            <thead>
81
                <tr>
82
                    <th>{% trans 'Name' %}</th>
83
                    <th>{% trans 'Required' %}</th>
84
                    <th>{% trans 'Values' %}</th>
85
                    <th>{% trans 'Description' %}</th>
86
                </tr>
87
            </thead>
88
            <tbody>
89
                <tr>
90
                    <td>nameid</td>
91
                    <td>O</td>
92
                    <td></td>
93
                    <td>Identifiant Publik</td>
94
                </tr>
95

  
96
                <tr>
97
                    <td>firstnames</td>
98
                    <td>O</td>
99
                    <td></td>
100
                    <td>Prénoms</td>
101
                </tr>
102
                <tr>
103
                    <td>lastname</td>
104
                    <td>O</td>
105
                    <td></td>
106
                    <td>Nom</td>
107
                </tr>
108
                <tr>
109
                    <td>filenumber</td>
110
                    <td>O</td>
111
                    <td></td>
112
                    <td>Numéro de dossier</td>
113
                </tr>
114
                <tr>
115
                    <td>badgenumber</td>
116
                    <td></td>
117
                    <td></td>
118
                    <td>Numéro de badge</td>
119
                </tr>
120
                <tr>
121
                    <td>cardnumber</td>
122
                    <td></td>
123
                    <td></td>
124
                    <td>Numéro de carte</td>
125
                </tr>
126
            </tbody>
127
        </table>
128
        <h4>{% trans 'Response' %}</h4>
129
        <pre>
130
        {
131
            "data": True,
132
            "err": 0
133
        }
134
        </pre>
135
    </li>
136

  
137
    <li>
138
        <h3>{% trans 'Unlink user to subscriptions' %}</h3>
139
        <h4>{% trans 'Request' %}</h4>
140
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="unlink" as endpoint_unlink %}
141
        <strong>POST</strong> <a href="{{ endpoint_unlink }}">{{ endpoint_unlink }}</a>
142
        <h4>{% trans 'Parameters' %}</h4>
143
        <table class="main params">
144
            <thead>
145
                <tr>
146
                    <th>{% trans 'Name' %}</th>
147
                    <th>{% trans 'Required' %}</th>
148
                    <th>{% trans 'Values' %}</th>
149
                    <th>{% trans 'Description' %}</th>
150
                </tr>
151
            </thead>
152
            <tbody>
153
                <tr>
154
                    <td>nameid</td>
155
                    <td>O</td>
156
                    <td></td>
157
                    <td>Identifiant Publik</td>
158
                </tr>
159

  
160
                <tr>
161
                    <td>firstnames</td>
162
                    <td></td>
163
                    <td></td>
164
                    <td>Prénoms</td>
165
                </tr>
166
                <tr>
167
                    <td>lastname</td>
168
                    <td></td>
169
                    <td></td>
170
                    <td>Nom</td>
171
                </tr>
172
                <tr>
173
                    <td>filenumber</td>
174
                    <td></td>
175
                    <td></td>
176
                    <td>Numéro de dossier</td>
177
                </tr>
178
                <tr>
179
                    <td>badgenumber</td>
180
                    <td></td>
181
                    <td></td>
182
                    <td>Numéro de badge</td>
183
                </tr>
184
                <tr>
185
                    <td>cardnumber</td>
186
                    <td></td>
187
                    <td></td>
188
                    <td>Numéro de carte</td>
189
                </tr>
190
            </tbody>
191
        </table>
192
        <p>{% trans 'You can filter subscriptions by supplying non required parameters' %} </p>
193
        <h4>{% trans 'Response' %}</h4>
194
        <pre>
195
        {
196
            "data": True,
197
            "err": 0
198
        }
199
        </pre>
200
    </li>
201

  
202
    <li>
203
        <h3>{% trans 'Get subscriber informations' %}</h3>
204
        <h4>{% trans 'Request' %}</h4>
205
            {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="infos" as endpoint_infos %}
206
            <strong>GET</strong> <a href="{{ endpoint_infos }}">{{ endpoint_infos }}</a>
207
        <h4>{% trans 'Parameters' %}</h4>
208
        <table class="main params">
209
            <thead>
210
                <tr>
211
                    <th>{% trans 'Name' %}</th>
212
                    <th>{% trans 'Required' %}</th>
213
                    <th>{% trans 'Values' %}</th>
214
                    <th>{% trans 'Description' %}</th>
215
                </tr>
216
            </thead>
217
            <tbody>
218
                <tr>
219
                    <td>nameid</td>
220
                    <td>O</td>
221
                    <td></td>
222
                    <td>Identifiant Publik</td>
223
                </tr>
224
                <tr>
225
                    <td>firstnames</td>
226
                    <td>O</td>
227
                    <td></td>
228
                    <td>Prénoms</td>
229
                </tr>
230
                <tr>
231
                    <td>lastname</td>
232
                    <td>O</td>
233
                    <td></td>
234
                    <td>Nom</td>
235
                </tr>
236
                <tr>
237
                    <td>filenumber</td>
238
                    <td>O</td>
239
                    <td></td>
240
                    <td>Numéro de dossier</td>
241
                </tr>
242
                <tr>
243
                    <td>badgenumber</td>
244
                    <td></td>
245
                    <td></td>
246
                    <td>Numéro de badge</td>
247
                </tr>
248
                <tr>
249
                    <td>cardnumber</td>
250
                    <td></td>
251
                    <td></td>
252
                    <td>Numéro de carte</td>
253
                </tr>
254
            </tbody>
255
        </table>
256
        <h4>{% trans 'Response' %}</h4>
257
        <pre>
258
        {
259
            "data": [
260
                {
261
                    "adresse_boitepostalelieudit": null,
262
                    "adresse_codepostal": "31000",
263
                    "adresse_codesti": "315553609666",
264
                    "adresse_etageescalierappartement": null,
265
                    "adresse_extension": 1,
266
                    "adresse_immeublebatimentresidence": null,
267
                    "adresse_localite": "TOULOUSE",
268
                    "adresse_nomvoie": "All\u00e9es Jean Jaur\u00e8s",
269
                    "adresse_numerovoie": 80,
270
                    "adresse_quartier": "PERI",
271
                    "demande_datedebutabo": "20180625",
272
                    "demande_datefinabo": "20190624",
273
                    "demande_delaiautorise": 30,
274
                    "demande_immatvehicule1": "CX453AD",
275
                    "demande_immatvehicule2": null,
276
                    "demande_marquevehicule1": "CITROEN",
277
                    "demande_marquevehicule2": null,
278
                    "demande_modelevehicule1": "GS",
279
                    "demande_modelevehicule2": null,
280
                    "demande_numerodossier": 22952,
281
                    "demandeur_civilite": 1,
282
                    "demandeur_email": "foo@bar.org",
283
                    "demandeur_nomusuel": "Mercier",
284
                    "demandeur_prenom": "Eric",
285
                    "demandeur_telephonefixe": "0611111111",
286
                    "demandeur_telephoneportable": null
287
                },
288
            ],
289
            "err": 0
290
        }
291
        </pre>
292
    </li>
293

  
294
    <li>
295
        <h3>{% trans 'Register a subscription application' %}</h3>
296
        <h4>{% trans 'Request' %}</h4>
297
            {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="register" as endpoint_register %}
298
            <strong>POST</strong> <a href="{{ endpoint_register }}">{{ endpoint_register }}</a>
299
        <h4>{% trans 'Parameters' %}</h4>
300
        <table class="main params">
301
            <thead>
302
                <tr>
303
                    <th>{% trans 'Name' %}</th>
304
                    <th>{% trans 'Required' %}</th>
305
                    <th>{% trans 'Values' %}</th>
306
                    <th>{% trans 'Description' %}</th>
307
                </tr>
308
            </thead>
309
            <tbody>
310
                <tr>
311
			        <td>applicant_title</td>
312
                    <td>O</td>
313
                    <td>1 ou 2</td>
314
                    <td>Civilité du demandeur. <em>1</em> pour <em>Monsieur</em>, 2 pour <em>Madame</em></td>
315
                </tr>
316
                <tr>
317
                    <td>applicant_lastname</td>
318
                    <td>O</td>
319
                    <td></td>
320
                    <td>Nom du demandeur</td>
321
                </tr>
322
                <tr>
323
                    <td>applicant_firstnames</td>
324
                    <td>O</td>
325
                    <td></td>
326
                    <td>Prénoms du demandeur</td>
327
                </tr>
328
                <tr>
329
                    <td>applicant_phone</td>
330
                    <td></td>
331
                    <td></td>
332
                    <td>Téléphone fixe du demandeur</td>
333
                </tr>
334
                <tr>
335
                    <td>applicant_mobilephone</td>
336
                    <td></td>
337
                    <td></td>
338
                    <td>Téléphone mobile du demandeur</td>
339
                </tr>
340
                <tr>
341
                    <td>applicant_email</td>
342
                    <td>O</td>
343
                    <td></td>
344
                    <td>Courriel du demandeur</td>
345
                </tr>
346
                <tr>
347
                    <td>address_complement1</td>
348
                    <td></td>
349
                    <td></td>
350
                    <td>Etage, escalier ou numero d'appartement</td>
351
                </tr>
352
                <tr>
353
                    <td>address_complement2</td>
354
                    <td></td>
355
                    <td></td>
356
                    <td>Immeuble, bâtiment ou résidence</td>
357
                </tr>
358
                <tr>
359
                    <td>address_streetno</td>
360
                    <td></td>
361
                    <td></td>
362
                    <td>Numéro de voie</td>
363
                </tr>
364
                <tr>
365
                    <td>address_streetext</td>
366
                    <td></td>
367
                    <td>1,2,3,4</td>
368
                    <td>Extension de rue avec 1 pour Vide, 2 pour BIS, 3 pour TER et 4 pour QUATER</td>
369
                </tr>
370
                <tr>
371
                    <td>address_streetname</td>
372
                    <td></td>
373
                    <td></td>
374
                    <td>Nom de la voie</td>
375
                </tr>
376
                <tr>
377
                    <td>address_sticode</td>
378
                    <td>O</td>
379
                    <td></td>
380
                    <td>Code STI de l'adresse</td>
381
                </tr>
382
                <tr>
383
                    <td>address_place</td>
384
                    <td></td>
385
                    <td></td>
386
                    <td>Boîte postale, lieu-dit</td>
387
                </tr>
388
                <tr>
389
                    <td>address_zipcode</td>
390
                    <td>O</td>
391
                    <td></td>
392
                    <td>Code postal</td>
393
                </tr>
394
                <tr>
395
                    <td>address_locality</td>
396
                    <td>O</td>
397
                    <td></td>
398
                    <td>Localité</td>
399
                </tr>
400
                <tr>
401
                    <td>address_district</td>
402
                    <td>O</td>
403
                    <td></td>
404
                    <td>Quartier</td>
405
                </tr>
406
                <tr>
407
                    <td>application_id</td>
408
                    <td>O</td>
409
                    <td></td>
410
                    <td>Numéro de la demande</td>
411
                </tr>
412
                <tr>
413
                    <td>application_type</td>
414
                    <td>O</td>
415
                    <td>1,2</td>
416
                    <td>Type de demande avec 1 pour Badge et 2 pour Carte</td>
417
                </tr>
418
                <tr>
419
                    <td>filenumber</td>
420
                    <td></td>
421
                    <td></td>
422
                    <td>Numéro de dossier Dpark. Si renseigné, la demande est un renouvellement</td>
423
                </tr>
424
                <tr>
425
                    <td>application_car1_exemption</td>
426
                    <td>O</td>
427
                    <td></td>
428
                    <td>Cas d'éligibilité du véhicule 1 (<a class="wiki-page" href="#Cas-déligibilité">cf cas éligibilité</a>)</td>
429
                </tr>
430
                <tr>
431
                    <td>application_car1_model</td>
432
                    <td>O</td>
433
                    <td></td>
434
                    <td>Modèle du véhicule 1</td>
435
                </tr>
436
                <tr>
437
                    <td>application_car1_brand</td>
438
                    <td>O</td>
439
                    <td></td>
440
                    <td>Marque du véhicule 1</td>
441
                </tr>
442
                <tr>
443
                    <td>application_car1_plate</td>
444
                    <td>O</td>
445
                    <td></td>
446
                    <td>Immatriculation du véhicule 1</td>
447
                </tr>
448
                <tr>
449
                    <td>application_car2_exemption</td>
450
                    <td></td>
451
                    <td></td>
452
                    <td>Cas d'éligibilité du véhicule 2 (<a class="wiki-page" href="#Cas-déligibilité">cf cas éligibilité</a>)</td>
453
                </tr>
454
                <tr>
455
                    <td>application_car2_model</td>
456
                    <td></td>
457
                    <td></td>
458
                    <td>Modèle du véhicule 2</td>
459
                </tr>
460
                <tr>
461
                    <td>application_car2_brand</td>
462
                    <td></td>
463
                    <td></td>
464
                    <td>Marque du véhicule 2</td>
465
                </tr>
466
                <tr>
467
                    <td>application_car2_plate</td>
468
                    <td></td>
469
                    <td></td>
470
                    <td>Immatriculation du véhicule 2</td>
471
                </tr>
472
                <tr>
473
                    <td>application_thirdparty_subscription</td>
474
                    <td>O</td>
475
                    <td>True,False</td>
476
                    <td>Abonnement tiers</td>
477
                </tr>
478
                <tr>
479
                    <td>application_payment_type</td>
480
                    <td>O</td>
481
                    <td>5,10</td>
482
                    <td>Type de paiement, avec 5 pour prélevement mensualisé et 10 pour carte bancaire via internet</td>
483
                </tr>
484
                <tr>
485
                    <td>application_bank_name</td>
486
                    <td></td>
487
                    <td></td>
488
                    <td>Nom de la banque du demandeur</td>
489
                </tr>
490
                <tr>
491
                    <td>application_bank_address1</td>
492
                    <td></td>
493
                    <td></td>
494
                    <td>Ligne 1 de l'adresse de la banque</td>
495
                </tr>
496
                <tr>
497
                    <td>application_bank_address2</td>
498
                    <td></td>
499
                    <td></td>
500
                    <td>Ligne 2 de l'adresse de la banque</td>
501
                </tr>
502
                <tr>
503
                    <td>application_bank_zipcode</td>
504
                    <td></td>
505
                    <td></td>
506
                    <td>Code postal de la banque</td>
507
                </tr>
508
                <tr>
509
                    <td>application_bank_city</td>
510
                    <td></td>
511
                    <td></td>
512
                    <td>Ville où se situe l'agence bancaire</td>
513
                </tr>
514
                <tr>
515
                    <td>application_bank_iban</td>
516
                    <td></td>
517
                    <td></td>
518
                    <td>Numéro IBAN du compte bancaire</td>
519
                </tr>
520
                <tr>
521
                    <td>application_bank_bic</td>
522
                    <td></td>
523
                    <td></td>
524
                    <td>Numéro d'identification de la banque</td>
525
                </tr>
526
            </tbody>
527
        </table>
528
        <h4>{% trans 'Response' %}</h4>
529
        <pre>
530
        {
531
            "data": {
532
                "numerodossier": "22334",
533
                "numerodemande": "59492"
534
            },
535
            "err": 0
536
        }
537
        </pre>
538
    </li>
539

  
540
    <li>
541
        <h3>{% trans 'Send supporting documents' %}</h3>
542
        <h4>{% trans 'Request' %}</h4>
543
            {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="send-files" as endpoint_send_files %}
544
            <strong>POST</strong> <a href="{{ endpoint_send_files }}">{{ endpoint_send_files }}</a>
545

  
546
            <table class="main params">
547
                <thead>
548
                    <tr>
549
                        <th>Code</th>
550
                        <th>Slug</th>
551
                        <th>Description</th>
552
                    </tr>
553
                </thead>
554
                <tbody>
555
                    <tr>
556
                        <td>2</td>
557
                        <td>justif_domicile</td>
558
                        <td>Justificatif de domicile ( moins 3 mois)</td>
559
                    </tr>
560
                    <tr>
561
                        <td>4</td>
562
                        <td>assurance</td>
563
                        <td>Attestation d'assurance (Conducteur principal)</td>
564
                    </tr>
565
                    <tr>
566
                        <td>6</td>
567
                        <td>cartegrise</td>
568
                        <td>Carte grise</td>
569
                    </tr>
570
                    <tr>
571
                        <td>8</td>
572
                        <td>carte_medecin</td>
573
                        <td>Carte d'ordre des médecins</td>
574
                    </tr>
575
                    <tr>
576
                        <td>9</td>
577
                        <td>immat_artisanat_d1</td>
578
                        <td>Immatriculation Chambre Métiers et de l'Artisanat ( D1 )</td>
579
                    </tr>
580
                    <tr>
581
                        <td>10</td>
582
                        <td>agrement</td>
583
                        <td>Agrément : Assoc ou Entreprise</td>
584
                    </tr>
585
                    <tr>
586
                        <td>11</td>
587
                        <td>attest_employeur</td>
588
                        <td>Attestation employeur (Usage privé et pro )</td>
589
                    </tr>
590
                    <tr>
591
                        <td>13</td>
592
                        <td>taxe_habitat</td>
593
                        <td>Taxe d'Habitation ou Bail ou Acte notarié</td>
594
                    </tr>
595
                    <tr>
596
                        <td>14</td>
597
                        <td>abt_transport</td>
598
                        <td>Abt Annuel transport en commun ( Tisséo, SNCF actif pro)</td>
599
                    </tr>
600
                    <tr>
601
                        <td>16</td>
602
                        <td>contrat_locvehicule</td>
603
                        <td>Contrat de location (Véhicule)</td>
604
                    </tr>
605
                    <tr>
606
                        <td>17</td>
607
                        <td>impot_revenu</td>
608
                        <td>Impôt sur le revenu</td>
609
                    </tr>
610
                    <tr>
611
                        <td>18</td>
612
                        <td>carteverte</td>
613
                        <td>Attestation d'Assurance (Carte Verte)</td>
614
                    </tr>
615
                    <tr>
616
                        <td>19</td>
617
                        <td>decla_impot</td>
618
                        <td>Déclaration Impôt revenu (Enfant rattaché)</td>
619
                    </tr>
620
                    <tr>
621
                        <td>20</td>
622
                        <td>assurance_pro</td>
623
                        <td>Attestation d'Assurance (Usage Professionnel)</td>
624
                    </tr>
625
                    <tr>
626
                        <td>21</td>
627
                        <td>cotis_urssaf</td>
628
                        <td>Cotisation à l’URSSAF</td>
629
                    </tr>
630
                    <tr>
631
                        <td>22</td>
632
                        <td>ordonnance</td>
633
                        <td>Ordonnance (Attest sur l'honneur Médecin)</td>
634
                    </tr>
635
                    <tr>
636
                        <td>25</td>
637
                        <td>attest_employeurpro</td>
638
                        <td>Attestation Employeur (Usage Pro du Véhicule Perso)</td>
639
                    </tr>
640
                    <tr>
641
                        <td>26</td>
642
                        <td>attest_honneur</td>
643
                        <td>Attestation sur l'honneur (Professionnel de l’Urgence)</td>
644
                    </tr>
645
                    <tr>
646
                        <td>27</td>
647
                        <td>attest_cpam</td>
648
                        <td>Attestation CPAM avec le numéro de conventionnement (TAP)</td>
649
                    </tr>
650
                    <tr>
651
                        <td>28</td>
652
                        <td>cartegrise_qe</td>
653
                        <td>Carte grise avec mention de la qualité électrique</td>
654
                    </tr>
655
                    <tr>
656
                        <td>29</td>
657
                        <td>contrat_livraison</td>
658
                        <td>Contrat de livraison entre le pro et le commerce ou attest livraison régulière (signature du pro et du commerçant)</td>
659
                    </tr>
660
                    <tr>
661
                        <td>30</td>
662
                        <td>immat_artisanat</td>
663
                        <td>Immatriculation au registre des métiers et de l'artisanat ou au registre du commerce</td>
664
                    </tr>
665
                    <tr>
666
                        <td>31</td>
667
                        <td>immat_artisanat_ape</td>
668
                        <td>Immatriculation au registre des métiers et de l'artisanat ou au registre du commerce (avec mention code APE)</td>
669
                    </tr>
670
                </tbody>
671
            </table>
672
        <h4>{% trans 'Parameters' %}</h4>
673
        <table class="main params">
674
            <thead>
675
                <tr>
676
                    <th>{% trans 'Name' %}</th>
677
                    <th>{% trans 'Required' %}</th>
678
                    <th>{% trans 'Values' %}</th>
679
                    <th>{% trans 'Description' %}</th>
680
                </tr>
681
            </thead>
682
            <tbody>
683
                <tr>
684
                    <td>application_external_id</td>
685
                    <td>O</td>
686
                    <td></td>
687
                    <td>Numéro de télédossier reçu lors de l'enregistrement de la demande e.g <code>E-8-0AA666BB</code></td>
688
                </tr>
689
                <tr>
690
                    <td>application_id</td>
691
                    <td>O</td>
692
                    <td></td>
693
                    <td>Numéro de demande e.g <code>59492</code></td>
694
                </tr>
695
                <tr>
696
                    <td>document_slug</td>
697
                    <td></td>
698
                    <td></td>
699
                    <td>Type de document</td>
700
                </tr>
701
                <tr>
702
                    <td>document_slug,1</td>
703
                    <td></td>
704
                    <td></td>
705
                    <td>Type de document</td>
706
                </tr>
707
                <tr>
708
                    <td>document_slug,N</td>
709
                    <td></td>
710
                    <td></td>
711
                    <td>Type de document</td>
712
                </tr>
713
            </tbody>
714
        </table>
715
        <p>Dans le cas ou l'on veut envoyer plusieur fois le même type de document, déclare plusieurs variables dont les noms sont <em>document_slug,numero</em> e.g
716
        <pre>
717
        {
718
          "cartegrise,1": ....,
719
          "cartegrise,2": ....
720
        }
721
        </pre>
722
        </p>
723
        <h4>{% trans 'Response' %}</h4>
724
        <pre>
725
        {
726
            "data": True,
727
            "err": 0
728
        }
729
        </pre>
730
    </li>
731

  
732
    <li>
733
        <h3>{% trans 'Check if address is eligible' %}</h3>
734
        <h4>{% trans 'Request' %}</h4>
735
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="address-eligibility" as endpoint_address_eligibility %}
736
        <strong>GET</strong> <a href="{{ endpoint_address_eligibility }}">{{ endpoint_address_eligibility }}</a>
737
       <h4>{% trans 'Parameters' %}</h4>
738
        <table class="main params">
739
            <thead>
740
                <tr>
741
                    <th>{% trans 'Name' %}</th>
742
                    <th>{% trans 'Required' %}</th>
743
                    <th>{% trans 'Values' %}</th>
744
                    <th>{% trans 'Description' %}</th>
745
                </tr>
746
            </thead>
747
            <tbody>
748
                <tr>
749
                    <td>address_sticode</td>
750
                    <td>O</td>
751
                    <td></td>
752
                    <td>Code STI</td>
753
                </tr>
754
                <tr>
755
                    <td>address_locality</td>
756
                    <td>O</td>
757
                    <td></td>
758
                    <td>Nom de la localité</td>
759
                </tr>
760
                <tr>
761
                    <td>address_zipcode</td>
762
                    <td>O</td>
763
                    <td></td>
764
                    <td>Code postal</td>
765
                </tr>
766
                <tr>
767
                    <td>address_complement1</td>
768
                    <td></td>
769
                    <td></td>
770
                    <td>Premier complement d'adresse: etage appartememt, escalier</td>
771
                </tr>
772
                <tr>
773
                    <td>address_complement2</td>
774
                    <td></td>
775
                    <td></td>
776
                    <td>Second complement d'adresse: immeuble, batiment, résidence</td>
777
                </tr>
778
                <tr>
779
                    <td>address_streetno</td>
780
                    <td></td>
781
                    <td></td>
782
                    <td>Numéro de rue</td>
783
                </tr>
784
                <tr>
785
                    <td>address_streetext</td>
786
                    <td></td>
787
                    <td></td>
788
                    <td>Numéro d'extension de rue</td>
789
                </tr>
790
                <tr>
791
                    <td>address_streetname</td>
792
                    <td></td>
793
                    <td></td>
794
                    <td>Nom de rue</td>
795
                    <td></td>
796
                </tr>
797
            </tbody>
798
        </table>
799
        <h4>{% trans 'Response' %}</h4>
800
        <pre>
801
        {
802
            "data": True,
803
            "err": 0
804
        }
805
        </pre>
806
    </li>
807

  
808
    <li>
809
    <h3>{% trans 'Get payment information' %}</h3>
810
        <h4>{% trans 'Request' %}</h4>
811
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="payment-info" rest='abcde/' as endpoint_payment_info %}
812
        <strong>GET</strong> <a href="{{ endpoint_payment_info }}">{{ endpoint_payment_info }}</a>
813
       <h4>{% trans 'Parameters' %}</h4>
814
        <table class="main params">
815
            <thead>
816
                <tr>
817
                    <th>{% trans 'Name' %}</th>
818
                    <th>{% trans 'Required' %}</th>
819
                    <th>{% trans 'Values' %}</th>
820
                    <th>{% trans 'Description' %}</th>
821
                </tr>
822
            </thead>
823
            <tbody>
824
                <tr>
825
                    <td>filenumber</td>
826
                    <td></td>
827
                    <td></td>
828
                    <td>Numéro de dossier</td>
829
                </tr>
830
            </tbody>
831
        </table>
832
        <p>Si un numéro de dossier est passé (filenumber), seul les informations relatives à ce numéro de dossier seront remontées</p>
833
        <h4>{% trans 'Response' %}</h4>
834
        <pre>
835
        {
836
            "data": [
837
                {
838
                    "typepaiement_text": "Carte Bancaire via Internet",
839
                    "numerodemande": 61718,
840
                    "montant": 135,
841
                    "numeroteledossierphase1": "E-8-N5UTAK6P",
842
                    "typepaiement": 10
843
                }
844
            ],
845
            "err": 0
846
        }
847
        </pre>
848
    </li>
849

  
850
    <li>
851
        <h3>{% trans 'Notify a payment' %}</h3>
852
        <h4>{% trans 'Request' %}</h4>
853
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="notify-payment" as endpoint_notify_payment %}
854
        <strong>POST</strong> <a href="{{ endpoint_notify_payment }}">{{ endpoint_notify_payment }}</a>
855
        <h4>{% trans 'Parameters' %}</h4>
856
        <table class="main params">
857
            <thead>
858
                <tr>
859
                    <th>{% trans 'Name' %}</th>
860
                    <th>{% trans 'Required' %}</th>
861
                    <th>{% trans 'Values' %}</th>
862
                    <th>{% trans 'Description' %}</th>
863
                </tr>
864
            </thead>
865
            <tbody>
866
                <tr>
867
                    <td>application_external_id</td>
868
                    <td>O</td>
869
                    <td></td>
870
                    <td>Numéro de teledossier</td>
871
                </tr>
872
                <tr>
873
                    <td>application_id</td>
874
                    <td>O</td>
875
                    <td></td>
876
                    <td>Numéro de demande</td>
877
                </tr>
878
                <tr>
879
                    <td>filenumer</td>
880
                    <td>O</td>
881
                    <td></td>
882
                    <td>Numéro de dossier</td>
883
                </tr>
884
                <tr>
885
                    <td>nameid</td>
886
                    <td>O</td>
887
                    <td></td>
888
                    <td>Identifiant de l'utilisateur</td>
889
                </tr>
890
                <tr>
891
                    <td>total_amount</td>
892
                    <td>O</td>
893
                    <td></td>
894
                    <td>Montant total</td>
895
                </tr>
896
                <tr>
897
                    <td>transaction_datetime</td>
898
                    <td>O</td>
899
                    <td></td>
900
                    <td>Date et heure de la transaction</td>
901
                </tr>
902
                <tr>
903
                    <td>transaction_id</td>
904
                    <td>O</td>
905
                    <td></td>
906
                    <td>Numéro de transaction</td>
907
                </tr>
908
            </tbody>
909
        </table>
910
        <h4>{% trans 'Response' %}</h4>
911
        <pre>
912
        {
913
            "data": True,
914
            "err": 0
915
        }
916
        </pre>
917
    </li>
918

  
919
    <li>
920
        <h3>{% trans 'Check if renewal time has not expired' %}</h3>
921
        <h4>{% trans 'Request' %}</h4>
922
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="check-renewal-time" as endpoint_check_renewal_time %}
923
        <strong>GET</strong> <a href="{{ endpoint_check_renewal_time }}">{{ endpoint_check_renewal_time }}</a>
924
        <h4>{% trans 'Parameters' %}</h4>
925
        <table class="main params">
926
            <thead>
927
                <tr>
928
                    <th>{% trans 'Name' %}</th>
929
                    <th>{% trans 'Required' %}</th>
930
                    <th>{% trans 'Values' %}</th>
931
                    <th>{% trans 'Description' %}</th>
932
                </tr>
933
            </thead>
934
            <tbody>
935
                <tr>
936
                    <td>filenumber</td>
937
                    <td>O</td>
938
                    <td></td>
939
                    <td>Numéro de dossier</td>
940
                </tr>
941
                <tr>
942
                    <td>firstnames</td>
943
                    <td>O</td>
944
                    <td></td>
945
                    <td>Prénoms de l'abonné</td>
946
                </tr>
947
                <tr>
948
                    <td>lastname</td>
949
                    <td>O</td>
950
                    <td></td>
951
                    <td>Nom de l'abonne</td>
952
                </tr>
953
                <tr>
954
                    <td>badgenumber</td>
955
                    <td></td>
956
                    <td></td>
957
                    <td>Numéro de badge</td>
958
                </tr>
959
                <tr>
960
                    <td>cardnumber</td>
961
                    <td></td>
962
                    <td></td>
963
                    <td>Numéro de carte</td>
964
                </tr>
965
            </tbody>
966
        </table>
967
        <h4>{% trans 'Response' %}</h4>
968
        <pre>
969
        {
970
            "data": True,
971
            "err": 0
972
        }
973
        </pre>
974
    </li>
975

  
976
    <li>
977
        <h3>{% trans 'Check if renewal request is not a duplicate' %}</h3>
978
        <h4>{% trans 'Request' %}</h4>
979
        {% url "generic-endpoint" connector="dpark" slug=object.slug endpoint="check-renewal-duplicate" as endpoint_check_renewal_duplicate %}
980
        <strong>GET</strong> <a href="{{ endpoint_check_renewal_duplicate }}">{{ endpoint_check_renewal_duplicate }}</a>
981
        <h4>{% trans 'Parameters' %}</h4>
982
        <table class="main params">
983
            <thead>
984
                <tr>
985
                    <th>{% trans 'Name' %}</th>
986
                    <th>{% trans 'Required' %}</th>
987
                    <th>{% trans 'Values' %}</th>
988
                    <th>{% trans 'Description' %}</th>
989
                </tr>
990
            </thead>
991
            <tbody>
992
                <tr>
993
                    <td>filenumber</td>
994
                    <td>O</td>
995
                    <td></td>
996
                    <td>Numéro de dossier</td>
997
                </tr>
998
                <tr>
999
                    <td>firstnames</td>
1000
                    <td>O</td>
1001
                    <td></td>
1002
                    <td>Prénoms de l'abonné</td>
1003
                </tr>
1004
                <tr>
1005
                    <td>lastname</td>
1006
                    <td>O</td>
1007
                    <td></td>
1008
                    <td>Nom de l'abonne</td>
1009
                </tr>
1010
                <tr>
1011
                    <td>badgenumber</td>
1012
                    <td></td>
1013
                    <td></td>
1014
                    <td>Numéro de badge</td>
1015
                </tr>
1016
                <tr>
1017
                    <td>cardnumber</td>
1018
                    <td></td>
1019
                    <td></td>
1020
                    <td>Numéro de carte</td>
1021
                </tr>
1022
            </tbody>
1023
        </table>
1024
        <h4>{% trans 'Response' %}</h4>
1025
        <pre>
1026
        {
1027
            "data": True,
1028
            "err": 0
1029
        }
1030
        </pre>
1031
    </li>
1032

  
1033
</ul>
1034
{% endblock %}
1035

  
1036
{% block security %}
1037
{% access_rights_table resource=object permission='can_access' %}
1038
{% endblock %}
0
-