VitalWare API

<back to all web services

DocumentV2

The following routes are available for this service:
POST/NLP/v2/indexReturns NLP Results
Parameters:
NameParameterData TypeRequiredDescription
textpathstringNoDocument text

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/DocumentV2 HTTP/1.1 
Host: api.vitalware.com 
Content-Type: application/xml
Content-Length: length

<DocumentV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Text>String</Text>
</DocumentV2>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <Result xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>String</d2p1:Key>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </Result>
</DocumentResponse>