Webappella Web Services

<back to all web services

CorrectionRequest

The following routes are available for this service:
POST/correction/
GET OPTIONS/correction/{CurrentWord}
GET OPTIONS/correction/{CurrentWord}/{PrecedingText}
GET OPTIONS/correction/{CurrentWord}/{PrecedingText}/{SucceedingText}
CorrectionRequest Parameters:
NameParameterData TypeRequiredDescription
CurrentWordpathstringNo
PrecedingTextpathstringNo
SucceedingTextpathstringNo
LanguagebodystringNo
NumberOfSuggestionsbodystringNo
CorrectionResult Parameters:
NameParameterData TypeRequiredDescription
lingitwordsbodyLingitWordsCorrectionNo
HasErrorbodyboolNo
LingitWordsCorrection Parameters:
NameParameterData TypeRequiredDescription
correctionbodySuggestionWrapper[]No
SuggestionWrapper Parameters:
NameParameterData TypeRequiredDescription
TextbodystringNo
ResultTextbodystringNo
DisplayTextbodystringNo
LookUpTypebodyLookupTypeNo

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/CorrectionRequest HTTP/1.1 
Host: 3.248.250.59 
Content-Type: application/xml
Content-Length: length

<CorrectionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/webappella">
  <CurrentWord>String</CurrentWord>
  <Language>String</Language>
  <NumberOfSuggestions>String</NumberOfSuggestions>
  <PrecedingText>String</PrecedingText>
  <SucceedingText>String</SucceedingText>
</CorrectionRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CorrectionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/webappella">
  <HasError>false</HasError>
  <lingitwords>
    <correction xmlns:d3p1="http://schemas.datacontract.org/2004/07/webappella.Speller">
      <d3p1:SuggestionWrapper i:nil="true" />
    </correction>
  </lingitwords>
</CorrectionResult>