>  >  > API Docs 

Xerox Incremental Parser

An advanced incremental text parser for English, French and German with XML output (other languages are also supported, contact us)
4.34000
(29)

How To Use the API

This page describes how to use the SOAP API of this web service. It contains the link to download the WSDL of this service.

The address of the service metadata (Wsdl) is:
https://services.open.xerox.com/Wsdl.svc/XIPParser
Use this address to generate the service stub for your web service client.

You can find more information and instructions to create clients from some development environments on the following help page: How to Use the API You will also find explanations on the OpenXerox authentication system and some sample clients.

Service Operations

parse


string parse(string language, string options, byte[] input)
Soap 1.1 Request :
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://esp.xerox.com/parse</Action>
  </s:Header>
  <s:Body>
    <parse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://esp.xerox.com/">
      <language>language1</language>
      <options>options1</options>
      <input>base64Binary Content</input>
    </parse>
  </s:Body>
</s:Envelope>
        
Soap 1.1 Response :
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://esp.xerox.com/parse</Action>
  </s:Header>
  <s:Body>
    <parseResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://esp.xerox.com/">
      <parseResult>parseResult1</parseResult>
    </parseResponse>
  </s:Body>
</s:Envelope>
        

GET Request :

The easiest request but limited to the size of the url. Mostly used when numbers of parameters are low and when parameters type are 'simple' (numbers, short string, ...)

https://services.open.xerox.com/bus/op/XIPParser/parse?language=text&options=text&input=BASE 64 BINARY
        
POST Request (url encoded) :

Mostly used when number of parameters a high or when parameters string can be long. Can also be used for binary type with Base 64 encoding (but prefer the form encoded method)

POST https://services.open.xerox.com/bus/op/XIPParser/parse
Content-Type: application/x-www-form-urlencoded
Content-Length: 47

language=text&options=text&input=BASE+64+BINARY
        
POST Request (multipart form data encoded) :

Mostly used when parameters contains a byte array to avoid base 64 encoding.

POST https://services.open.xerox.com/bus/op/XIPParser/parse
Content-Type: multipart/form-data; boundary="2e58e637-8b80-41b2-a4bc-9ce809033048"
Content-Length: 461

--2e58e637-8b80-41b2-a4bc-9ce809033048
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=language

text
--2e58e637-8b80-41b2-a4bc-9ce809033048
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=options

text
--2e58e637-8b80-41b2-a4bc-9ce809033048
Content-Disposition: form-data; name=input; filename=sampleFile.txt; filename*=utf-8''sampleFile.txt


--2e58e637-8b80-41b2-a4bc-9ce809033048--

        

Each Rest method call return result as JSON, if you want a XML format as output, you need to add 'oxformat=xml' in the query string url.
More info can be found in the help page here.
JSON Request :

If you wan tto post request as json, you can specify each parameters using a JSON object. Binary type must be base 64 encoded.

POST https://services.open.xerox.com/bus/op/XIPParser/parse
Content-Type: application/json; charset=utf-8
Content-Length: 61

{"language":"text","options":"text","input":"BASE 64 BINARY"}
        

The Xerox Incremental Parser will analyse the text input (parse) and provide a text description of the extracted entities and their relations.

<Options> can take the following values:

  • "-text"      if the input is in text format
  • "-tr -f -text" if the input is in text format and to display dependencies
  • "-t -text"   if the input is in text format, the output displays the syntactic tree
  • "-f -xml -text" if the input is in text format, the output is in xml
  • "-xmltext 2" if the input is in xml

The last option must be "-text" or "-xmltext depth"

For more details about other option values see the XIP Reference Guide documentation or options.

Select a file from Open Xerox Repository:
Local file path:
URL:
Please enter a text:

Result

parseToFile


byte[] parseToFile(string language, string options, byte[] input)
Soap 1.1 Request :
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://esp.xerox.com/parseToFile</Action>
  </s:Header>
  <s:Body>
    <parseToFile xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://esp.xerox.com/">
      <language>language1</language>
      <options>options1</options>
      <input>base64Binary Content</input>
    </parseToFile>
  </s:Body>
</s:Envelope>
        
Soap 1.1 Response :
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://esp.xerox.com/parseToFile</Action>
  </s:Header>
  <s:Body>
    <parseToFileResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://esp.xerox.com/">
      <parseToFileResult>base64Binary Content</parseToFileResult>
    </parseToFileResponse>
  </s:Body>
</s:Envelope>
        

GET Request :

The easiest request but limited to the size of the url. Mostly used when numbers of parameters are low and when parameters type are 'simple' (numbers, short string, ...)

https://services.open.xerox.com/bus/op/XIPParser/parseToFile?language=text&options=text&input=BASE 64 BINARY
        
POST Request (url encoded) :

Mostly used when number of parameters a high or when parameters string can be long. Can also be used for binary type with Base 64 encoding (but prefer the form encoded method)

POST https://services.open.xerox.com/bus/op/XIPParser/parseToFile
Content-Type: application/x-www-form-urlencoded
Content-Length: 47

language=text&options=text&input=BASE+64+BINARY
        
POST Request (multipart form data encoded) :

Mostly used when parameters contains a byte array to avoid base 64 encoding.

POST https://services.open.xerox.com/bus/op/XIPParser/parseToFile
Content-Type: multipart/form-data; boundary="d2f6b821-ebc5-4aad-8151-79bce506cd78"
Content-Length: 461

--d2f6b821-ebc5-4aad-8151-79bce506cd78
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=language

text
--d2f6b821-ebc5-4aad-8151-79bce506cd78
Content-Type: text/plain; charset=utf-8
Content-Disposition: form-data; name=options

text
--d2f6b821-ebc5-4aad-8151-79bce506cd78
Content-Disposition: form-data; name=input; filename=sampleFile.txt; filename*=utf-8''sampleFile.txt


--d2f6b821-ebc5-4aad-8151-79bce506cd78--

        

Each Rest method call return result as JSON, if you want a XML format as output, you need to add 'oxformat=xml' in the query string url.
More info can be found in the help page here.
JSON Request :

If you wan tto post request as json, you can specify each parameters using a JSON object. Binary type must be base 64 encoded.

POST https://services.open.xerox.com/bus/op/XIPParser/parseToFile
Content-Type: application/json; charset=utf-8
Content-Length: 61

{"language":"text","options":"text","input":"BASE 64 BINARY"}
        

Same input parameters than "Parse text" but the output will be stored in a file.

This file can be access by a clic on "<binary>" in the result message.

Select a file from Open Xerox Repository:
Local file path:
URL:
Please enter a text:

Result

Comments

Rate this service :
User Name:
Enter the 2 words: Get a new challenge Get an audio challenge Get a visual challenge Help