API docs by Redocly

API Ecomaison – Liste des contenants d'un site (1.0.3)

Download OpenAPI specification:

Web service permettant d'obtenir la liste des contenants d'un site (par SIRET + site_number). La liste peut être vide s’il n’y a pas de contenant doté sur le site.

other

Demande de liste de contenants d'un site

Retourne tous les contenants (dotés ou non) du site/point d’un distributeur, avec dates de pose/retrait et informations opérateur.

Authorizations:
api-ldcds_ApiKeyAuth
query Parameters
siret
required
string^\d{14}$

SIRET de l'établissement (obligatoire). Contrôles :

  • Longueur 14 (pattern)
  • Validité Luhn (contrôle métier)
  • Existence et rattachement à un compte distributeur (contrôle métier)
site_number
required
string^\d+$

Numéro du point (obligatoire). Contrôles :

  • Doit être connu pour l’établissement (SIRET) fourni (contrôle métier).

Responses

Response samples

Content type
application/json
{
  • "siret": "39387368200024",
  • "site": {
    },
  • "containers": [
    ]
}

other

Liste des sites et contact des solutions de collecte

Retourne tous les sites (actifs et non actifs à la date du jour) d’un distributeur ayant un contrat signé. La liste peut être vide si aucun site n’est connu pour l’établissement.

Authorizations:
api-ldscsc_ApiKeyAuth
query Parameters
siret
required
string^\d{14}$

SIRET de l'établissement (obligatoire). Contrôles :

  • 14 chiffres (pattern)
  • Doit exister en BDD et appartenir à un compte distributeur (contrôle métier)
with_sub_accounts
boolean
Default: false

Afficher les sites des sous-comptes (défaut false)

Responses

Response samples

Content type
application/json
{
  • "account_name": "THIRIEZ LITERIE",
  • "siret": "38291489300047",
  • "sites": [
    ]
}

other

Annuler un enlèvement

Authorizations:
api-aue_ApiKeyAuth
Request Body schema: application/json
required
siret
required
string^[0-9]{14}$

Numéro SIRET de l’établissement

operation_number
required
string

Numéro de l’opération à annuler

comment
required
string

Commentaire d’annulation

required
object

Responses

Request samples

Content type
application/json
{
  • "siret": "string",
  • "operation_number": "string",
  • "comment": "string",
  • "contact": {
    }
}

other

Consulter un dysfonctionnement

query Parameters
siret
required
string^[0-9]{14}$

Siret de l'établisssment

malfunction
required
integer

Identifiant d'un dysfonctionnement d'opération

Responses

Response samples

Content type
application/json
{
  • "identification_number": 0,
  • "date_seased": "2019-08-24",
  • "observation_date": "2019-08-24",
  • "reason_code": "string",
  • "state": "string",
  • "operation_id": 0,
  • "author": {
    },
  • "operator": {
    },
  • "description": "string",
  • "abort_reason": "string",
  • "account_questioned_notified": true,
  • "action_plan": "string",
  • "attachments": [
    ],
  • "comments": [
    ]
}

other

Crée une demande d'enlèvement de contenant

Enregistre une demande d'enlèvement dans le SI Collecte.

Authorizations:
api-dedc_ApiKeyAuth
Request Body schema: application/json
required
One of
siret
required
string^\d{14}$

Numéro de SIRET de l'établissement (14 chiffres)

site_number
required
string^\d+$

Numéro du point (numérique)

junk_type
required
string

Type de déchet

container
required
string

Type de contenant

count_sent
integer

Quantité de caisses-palettes en sortie du site de départ (obligatoire si contenant "Caisse-palette")

required
object (api-dedc_CollectDesired)
comment
string

Contenu du commentaire (facultatif)

is_public
string
Enum: "true" "false"

Visibilité du commentaire (requis si comment est fourni)

required
object (api-dedc_Contact)
required
object (api-dedc_Operator)

Responses

Request samples

Content type
application/json
Example
{
  • "siret": "35174572400044",
  • "site_number": "2105676",
  • "junk_type": "petit_objet",
  • "container": "caisses_palettes",
  • "count_sent": 2,
  • "collect_desired": {
    },
  • "comment": "Demande d'enlèvement CP",
  • "is_public": "true",
  • "contact": {
    },
  • "operator": {
    }
}

Response samples

Content type
application/json
{
  • "account_number": "<numéro du compte>",
  • "operation_number": "<numéro de l'opération>",
  • "details": {
    }
}

other

Envoyer les images d'un dysfonctionnement

Authorizations:
api-elidd_ApiKeyAuth
Request Body schema: application/json
required
siret
required
string^[0-9]{14}$

Le numéro SIRET de l'entreprise

required
object
required
object

Les informations de la pièce jointe

Responses

Request samples

Content type
application/json
{
  • "siret": "string",
  • "contact": {
    },
  • "attachment": {
    }
}

Response samples

Content type
application/json
{
  • "siret": "string",
  • "picture": {
    }
}

other

Récupère la liste des opérations d’un site

Authorizations:
api-hdo_api_key
query Parameters
siret
required
string^\d{14}$

Siret de l'établissement

site_number
required
string

Numéro du point/site

limit
integer <= 500
Default: 500

Nombre d'opérations restitué par l'API

offset
integer
Default: 0

La valeur définit où commencer

hasAllocation
boolean
Default: false

Opération d’allocation (dotation) d’un contenant sur un site en vue de faire des enlèvements par la suite

hasXfer
boolean
Default: false

Opération de transport de déchet depuis un site opérateur vers un autre site opérateur

hasIn
boolean
Default: false

Opération de réception de déchet sur un site

hasInTravel
boolean
Default: false

Opération d’enlevement d’un contenant

hasOut
boolean
Default: false

Opération de transport de déchet vers un site opérateur de type "exutoire"

hasStock
boolean
Default: false

Opération de saisie de stock opérateur

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "operations": [
    ]
}

other

Obtenir le détail d'une opération

Authorizations:
api-duope_ApiKeyAuth
query Parameters
siret
required
string^[0-9]{14}$

SIRET de l'établissement

operation_number
required
string^[0-9]{9}$

Numéro de l'opération

Responses

Response samples

Content type
application/json
{
  • "arrival_site": {
    },
  • "author": {
    },
  • "collect_desired": {
    },
  • "collect_real": {
    },
  • "collect_scheduled": {
    },
  • "comments": [
    ],
  • "container": {
    },
  • "date_insert": "2019-08-24",
  • "identification_number": "string",
  • "identification_number_origin": "string",
  • "junk": {
    },
  • "malfunctions": [
    ],
  • "operator_date_reel": "2019-08-24",
  • "start_site": {
    },
  • "state": "string",
  • "tonnage_received": 0
}

other

Export CSV des opérations d'un ou plusieurs sites

Retourne un fichier CSV des opérations correspondant aux filtres. Le fichier peut être vide selon les paramètres. Contrôles alignés sur la SFD.

Authorizations:
api-edo_ApiKeyAuth
query Parameters
siret
required
string^\d{14}$

SIRET de l'établissement (obligatoire). Contrôles :

  • 14 chiffres ('^\d{14}$')
  • Doit exister et appartenir à un compte distributeur
site_number
string^\d+$

Numéro du point. Si renseigné, il doit exister pour l'établissement (SIRET) fourni. Si non renseigné, l'export peut couvrir plusieurs points rattachés selon with_sub_account.

desired_start
string <date>

Date de début souhaitée (AAAA-MM-JJ). Les opérations dont la date souhaitée est ≥ à cette date seront exportées.

desired_end
string <date>

Date de fin souhaitée (AAAA-MM-JJ). Les opérations réalisées ≤ à cette date seront exportées.

operator_validated
boolean
Default: false

Filtre opérations validées/facturées par l'opérateur. Par défaut false si absent.

executed_start
string <date>

Date de début réelle (AAAA-MM-JJ). Les opérations réalisées ≥ à cette date seront exportées.

executed_end
string <date>

Date de fin réelle (AAAA-MM-JJ). Les opérations réalisées ≤ à cette date seront exportées.

has_malfunction
boolean
Default: false

Filtre opérations avec dysfonctionnements. Par défaut false si absent.

junk_type
string

Filtre sur le type de déchet (short_label du référentiel). Si renseigné, doit exister dans le référentiel.

with_sub_account
boolean
Default: false

Inclure les opérations des établissements rattachés au compte parent (SIRET fourni). Par défaut false.

Responses

Response samples

Content type
text/csv
"Numéro unique d'origine de l'opération";"Numéro unique de correction de l'operation";"Nom du point d'enlèvement";"Numéro du point d'enlèvement";"Nom du compte du point d'enlèvement";"Numéro du compte du point d'enlèvement";"Adresse du point d'enlèvement";"Ville du point d'enlèvement";"Code postal du point d'enlèvement";"Date de la demande";"Heure de la demande";"Etat de l'opération";"Date d'enlèvement souhaitée";"Enlèvement souhaitée (Mois-Année)";"Heure début d'enlèvement souhaitée";"Heure fin d'enlèvement souhaitée";"Précision du créneau";"Date d'enlèvement réel";"Enlèvement réel (Mois-Année)";"Heure d'enlèvement réelle";"Type de déchet";"Contenant";"Tonnage collecté net";"Quantité envoyée";"Date de validation de l'opération par l'opérateur";"Benne déclassée";"Issu d'un planning";"Dysfonctionnement reçu";"Dysfonctionnement émis";"Nom du site d'arrivée";"Adresse du site d'arrivée";"Ville du site d'arrivée";"Code postal du site d'arrivée"

700349669;;"IKEA BORDEAUX";2107431;"IKEA BORDEAUX";0428754;"Bordeaux-Lac ";"Centre commercial Bordeaux-Lac Avenue des 40 journaux ";33049;09/06/2016;15:02:08;Traité;24/06/2016;06-2016;16:00:00;16:00:00;;2016-06-27;06-2016;;"Mélange REP EM";"Benne ampliroll 30 m3";0,44;;"2016-07-08 10:21:55";Non;Non;Non;Non;CDT_BEG33_VEOLIA;"ZI TARTIFUME";BEGLES;33322

other

Récupérer une pièce jointe

Retourne le contenu encodé en base64 d'une pièce jointe identifiée.

Authorizations:
api-rpjd_ApiKeyAuth
query Parameters
siret
required
string^[0-9]{14}$

Numéro SIRET de l'établissement

attachment_id
required
string

Identifiant de la pièce jointe

Responses

Response samples

Content type
application/json
{
  • "attachment": {
    }
}

other

Liste des contenants

Retourne la liste des contenants disponibles.

Authorizations:
api-rdco_ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

other

Liste des déchets

Retourne la liste des déchets disponibles.

Authorizations:
api-rdde_ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

other

Liste des motifs de dysfonctionnement

Retourne les motifs de dysfonctionnement utilisables par les partenaires.

Authorizations:
api-rdmdy_ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

other

Liste des prestations

Retourne la liste des prestations disponibles.

Authorizations:
api-rdpr_ApiKeyAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

other

Signaler un dysfonctionnement

Authorizations:
api-sudy_ApiKeyAuth
Request Body schema: application/json
required
siret
required
string^[0-9]{14}$

Numéro de Siret de l’établissement, sera l'émetteur du dysfonctionnement

site_number
required
integer

Numéro du point

operation_number
required
integer

Numéro d’opération en lien avec le dysfonctionnement

observation_date
required
string <date>

Date de constat

reason_code
required
string

Code du motif de dysfonctionnement issu de l'API des motifs de dysfonctionnement

description
required
string

Description du dysfonctionnement

required
object

Contient les informations du contact qui a signalé le dysfonctionnement

attachments
Array of integers

Contient une liste des identifiants des pièces-jointes

Responses

Request samples

Content type
application/json
{
  • "siret": "string",
  • "site_number": 0,
  • "operation_number": 0,
  • "observation_date": "2019-08-24",
  • "reason_code": "string",
  • "description": "string",
  • "contact": {
    },
  • "attachments": [
    ]
}

Response samples

Content type
application/json
{
  • "error": "BAD_REQUEST"
}