Warning!

If you are just starting out with the Europass Web Services, use the Europass REST API. As of April 2015, version 2.0 of the Europass SOAP API is no longer available.

Overview

The Europass SOAP API is currently at v2.0 and consists of five services that provide conversion methods between the various file formats supported by Europass. The services accept a machine-interpretable representation of an individual’s personal data (e.g. CV, LP) and return the same data in a different file format.

The file formats that can be used as input are Europass XML, Europass PDF + XML attachment, Europass JSON, HR-XML and PDF + HR-XML attachment. The returned file formats are (apart from those used as input) Microsoft Word 97-2003 (DOC), OpenDocument ver 2 Text (ODT), and HTML. The conversion services methods support conversions for both CV and LP data, since both data can be represented in Europass XML, Europass JSON or HR-XML formats.

Tip

Please note that the document versions supported by the Europass SOAP API v2 are Europass XML v2.0 and earlier, Europass JSON v2.0 and HR-XML v2.5. See also the Compatibility Matrix.

A brief overview of the available services and the corresponding endpoints along with the expected inputs and outputs is presented in the table below:

Input Endpoint Output
1. Europass XML Conversion Service
Europass XML 2.0 convertToPDFwithXMLCV / convertToPDFwithXMLLP PDF+Europass XML 2.0
convertToPDFwithHRXMLCV / convertToPDFwithHRXMLLP PDF+HR-XML 2.5
convertToMSWordCV / convertToMSWordLP MS WORD
convertToODTCV / convertToODTLP ODT
convertToHTMLCV / convertToHTMLLP HTML
2. PDFWithEuropassXMLConversionService
PDF+Europass XML 2.0 extractXML / convertToXMLCV / convertToXMLLP Europass XML 2.0
convertToHRXML HR-XML 2.5
convertToPDFwithHRXMLCV / convertToPDFwithHRXMLLP PDF+HR-XML 2.5
convertToMSWordCV / convertToMSWordLP MS WORD
convertToODTCV / convertToODTLP ODT
convertToHTMLCV / convertToHTMLLP HTML
3. HRXMLConversionService
Europass XML 2.0 convertToHRXML HR-XML 2.5
HR-XML 2.5 convertToXMLCV / convertToXMLLP Europass XML 2.0
convertToPDFwithXMLCV / convertToPDFwithXMLLP PDF+Europass XML 2.0
convertToPDFwithHRXMLCV / convertToPDFwithHRXMLLP PDF+HR-XML 2.5
convertToMSWordCV / convertToMSWordLP MS WORD
convertToODTCV / convertToODTLP ODT
convertToHTMLCV / convertToHTMLLP HTML
4. PDFWithHRXMLConversionService
PDF+HR-XML 2.5 convertToHRXML HR-XML 2.5
convertToXMLCV / convertToXMLLP Europass XML 2.0
convertToPDFwithXMLCV / convertToPDFwithXMLLP PDF+Europass XML 2.0
convertToMSWordCV / convertToMSWordLP MS WORD
convertToODTCV / convertToODTLP ODT
convertToHTMLCV / convertToHTMLLP HTML
5. JSONConversionService
Europass XML 2.0 convertFromXMLCV / convertFromXMLLP Europass JSON 2.0
HR-XML 2.5 convertFromHRXML Europass JSON 2.0
Europass JSON 2.0 convertToXMLCV / convertToXMLLP Europass XML 2.0
convertToHRXML HR-XML 2.5
convertToPDFwithXMLCV / convertToPDFwithXMLLP PDF+Europass XML 2.0
convertToPDFwithHRXMLCV / convertToPDFwithHRXMLLP PDF+HR-XML 2.5
convertToMSWordCV / convertToMSWordLP MS WORD
convertToODTCV / convertToODTLP ODT
convertToHTMLCV / convertToHTMLLP HTML

SOAP API Documentation

Extensive documentation with details and code snippets on how to use the services presented in the previous section can be found in the downloadable PDF below:

Download Europass SOAP API Documentation, v2.0 [europass-soap-api-doc-v2.0.pdf]

SOAP API Client

This tool is a Java-based client for the Europass SOAP API v2. It includes a command line utility in order to specify which conversion method to use and provide the necessary input to call the service.

A zip containing the tool as a JAR along with a short PDF guide on how to use it can be downloaded below.

Download Europass SOAP API Client, v2.0 [europass-soap-api-client-v2.0.zip]

In addition, the source code of the tool is available on GitHub in case you want to experiment with it or re-use it in your own applications.

Previous Versions

There is only one previous version of the Europass SOAP API, namely v1.0. This is only kept for backward compatibility purposes and historical reasons. Please use the Europass REST API if you are just starting out with Europass Interoperability.

Europass SOAP API, v1.0 Details on the deprecated Europass SOAP API version 1.0