POST api/Consommation
Permet d'obtenir les consommations.
Request Information
URI Parameters
None.
Body Parameters
ParamModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Debut |
Date de début de période (AAAA-MM-JJ) |
date |
None. |
| Fin |
Date de fin de période (AAAA-MM-JJ) |
date |
None. |
| ProduitId |
Permet de filtrer sur un produit en particulier, si pas de valeur on renvoie les consommations de tous les produits |
integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Debut": "2025-12-10T02:11:02.7624691+01:00",
"Fin": "2025-12-10T02:11:02.7624691+01:00",
"ProduitId": 1
}
application/xml, text/xml
Sample:
<ParamModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Facturation.Api.Models"> <Debut>2025-12-10T02:11:02.7624691+01:00</Debut> <Fin>2025-12-10T02:11:02.7624691+01:00</Fin> <ProduitId>1</ProduitId> </ParamModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ReponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ProduitId |
Identifiant du produit |
integer |
None. |
| NomProduit |
Nom du produit |
string |
None. |
| ConsommationsSomme |
Consommations totales par compteur sur la période |
Collection of CompteurModel |
None. |
| ConsommationsDetails |
Consommations détaillées par dossier et par compteur sur la période |
Collection of ConsoModel |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"ProduitId": 1,
"NomProduit": "sample string 2",
"ConsommationsSomme": [
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
},
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
}
],
"ConsommationsDetails": [
{
"Dossier": "sample string 1",
"DateDossier": "2025-12-10T02:11:03.1374677+01:00",
"Compteur": [
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
},
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
}
]
},
{
"Dossier": "sample string 1",
"DateDossier": "2025-12-10T02:11:03.1374677+01:00",
"Compteur": [
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
},
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
}
]
}
]
},
{
"ProduitId": 1,
"NomProduit": "sample string 2",
"ConsommationsSomme": [
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
},
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
}
],
"ConsommationsDetails": [
{
"Dossier": "sample string 1",
"DateDossier": "2025-12-10T02:11:03.1374677+01:00",
"Compteur": [
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
},
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
}
]
},
{
"Dossier": "sample string 1",
"DateDossier": "2025-12-10T02:11:03.1374677+01:00",
"Compteur": [
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
},
{
"Sequence": 1,
"Libelle": "sample string 2",
"Quantite": 3
}
]
}
]
}
]
application/xml, text/xml
Sample:
<ArrayOfReponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Facturation.Api.Models">
<ReponseModel>
<ConsommationsDetails>
<ConsoModel>
<Compteur>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
</Compteur>
<DateDossier>2025-12-10T02:11:03.1374677+01:00</DateDossier>
<Dossier>sample string 1</Dossier>
</ConsoModel>
<ConsoModel>
<Compteur>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
</Compteur>
<DateDossier>2025-12-10T02:11:03.1374677+01:00</DateDossier>
<Dossier>sample string 1</Dossier>
</ConsoModel>
</ConsommationsDetails>
<ConsommationsSomme>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
</ConsommationsSomme>
<NomProduit>sample string 2</NomProduit>
<ProduitId>1</ProduitId>
</ReponseModel>
<ReponseModel>
<ConsommationsDetails>
<ConsoModel>
<Compteur>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
</Compteur>
<DateDossier>2025-12-10T02:11:03.1374677+01:00</DateDossier>
<Dossier>sample string 1</Dossier>
</ConsoModel>
<ConsoModel>
<Compteur>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
</Compteur>
<DateDossier>2025-12-10T02:11:03.1374677+01:00</DateDossier>
<Dossier>sample string 1</Dossier>
</ConsoModel>
</ConsommationsDetails>
<ConsommationsSomme>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
<CompteurModel>
<Libelle>sample string 2</Libelle>
<Quantite>3</Quantite>
<Sequence>1</Sequence>
</CompteurModel>
</ConsommationsSomme>
<NomProduit>sample string 2</NomProduit>
<ProduitId>1</ProduitId>
</ReponseModel>
</ArrayOfReponseModel>