POST api/translation

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SearchSegment	string	None.
ResultLimit	integer	None.
ShouldReplaceNumbers	boolean	None.
ShouldDoTermRecognition	boolean	None.
ShouldUseRtf	boolean	None.
ShouldSetHyperlinksMatch	boolean	None.
DatabaseType	DatabaseType	None.
SourceLanguageId	integer	None.
TargetLanguageId	integer	None.
SubjectId	integer	None.
SubsubjectId	integer	None.
ProjectCode	string	None.
MinMatchPercent	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SearchSegment": "sample string 1",
  "ResultLimit": 2,
  "ShouldReplaceNumbers": true,
  "ShouldDoTermRecognition": true,
  "ShouldUseRtf": true,
  "ShouldSetHyperlinksMatch": true,
  "DatabaseType": 1,
  "SourceLanguageId": 7,
  "TargetLanguageId": 8,
  "SubjectId": 9,
  "SubsubjectId": 10,
  "ProjectCode": "sample string 11",
  "MinMatchPercent": 12
}

application/xml, text/xml

Sample:

<GetTranslationSingleBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TTWebApi.Models">
  <DatabaseType>Private</DatabaseType>
  <MinMatchPercent>12</MinMatchPercent>
  <ProjectCode>sample string 11</ProjectCode>
  <SourceLanguageId>7</SourceLanguageId>
  <SubjectId>9</SubjectId>
  <SubsubjectId>10</SubsubjectId>
  <TargetLanguageId>8</TargetLanguageId>
  <ResultLimit>2</ResultLimit>
  <ShouldDoTermRecognition>true</ShouldDoTermRecognition>
  <ShouldReplaceNumbers>true</ShouldReplaceNumbers>
  <ShouldSetHyperlinksMatch>true</ShouldSetHyperlinksMatch>
  <ShouldUseRtf>true</ShouldUseRtf>
  <SearchSegment>sample string 1</SearchSegment>
</GetTranslationSingleBindingModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetTranslationSingleBindingModel'.

Response Information

Resource Description

GetTranslationsResult

Name	Description	Type	Additional information
SearchResults		Collection of TranslationResult	None.
HighlightPositions		Collection of HighlightPosition	None.

Response Formats

application/json, text/json

Sample:

{
  "SearchResults": [
    {
      "EntryId": 1,
      "MatchPercent": 2,
      "SearchSegment": "sample string 3",
      "SourceSegment": "sample string 4",
      "TargetSegment": "sample string 5",
      "Ownership": 1,
      "ProjectMatch": true,
      "ProjectCode": "sample string 7",
      "ProjectDescription": "sample string 8"
    },
    {
      "EntryId": 1,
      "MatchPercent": 2,
      "SearchSegment": "sample string 3",
      "SourceSegment": "sample string 4",
      "TargetSegment": "sample string 5",
      "Ownership": 1,
      "ProjectMatch": true,
      "ProjectCode": "sample string 7",
      "ProjectDescription": "sample string 8"
    }
  ],
  "HighlightPositions": [
    {
      "Begin": 1,
      "End": 2
    },
    {
      "Begin": 1,
      "End": 2
    }
  ]
}

application/xml, text/xml

Sample:

<GetTranslationsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TTWebApi.Models">
  <HighlightPositions>
    <HighlightPosition>
      <Begin>1</Begin>
      <End>2</End>
    </HighlightPosition>
    <HighlightPosition>
      <Begin>1</Begin>
      <End>2</End>
    </HighlightPosition>
  </HighlightPositions>
  <SearchResults>
    <TranslationResult>
      <EntryId>1</EntryId>
      <MatchPercent>2</MatchPercent>
      <Ownership>Public</Ownership>
      <ProjectCode>sample string 7</ProjectCode>
      <ProjectDescription>sample string 8</ProjectDescription>
      <ProjectMatch>true</ProjectMatch>
      <SearchSegment>sample string 3</SearchSegment>
      <SourceSegment>sample string 4</SourceSegment>
      <TargetSegment>sample string 5</TargetSegment>
    </TranslationResult>
    <TranslationResult>
      <EntryId>1</EntryId>
      <MatchPercent>2</MatchPercent>
      <Ownership>Public</Ownership>
      <ProjectCode>sample string 7</ProjectCode>
      <ProjectDescription>sample string 8</ProjectDescription>
      <ProjectMatch>true</ProjectMatch>
      <SearchSegment>sample string 3</SearchSegment>
      <SourceSegment>sample string 4</SourceSegment>
      <TargetSegment>sample string 5</TargetSegment>
    </TranslationResult>
  </SearchResults>
</GetTranslationsResult>