Download OpenAPI specification:
Cette API permet à un partenaire d'annuler une opération d'enlèvement.
| 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 |
{- "siret": "string",
- "operation_number": "string",
- "comment": "string",
- "contact": {
- "firstname": "string",
- "lastname": "string",
- "email": "user@example.com"
}
}| siret required | string^[0-9]{14}$ Siret de l'établisssment |
| malfunction required | integer Identifiant d'un dysfonctionnement d'opération |
{- "identification_number": 0,
- "date_seased": "2019-08-24",
- "observation_date": "2019-08-24",
- "reason_code": "string",
- "state": "string",
- "operation_id": 0,
- "author": {
- "firstname": "string",
- "lastname": "string",
- "email": "user@example.com"
}, - "operator": {
- "name": "string",
- "siret": "string"
}, - "description": "string",
- "abort_reason": "string",
- "account_questioned_notified": true,
- "action_plan": "string",
- "attachments": [
- 0
], - "comments": [
- {
- "date": "2019-08-24T14:15:22Z",
- "message": "string",
- "author": {
- "firstname": "string",
- "lastname": "string",
- "email": "user@example.com"
}
}
]
}required | object |
| comment | string Commentaire de la demande |
required | object |
| container required | string Type de contenant |
| count_sent | integer Quantité de caisses-palettes en sortie du site de départ |
| is_public | string Enum: "true" "false" Visibilité du commentaire |
| junk_type required | string Type de déchet |
| siret required | string^[0-9]{14}$ Numéro de SIRET de l'établissement |
| site_number required | string Numéro du point |
{- "collect_desired": {
- "date": "2019-08-24",
- "hour": {
- "end": "string",
- "start": "string"
}, - "time_slot": "AM"
}, - "comment": "string",
- "contact": {
- "email": "user@example.com",
- "firstname": "string",
- "lastname": "string"
}, - "container": "string",
- "count_sent": 0,
- "is_public": "true",
- "junk_type": "string",
- "siret": "string",
- "site_number": "string"
}{- "error": "BAD_REQUEST"
}| siret required | string^[0-9]{14}$ Le numéro SIRET de l'entreprise |
required | object |
required | object Les informations de la pièce jointe |
{- "siret": "string",
- "contact": {
- "firstname": "string",
- "lastname": "string",
- "email": "user@example.com"
}, - "attachment": {
- "name": "string",
- "content": "string"
}
}{- "siret": "string",
- "picture": {
- "name": "string",
- "download_id": "string"
}
}| 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 |
{- "count": 0,
- "operations": [
- {
- "collect_desired": {
- "date": "2019-08-24"
}, - "date_insert": "2019-08-24",
- "identification_number": "string",
- "junk": {
- "code": "string",
- "code_ced": "string",
- "name": "string"
}, - "last_correction_number": "string",
- "malfunction_flag": true,
- "removal_trip": "string",
- "service_name": "string",
- "state": "string"
}
]
}| siret required | string^[0-9]{14}$ Numéro SIRET de l’établissement |
{- "account_name": "string",
- "siret": "string",
- "sites": [
- {
- "address": "string",
- "city": "string",
- "contact": {
- "email": "user@example.com",
- "firstname": "string",
- "lastname": "string",
- "phone": "string"
}, - "postal_code": "string",
- "site_active": true,
- "site_name": "string",
- "site_number": "string"
}
]
}| siret required | string^\d{14}$ Siret de l'établissement |
| site_number required | string Numéro du point/site |
{- "containers": [
- {
- "container": {
- "code": "string",
- "name": "string"
}, - "dateDesired": "2019-08-24",
- "dateReal": "2019-08-24",
- "date_desired": "2019-08-24",
- "date_end": "2019-08-24",
- "date_real": "2019-08-24",
- "junk": {
- "code": "string",
- "code_ced": "string",
- "name": "string"
}, - "operator": {
- "contact": {
- "email": "user@example.com",
- "firstname": "string",
- "lastname": "string",
- "phone": "string"
}, - "name": "string",
- "siret": "string"
}, - "rank": 0
}
], - "siret": "string",
- "site": {
- "name": "string",
- "number": "string"
}
}| siret required | string^[0-9]{14}$ SIRET de l'établissement |
| operation_number required | string^[0-9]{9}$ Numéro de l'opération |
{- "arrival_site": {
- "contact": {
- "email": "user@example.com",
- "firstname": "string",
- "lastname": "string",
- "phone": "string"
}, - "identification_number": "string",
- "name": "string"
}, - "author": {
- "email": "user@example.com",
- "firstname": "string",
- "lastname": "string",
- "phone": "string"
}, - "collect_desired": {
- "count_sent": 0,
- "date": "2019-08-24",
- "hour": {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
}, - "collect_real": {
- "count_received": 0,
- "date_real_collect": "2019-08-24",
- "hour_collect": "14:15:22Z"
}, - "collect_scheduled": {
- "date": "2019-08-24",
- "hour": {
- "end": "14:15:22Z",
- "start": "14:15:22Z"
}
}, - "comments": [
- "string"
], - "container": {
- "code": "string",
- "name": "string"
}, - "date_insert": "2019-08-24",
- "identification_number": "string",
- "identification_number_origin": "string",
- "junk": {
- "code": "string",
- "code_ced": "string",
- "name": "string"
}, - "malfunctions": [
- "string"
], - "operator_date_reel": "2019-08-24",
- "start_site": {
- "contact": {
- "email": "user@example.com",
- "firstname": "string",
- "lastname": "string",
- "phone": "string"
}, - "identification_number": "string",
- "name": "string"
}, - "state": "string",
- "tonnage_received": 0
}Retourne le contenu encodé en base64 d'une pièce jointe identifiée.
| siret required | string^[0-9]{14}$ Numéro SIRET de l'établissement |
| attachment_id required | string Identifiant de la pièce jointe |
{- "attachment": {
- "name": "string",
- "content": "string"
}
}| 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 |
{- "siret": "string",
- "site_number": 0,
- "operation_number": 0,
- "observation_date": "2019-08-24",
- "reason_code": "string",
- "description": "string",
- "contact": {
- "firstname": "string",
- "lastname": "string",
- "email": "user@example.com"
}, - "attachments": [
- 0
]
}{- "error": "BAD_REQUEST"
}