{"introduction":"This document provides a reference for both query and response for the Cancellation and Deletion APIs version 1.0. This document includes a series of notes and instructions that outline the Cancellation and Deletion APIs.","audience":{"label":"Audience","description":"This document is aimed for Cancellation/Deletion API customers, partners and software developers who would like to consume the Cancellation/Deletion API."},"overview":{"label":"Overview","description":"These APIs can be used by a non Egencia system for cancelling/deleting an entire booking or a single item in a booking at the trip level. Partners must pass the authentication in order to use the API. When doing POST request to do cancellation/deletion, the requests that succeed will send a success response and the requests that don’t succeed will send back an error."},"versioning":{"versions":[{"id":"1.0","change_description":"First stable version."}]},"error_codes":[{"code":"EGE-ER-OS-4002","description":"Resource not found, you are trying to access an invalid or non existent resource."},{"code":"EGE-ER-OS-5001","description":"Unable to process your request right now. Please try again later."},{"code":"EGE-ER-OS-5011","description":"There was an error in cancelling the [list of item ids] items. Please try again."},{"code":"EGE-ER-OS-5012","description":"There was an error in deleting the [list of item ids] items. Please try again."}],"api_details":{"label":"API details","subheadings":[{"label":"Cancellation API","subheadings":[{"label":"Trip level","description":"The Egencia Cancellation API allows the clients to cancel a booking. Clients send the unique identifier for the trip, then call the cancel API and all the trip-items that will be present in a trip get cancelled. The Cancellation API returns the CANCELLED status for the trip items for which cancellation was successful or returns the FAILURE status for the trip items, error message, and error code in case of failure.\n The Cancellation API provides users with a simple, standardised, resource-oriented, RESTful interface with JSON-formatted responses that make it easy to perform the cancel action.\n To have a secure data transfer and streamlined integration, we use the HTTPs protocol for API calls."},{"label":"Trip Item level","description":"The Egencia Cancellation API at trip item level allows the clients to cancel a particular trip item that is present in the booking. Clients send the bookingId and unique identifier for the trip item, then call the cancel API at trip item level and if it is eligible for cancellation, that trip item will get cancelled. In case of successful cancellation the cancel API returns the action level status as SUCCESS and in case of failure the cancel API returns the action level status as FAILURE, error_code, error_message."}]},{"label":"Deletion API","subheadings":[{"label":"Trip level","description":"The Egencia Deletion API at trip level allows the clients to delete a booking. Clients send the unique identifier for the trip, then call the delete API and the trip-items that will be present in the trip and are eligible for deletion get deleted. In case of successful deletion the delete API returns the action level status as SUCCESS and also status of each trip item and in case of failure the delete API returns the action level status as FAILURE, error_code, error_message and also status of each trip item."},{"label":"Trip Item level","description":"The Egencia Deletion API at trip item level allows the clients to delete a particular trip item that is present in the booking. Clients send the bookingId and unique identifier for the trip item, then call the delete API at trip item level and if it is eligible for deletion that trip item will get deleted. In case of successful deletion the delete API returns the action level status as SUCCESS and in case of failure the delete API returns the action level status as FAILURE, error_code, error_message."}]}]},"enumerations":{},"documentation_link":"https://apis.egencia.com/openconnect/docs/api-docs/CancellationDeletionAPI"}