SOAP API Reference
- Pascal Himmel (Unlicensed)
- HelpdeskJV
SOAP API Reference
JoinVision offers a SOAP 1.1 interface for accessing the semantic extraction services. This page describes the different SOAP methods and explains their parameters and output in detail.
Service Location
Address: https://cvlizer.joinvision.com/cvlizer/exservicesoap
WSDL: https://cvlizer.joinvision.com/cvlizer/exservicesoap?wsdlService Name: {http://servlets.iex.jv.com/}SemanticExtractionService
Port Name: {http://servlets.iex.jv.com/}SemanticExtractionPortMethod Descriptions
For each method you will need to provide your product token. How to find the product token is explained here.
Get Contingent
Get the current contingent (e.g. number of conversions) left for a specific product.
Signature
Integer getContingent(String username, String token)Request Parameters
Parameter | Type | Description |
|---|---|---|
username | String | An empty string |
token | String | Your product token |
Response
If your request is successful, the API returns an Integer that describes the remaining contingent.
Error Handling
Returns a SOAPException in case of authentication issues.
Get XML Domains
Get the most recent domain value lists as XML.
Signature
Request Parameters
Parameter | Type | Description |
|---|---|---|
language | String | The preferred Target Language in which the long-values of the domains should be returned. |
Response
If your request is successful, the API returns a XML object with the most recent domain values:
Error Handling
Returns a SOAPException in case the provided language is invalid.
Extract To XML
This method returns a structured XML containing all extracted information for a provided input file. Based on the selected Extraction Model, the returned XML validates against the respective XML Schema for the applied extraction mode.
The Target Language indicates in which language the long-values for the extracted abstraction codes (like skills, operation areas, education level, …) are returned. It does NOT define target or source language of the whole document. Text translation is not performed.
Extracting from an URL
It is possible to pass an URL instead of a binary document. In this case, the parameter “filetype” is set to “url” and the parameter “document” has to contain the UTF-8 encoded URL itself