GET WordLists/{id}

Get word list details.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Word list id.

integer

Required

Body Parameters

None.

Response Information

Resource Description

A WordListModel object.

WordListModel
NameDescriptionTypeAdditional information
Description

Word list description.

string

None.

Disabled

Indicates if the word list is disabled (true = disabled).

boolean

None.

DisabledDate

Date and time for disabling.

date

None.

History

Revision history.

HistoryModel

None.

Id

Word list unique identity.

integer

None.

Name

Word list name.

string

None.

NumberOfItems

Number of lemmas in the word list.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "description": "sample string 1",
  "disabled": true,
  "disabledDate": "2021-09-25T01:56:33.6604625+02:00",
  "history": {
    "createdByUserName": "sample string 1",
    "createdDate": "2021-09-25T01:56:33.6604625+02:00",
    "modifiedByUserName": "sample string 3",
    "modifiedDate": "2021-09-25T01:56:33.6604625+02:00"
  },
  "id": 3,
  "name": "sample string 4",
  "numberOfItems": 5
}

application/xml, text/xml

Sample:
<WordListModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ContentFlight.Vt.Api.Models">
  <Description>sample string 1</Description>
  <Disabled>true</Disabled>
  <DisabledDate>2021-09-25T01:56:33.6604625+02:00</DisabledDate>
  <History>
    <CreatedByUserName>sample string 1</CreatedByUserName>
    <CreatedDate>2021-09-25T01:56:33.6604625+02:00</CreatedDate>
    <ModifiedByUserName>sample string 3</ModifiedByUserName>
    <ModifiedDate>2021-09-25T01:56:33.6604625+02:00</ModifiedDate>
  </History>
  <Id>3</Id>
  <Name>sample string 4</Name>
  <NumberOfItems>5</NumberOfItems>
</WordListModel>