URL

/objets-entrants

Type

GET

Description

Liste les objets entrants. Il est possible de filtrer les objets entrants 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 :
  • "a_distribuer" : À distribuer
  • "distribue" : Distribué
Non
pageIntNuméro de page à afficher. Le nombre d'objets entrants par page est défini par le paramètre max.Non1
maxIntNombre d'objets entrants par page.Non30
qStringMot clé de recherche.Non
fStringChamps dans lequel rechercher le mot clé. Si vide, le mot clé est rechercher dans l'ensemble des champs.
  • numero : Numéro de suivi de l'objet entrant.
  • expediteur : Adresse expéditeur de l'objet entrant.
  • produit :
  • commentaire : Commentaire de l'objet entrant.
Non
debutStringDate de début, au format jj/mm/aaaa.Non
finStringDate de fin, au format jj/mm/aaaa.Non
indice_rechercheStringRechercher un utilisateur ou une imputation. Il peut prendre 2 valeurs :
  • code
  • utilisateur
Non
identifiant_imputationIntIdentifiant recherché. En fonction du paramétré "indice_recherche", il peut être soit un identifiant utilisateur soit un identifiant de code d'imputation.Non
autocompleteNiveauImputationIntNiveau de recherche.
  • 0 : que les utilisateurs n'étant pas lié à un code d'imputation
  • 1 : que les code d'imputation avec id_parent à NULL
  • 3 : tout les codes d'imputation + les utilisateurs liés à un code
  • 4 : tout les codes d'imputation + les utilisateurs liés à un code + utilisateur non lié à un code
Non
pndIntExclure ou non les PND de la recherche.Non
triStringTrier le résultat par date de création, numéro, imputation, produit, expéditeur, PND et commentaire. Constantes :
  • date
  • numero
  • imputation
  • produit
  • expediteur
  • pnd
  • commentaire
Non
ordreStringTrier le résultat par ordre croissant ou décroissant. Constantes :
  • ASC
  • DESC
Non

Réponse

DescriptionListe des propriétésExemple
Tableau des objets entrants répondant aux critères de recherche et de filtre.
Nom du paramètre Type DescriptionObligatoireValeur par défaut
objets-entrantsArrayTableau d'objets objet entrant.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
52
53
54
55
56
57

{
    "objets_entrants": [
 
        {
	  "id": 1,
	  "id_utilisateur_creation": 1,
	  "expediteur": {
	      "UXEN UXEN UXEN UXEN UXEN UXEN UXEN UXE
	      EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE
	      EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR
	      26 RUE GEORGE SAND 26 RUE GEORGE SAND2
	      EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI
	      75016 PARIS"
	  },
	  "imputation": {
	      "libelle": "1001-Informatique/1011-Développement/Utilisateur 2",
	      "id_code_imputation": 1,
	      "id_utilisateur_imputation": 2
	  },
	  "numero": "2C00000000000",
	  "produit": "Lettre Recommandée - avec AR",
	  "statut": "2",
	  "statut_pnd": "17",
	  "ts": "2014-02-05 15:50:03",
	  "retour_pnd": "2014-02-05 15:50:03",
	  "tarif_affranchissement": "15.50",
          "poids": "11.00",
	  "date_distribution": "2014-02-05 15:50:03",
      },
      {
	  "id": 2,
	  "id_utilisateur_creation": 1,
	  "expediteur": {
	      "UXEN UXEN UXEN UXEN UXEN UXEN UXEN UXE
	      EXPEDITEUR NOM EXPEDITEUR NOM EXPEDITE
	      EXPEDITEUR COMPLEMENT VOIE EXPEDITEUR
	      26 RUE GEORGE SAND 26 RUE GEORGE SAND2
	      EXPEDITEUR BOITE POSTALEEXPEDITEUR BOI
	      75016 PARIS"
	  },
	  "imputation": {
	      "libelle": "1001-Informatique/1011-Développement/Utilisateur 2",
	      "id_code_imputation": 1,
	      "id_utilisateur_imputation": 2
	  },
	  "numero": "2C00000000000",
	  "produit": "Lettre Recommandée - avec AR",
	  "statut": "2",
	  "statut_pnd": "17",
	  "ts": "2014-02-05 15:50:03",
	  "retour_pnd": "2014-02-05 15:50:03",
	  "tarif_affranchissement": "15.50",
          "poids": "11.00",
	  "date_distribution": "2014-02-05 15:50:03",
	  }
    ]
}