| Table of Contents | ||
|---|---|---|
|
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.
...
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.
...
| Code Block | ||
|---|---|---|
| ||
Integer getContingent(String username, String passwordtoken) |
Request Parameters
Parameter | Type | Description |
|---|---|---|
username | String |
Your username
An empty string | ||
token | String | Your product token |
Response
If your request is successful, the API returns an Integer that describes the remaining contingent.
...
| Code Block | ||
|---|---|---|
| ||
String getXMLDomainsFor(String language) |
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:
...
| Code Block | ||
|---|---|---|
| ||
String extractToXML(String username, String passwordtoken, String language, String model, byte[] inputdata, String inputdatatype) |
Request Parameters
Parameter | Type | Description |
|---|---|---|
username | String |
Your username
An empty string | ||
token | String | Your product token |
language | String | Preferred Target Language |
model | String | |
inputdata | byte[] | Document to be semantically extracted and transformed. Depending on the programming language in use (for instance Ruby and JavaScript) the byte array needs to be converted to a String and base64 encoded before submitting. |
inputdatatype | String | Filetype of the document (document postfix), e.g. 'docx' or the whole filename, e.g. 'document.pdf'. |
| Note |
|---|
If the filename entered in parameter “inputdatatype” does not contain a postfix, the extraction will fail |
...
If your request is successful, the API returns a XML object as String, following the respective XML schema based on the chosen Extraction Model. More information on the returned XML can be found in the JoinVision XML 3.0 Schema Description.
Error Handling
Returns a SOAPException for any kind of extraction problems, containing a detailed error description.
Extracting a LinkedIn/XING profile
To extract data from a LinkedIn or XING profile, “inputdatatype” has to be set to “json-linkedin” or “json-xing” respectively, and “inputdata” has to contain the base64 encoded .json of the profile.
Categorize
JoinVision offers a document classification web service (called “Classifier”) which accepts a set of documents as input, converts each page of the document to PDF, determines the category of each page of the document, extracts the document's plain text and returns a set of categorized documents. The categorization service supports packaged files, like MIME-and MSG-Format (E-mails) and ZIP, also one enclosed in another (like an E-mail with ZIP-attachment). In case of mails the mail body is classified and returned as well.
...
| Code Block | ||
|---|---|---|
| ||
OutputDoc[] categorize(InputDoc[] inputDocs, String domain, String username, String passwordtoken) |
Request Parameters
The required input consists of an array of InputDocs, whereas an inputDoc contains the name of the file (in order to determine the file type) and the file itself as byte array.
Parameter | Type | Description |
|---|---|---|
inputDocs | inputDoc[] | An array of documents in the form of InputDocs |
domain | String | For classifications in the HR-domain, the domain value is always “hr” |
username | String |
Your username
An empty string | ||
token | String | Your product token |
Response
If your request is successful, the API returns an array of OutputDocuments, which contains the binary document as byte array (always “pdf”), the amount of pages, whether or not the document has been OCR converted, the document's original filename, the document's plaintext, and the detected document's category.
...
| Code Block | ||
|---|---|---|
| ||
String mergeToXML(String username, String passwordtoken, String language, String model, InputDoc[] inputDocs) |
...
The required input consists of an array of InputDocs, whereas an inputDoc contains the name of the file (in order to determine the file type) and the file itself as byte array.
Parameter | Type | Description |
|---|---|---|
username | String |
Your username
An empty string | ||||
token | String | Your product token | ||
language | String | Preferred Target Language | ||
model | String |
| ||
inputDocs | inputDoc[] | An array of documents in the form of InputDocs
|
Response
If your request is successful, the API returns a XML object as String, following the respective XML schema based on the chosen Extraction Model. More information on the returned XML can be found in the JoinVision XML 3.0 Schema Description.
Error Handling
Returns a SOAPException for any kind of extraction problems containing a detailed error description.