The Essential Data API
The ESPD Service's Essential Data API enables publishers to integrate all functions of the ESPD Service to the buyer profiles that they administer.
The offered functions enable publishers to go through all the recording, update, identifier retrieval and all essential data stages.
When a buyer profile wishes to record essential data in the ESPD database, it must use the enregistrerDE operation of the Essential Data API.
This API enables to record the essential data coming from parameters that went to input.
To access the page dedicated to the enregistrerDE operation, please click here.
- The single contract identifier is unique to each buyer. It is part of the essential data that must be published. However, there can be redundancies in the case where multiple buyer profiles have the same naming rules. The contract number is therefore systematically associated to a buyer.
- The functional reference identifier is the unique ESPD Service - Essential Data reference given when recording essential data in order to guarantee uniqueness.
Those identifiers then enable to modify or retrieve the essential data recorded in the ESPD Service. It is important to note that the contract's baseline data cannot be modified after publication.
/ In certain cases, the call for tenders and the lot cannot exist in the ESPD Service referential.
/ There can also be multiple essential data for a single lot and a single call for tenders.
When a buyer profile wishes to modify the essential data contained in the ESPD Service database, it must use the Essential data API's MettreAJourDonneesEssentielles operation.
The update regards data communicated to the ESPD Service but not published, not yet communicated or modification and execution data.
A message is sent to the buyer profile in order to inform it of the modification or not of the data.
To access the page dedicated to the MettreAJourDonneesEssentielles operation, please click here.
When the data are published, the contract's baseline data cannot be updated.
The Essential data API's MettreAJourDonneesEssentielles operation also enables to complete the essential data transmitted to the ESPD Service. Indeed, if the data sent during the recorded were incomplete, they can be completed thanks to the update operation.
More specifically, in the case where a buyer has modified a baseline data in his or her call for tenders while the data have already been sent to the ESPD Service, it will be possible to amend it if it hasn't been published yet.
The execution and modification data are historized, not replaced. Thus, the most recent execution or modification data will be in first position in the JSON format.
Example: Case where it is necessary to replace the initial holder by another holder, cost change,etc.
When a buyer profile wishes to retrieve the identifier(s) of essential data associated with a lot and a call for tenders, it must use the Essential data API's recupererIdDE operation.
The marketplace is informed of whether the data was modified by a message or not.
In order to access the page dedicated to the recupererIdDE operation, please click here.
When a buyer profile wishes to retrieve the essential data contained in the ESPD database, it must use the Essential data API's recupererDE operation.
This operation enables the buyer profile to publish essential data without having to stock them in its database; In the case where essential data are contained in the ESPD Service's database, they are returned in PDF, XML or HTML format, complementing the JSON format.
This API retrieves all of the essential data coming from the search criteria that went into input parameter.
In order to access the page dedicated to the recupererDE operation, please click here.
Last Update: January 9, 2020