URL

/envois/{ID_ENVOI}

Type

GET

Description

Permet de récupérer toute les informations de l'envoi indiqué par {ID_ENVOI}. L'entête "Accept" permet de définir le format du retour. Si l'entête n'est pas défini ou est défini à "text/json", c'est le retour JSON qui sera renvoyé. Si l'entête est définie à "application/pdf", c'est le support d'impression au format PDF qui sera retourné. Si l'envoi était en attente d'impression, l'appelle avec cette API avec l'entête "Accept : application/pdf" passera les plis en état "à déposer".

Réponse

DescriptionListe des propriétésExemple
Suivant la valeur de l'entête HTTP "Accept", le retour est au format JSON ou PDF (supports d'impression des plis de l'envoi).
Nom du paramètre Type DescriptionObligatoireValeur par défaut
envoiObjetOBJET envoiNon
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

{
    "envoi": {
        "id": 1,
        "id_utilisateur": 1,
        "date_creation": "2014-02-07 09:37:53",
        "date_impression": "2014-02-12 14:21:18",
        "id_suport": 4,
        "descriptif": "DESC",
        "plis": [
            {
            "id": 1,
            "id_utilisateur": 1,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "1001-Informatique/1011-Dév/Utilisateur 2",
                "id_code_imputation": 1,
                "id_utilisateur_imputation": 2
            },
            "retour_ar": {
                "raison_sociale": "ADR RETOUR AR DEMO SAS DEMO SAS DEMO S",
                "nom": "ADR RETOUR AR M DEMO JEANM DEMO JEANM",
                "complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT",
                "voie": "ADR RETOUR AR 10 RUE DES LILAS10 RUE D",
                "boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
                "code_postale_commune": "33000 BORDEAUX"
            },
            "reference": "DESC\nRéf du 1er pli",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": null
        },
        {
            "id": 2770635,
            "id_utilisateur": 6692,
            "support": 1,
            "expediteur": {
                "raison_sociale": "UXEN UXENUXEN UXENUXEN UXENUXEN UXENUX",
                "nom": "EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE",
                "complement_voie": "EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR",
                "voie": "26 RUE GEORGE SAND 26 RUE GEORGE SAND2",
                "boite_postale": "EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI",
                "code_postale_commune": "75016 PARIS"
            },
            "destinataire": {
                "raison_sociale": "DEMO SAS DEMO SAS DEMO SAS DEMO SAS DE",
                "nom": "M DEMO JEANM DEMO JEANM DEMO JEANM DEM",
                "complement_voie": "DESTINATAIRE COMPLEMENT VOIE DESTINATA",
                "voie": "10 RUE DES LILAS10 RUE DES LILAS10 RUE",
                "boite_postale": "DESTINATAIRE BP DESTINATAIRE BP DESTIN",
                "code_postale_commune": "33000 BORDEAUX",
                "pays": "FRANCE"
            },
            "imputation": {
                "libelle": "Utilisateur 1",
                "id_code_imputation": 0,
                "id_utilisateur_imputation": 1
            },
	    "retour_ar": {
                "raison_sociale": "ADR RETOUR AR DEMO SAS DEMO SAS DEMO S",
                "nom": "ADR RETOUR AR M DEMO JEANM DEMO JEANM",
                "complement_voie": "ADR RETOUR AR DESTINATAIRE COMPLEMENT",
                "voie": "ADR RETOUR AR 10 RUE DES LILAS10 RUE D",
                "boite_postale": "ADR RETOUR AR DESTINATAIRE BP DESTINAT",
                "code_postale_commune": "33000 BORDEAUX"
            },
            "numero": "2C00000003193",
            "reference": "DESC",
            "options": 5,
            "poids": 0,
            "statut_libelle_general": "AR Reçu",
            "suivi": [
                {
                    "date": "2014-06-06T23:00:00+02:00",
                    "detail": "Distribué (920600 LE PLESSIS ROBINSON)"
                },
                {
                    "date": "2014-05-28T23:00:00+02:00",
                    "detail": "Attend d'être retiré au guichet (920600 LE PLESSIS ROBINSON)"
                },
                {
                    "date": "2014-05-27T23:00:00+02:00",
                    "detail": "Pli présenté (920870 LE PLESSIS ROBINSON PDC1)"
                },
                {
                    "date": "2014-05-27T22:59:59+02:00",
                    "detail": "En cours de traitement (920870 LE PLESSIS ROBINSON PDC1)"
                },
                {
                    "date": "2014-05-26T23:00:00+02:00",
                    "detail": "Départ (951140 GONESSE PARIS NORD PIC)"
                },
                {
                    "date": "2014-05-26T22:59:59+02:00",
                    "detail": "Pris en charge (752265 PARIS LA TREMOILLE APV)"
                },
                {
                    "date": "2014-04-14T12:27:56+02:00",
                    "detail": "AR Reçu"
                }
            ]
        }
        ]
    }
}

Les erreurs

Code Message Description
403L'envoi #{id_envoi} n'existe pas.Aucun envoi trouvé pour cet identifiant d'envoi.