URL

/envois

Type

GET

Description

Liste les envois. Il est possible de filtrer les envois suivant différents critères (voir les Paramètres d'URL).

Paramètre d'URL

Nom du paramètre Type DescriptionObligatoireValeur par défaut
statutStringUne des constantes :
  • à imprimer
  • déposé
Non
id_utilisateurIntIdentifiant d'un utilisateur.Non
maxIntNombre d'envois à retourner.Non30
pageIntIndex de début de pagination.Non1
qStringMot clé de recherche.Non
fStringChamps dans lequel rechercher le mot clé. Si vide, le mot clé est rechercher dans l'ensemble des champs.
  • imputation : Chaîne d'imputation.
  • expediteur : Adresse de l'expéditeur de l'envoi.
  • destinataire : Adresse du destinataire d'un pli.
  • reference : Descriptif de l'envoi ou référence d'un pli.
Non
debutStringDate de début, au format jj/mm/aaaa.Non
finStringDate de fin, au format jj/mm/aaaaNon
sIntFiltre sur le type de support.
  • 1 : Recommandé national avec AR avec CAB
  • 2 : Recommandé national sans AR avec CAB
  • 3 : Recommandé international avec AR avec CAB
  • 4 : Recommandé national avec AR sans CAB
  • 5 : Recommandé national sans AR sans CAB
  • 6 : Recommandé international sans AR avec CAB
  • 7 : Recommandé international sans AR sans CAB
  • 8 : Recommandé international avec AR sans CAB
  • 9 : Lettre Suivie sans CAB
  • 10 : Lettre Expert sans CAB
  • 11 : Lettre recommandé premuim avec AR
  • 12 : SBR avec AR avec CAB
  • 13 : SBR sans AR avec CAB
  • 14 : SBR avec AR sans CAB
  • 15 : SBR sans AR sans CAB
  • 16 : Lettre recommandé premuim avec AR numérique sans CAB
  • 17 : Lettre recommandé premuim sans AR sans CAB
  • 18 : Export Suivi
  • 19 : Valeur déclarée avec CAB
  • 20 : Valeur déclarée sans CAB
  • 21 : SGR avec AR
  • 22 : SGR sans AR
  • 23 : Lettre Suivie avec CAB
  • 24 : Lettre Expert avec CAB
  • 25 : Lettre recommandé premuim avec AR avec CAB
  • 26 : Lettre recommandé premuim avec AR numérique avec CAB
  • 27 : Lettre recommandé premuim sans AR avec CAB
  • 28 : Export Suivi avec CAB
Non
triStringTrier le résultat par date de création, nombre de plis ou descriptif. Constantes :
  • date_creation
  • nb_plis
  • descriptif
Nondate_creation
ordreStringTrier par ordre croissant ou décroissant. Constantes :
  • ASC
  • DESC
NonASC

Réponse

DescriptionListe des propriétésExemple
Tableau des envois répondant aux critères de recherche et de filtre.
Nom du paramètre Type DescriptionObligatoireValeur par défaut
idIntId de l'envoi.Non
id_utilisateurIntIdentifiant de l'utilisateur ayant créé l'envoi.Non
date_creationStringDate de création de l'envoi, au format AAAA-MM-JJ HH:MM:SS.Non
date_impressionStringDate d'impression de l'envoi, au format AAAA-MM-JJ HH:MM:SS. Si vide, alors l'envoi est en attente d'impression.Non
plisArrayTableau des identifiant des plis de l'envoi.Non
id_supportIntConstantes des supports :
  • 1 : Recommandé national avec AR avec CAB
  • 2 : Recommandé national sans AR avec CAB
  • 3 : Recommandé international avec AR avec CAB
  • 4 : Recommandé national avec AR sans CAB
  • 5 : Recommandé national sans AR sans CAB
  • 6 : Recommandé international sans AR avec CAB
  • 7 : Recommandé international sans AR sans CAB
  • 8 : Recommandé international avec AR sans CAB
  • 9 : Lettre Suivie sans CAB
  • 10 : Lettre Expert sans CAB
  • 11 : Lettre recommandé premuim avec AR
  • 12 : SBR avec AR avec CAB
  • 13 : SBR sans AR avec CAB
  • 14 : SBR avec AR sans CAB
  • 15 : SBR sans AR sans CAB
  • 16 : Lettre recommandé premuim avec AR numérique sans CAB
  • 17 : Lettre recommandé premuim sans AR sans CAB
  • 18 : Export Suivi
  • 19 : Valeur déclarée avec CAB
  • 20 : Valeur déclarée sans CAB
  • 21 : SGR avec AR
  • 22 : SGR sans AR
  • 23 : Lettre Suivie avec CAB
  • 24 : Lettre Expert avec CAB
  • 25 : Lettre recommandé premuim avec AR avec CAB
  • 26 : Lettre recommandé premuim avec AR numérique avec CAB
  • 27 : Lettre recommandé premuim sans AR avec CAB
  • 28 : Export Suivi avec CAB
Non
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

{
    "envois": [
        {
            "id": 1,
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:35:35",
            "date_impression": "2014-02-07 09:36:23",
            "descriptif": "",
            "plis": [
                1,
		2,
		3,
		4,
		5
            ]
        },
        {
            "id": 2,
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:37:53",
            "date_impression": "2014-02-12 14:21:18",
            "descriptif": "",
            "plis": [
                6,
		7,
		8,
		9
            ]
        },
        {
            "id": 3,
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:37:53",
            "date_impression": "2014-02-12 14:21:18",
            "descriptif": "",
            "plis": [
                10
            ]
        },
        {
            "id": 4,
            "id_utilisateur": 1,
            "date_creation": "2014-02-07 09:37:53",
            "date_impression": "2014-02-12 14:21:18",
            "descriptif": "",
            "plis": [
                11
            ]
        }
    ]
}