POST Glossary

Returns a glossary for the text posted.

Request Information

URI Parameters

None.

Body Parameters

Post data.

GlossaryPostData
NameDescriptionTypeAdditional information
Text

Text to get the glossary for.

string

Required

WordListIds

A collection of id numbers for the word lists to include. Default is all word lists available to the user.

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "text": "sample string 1",
  "wordListIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<GlossaryController.GlossaryPostData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Controllers">
  <Text>sample string 1</Text>
  <WordListIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </WordListIds>
</GlossaryController.GlossaryPostData>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of GlossaryItem objects for the text.

Collection of GlossaryItem
NameDescriptionTypeAdditional information
Definition

The definition of the item.

string

None.

Entries

A list of word list entries for the item.

Collection of GlossaryEntry

None.

Id

The item id.

integer

None.

ItemTypeId

The item type id.

integer

None.

Links

Links to related resources.

Collection of Link

None.

WordClassId

The word class id.

integer

None.

WordListIds

Id for related word lists.

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "definition": "sample string 1",
    "entries": [
      {
        "id": 1,
        "inflectionId": 1,
        "links": [
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          },
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          }
        ],
        "matchCount": 2,
        "rightSideEntries": [
          {
            "value": "sample string 1"
          },
          {
            "value": "sample string 1"
          }
        ],
        "value": "sample string 3",
        "value2": "sample string 4"
      },
      {
        "id": 1,
        "inflectionId": 1,
        "links": [
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          },
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          }
        ],
        "matchCount": 2,
        "rightSideEntries": [
          {
            "value": "sample string 1"
          },
          {
            "value": "sample string 1"
          }
        ],
        "value": "sample string 3",
        "value2": "sample string 4"
      }
    ],
    "id": 2,
    "itemTypeId": 3,
    "links": [
      {
        "href": "sample string 1",
        "rel": "sample string 2"
      },
      {
        "href": "sample string 1",
        "rel": "sample string 2"
      }
    ],
    "wordClassId": 1,
    "wordListIds": [
      1,
      2
    ]
  },
  {
    "definition": "sample string 1",
    "entries": [
      {
        "id": 1,
        "inflectionId": 1,
        "links": [
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          },
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          }
        ],
        "matchCount": 2,
        "rightSideEntries": [
          {
            "value": "sample string 1"
          },
          {
            "value": "sample string 1"
          }
        ],
        "value": "sample string 3",
        "value2": "sample string 4"
      },
      {
        "id": 1,
        "inflectionId": 1,
        "links": [
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          },
          {
            "href": "sample string 1",
            "rel": "sample string 2"
          }
        ],
        "matchCount": 2,
        "rightSideEntries": [
          {
            "value": "sample string 1"
          },
          {
            "value": "sample string 1"
          }
        ],
        "value": "sample string 3",
        "value2": "sample string 4"
      }
    ],
    "id": 2,
    "itemTypeId": 3,
    "links": [
      {
        "href": "sample string 1",
        "rel": "sample string 2"
      },
      {
        "href": "sample string 1",
        "rel": "sample string 2"
      }
    ],
    "wordClassId": 1,
    "wordListIds": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfGlossaryItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models.Glossaries">
  <GlossaryItem>
    <Definition>sample string 1</Definition>
    <Entries>
      <GlossaryEntry>
        <Id>1</Id>
        <InflectionId>1</InflectionId>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
        </Links>
        <MatchCount>2</MatchCount>
        <RightSideEntries>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
        </RightSideEntries>
        <Value>sample string 3</Value>
        <Value2>sample string 4</Value2>
      </GlossaryEntry>
      <GlossaryEntry>
        <Id>1</Id>
        <InflectionId>1</InflectionId>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
        </Links>
        <MatchCount>2</MatchCount>
        <RightSideEntries>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
        </RightSideEntries>
        <Value>sample string 3</Value>
        <Value2>sample string 4</Value2>
      </GlossaryEntry>
    </Entries>
    <Id>2</Id>
    <ItemTypeId>3</ItemTypeId>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
      <d3p1:Link>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:Link>
    </Links>
    <WordClassId>1</WordClassId>
    <WordListIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </WordListIds>
  </GlossaryItem>
  <GlossaryItem>
    <Definition>sample string 1</Definition>
    <Entries>
      <GlossaryEntry>
        <Id>1</Id>
        <InflectionId>1</InflectionId>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
        </Links>
        <MatchCount>2</MatchCount>
        <RightSideEntries>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
        </RightSideEntries>
        <Value>sample string 3</Value>
        <Value2>sample string 4</Value2>
      </GlossaryEntry>
      <GlossaryEntry>
        <Id>1</Id>
        <InflectionId>1</InflectionId>
        <Links xmlns:d5p1="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
          <d5p1:Link>
            <d5p1:Href>sample string 1</d5p1:Href>
            <d5p1:Rel>sample string 2</d5p1:Rel>
          </d5p1:Link>
        </Links>
        <MatchCount>2</MatchCount>
        <RightSideEntries>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
          <GlossaryEntry.RightSideGlossaryEntry>
            <Value>sample string 1</Value>
          </GlossaryEntry.RightSideGlossaryEntry>
        </RightSideEntries>
        <Value>sample string 3</Value>
        <Value2>sample string 4</Value2>
      </GlossaryEntry>
    </Entries>
    <Id>2</Id>
    <ItemTypeId>3</ItemTypeId>
    <Links xmlns:d3p1="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
      <d3p1:Link>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:Link>
      <d3p1:Link>
        <d3p1:Href>sample string 1</d3p1:Href>
        <d3p1:Rel>sample string 2</d3p1:Rel>
      </d3p1:Link>
    </Links>
    <WordClassId>1</WordClassId>
    <WordListIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </WordListIds>
  </GlossaryItem>
</ArrayOfGlossaryItem>