GET keywords

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

None.

Body Parameters

None.

Response Information

Resource Description (Keyword)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

Name	Description
ID `integer` Required ID of the given keyword.	`integer` Required ID of the given keyword.
Phrase `string` Required Custom phrase of the given keyword. (Max length 200 characters)	`string` Required Custom phrase of the given keyword. (Max length 200 characters)
Plural `string` Required Custom plural value of the given keyword. (Max length 200 characters)	`string` Required Custom plural value of the given keyword. (Max length 200 characters)
Category `byte` ReadOnly Category of the given keyword.	`byte` ReadOnly Category of the given keyword.
CategoryName `string` ReadOnly Category name of the given keyword.	`string` ReadOnly Category name of the given keyword.
Type `integer` ReadOnly Row type of the object for the given keyword.	`integer` ReadOnly Row type of the object for the given keyword.
DefaultPhrase `string` ReadOnly Default phrase of the given keyword.	`string` ReadOnly Default phrase of the given keyword.
DefaultPlural `string` ReadOnly Default plural value of the given keyword.	`string` ReadOnly Default plural value of the given keyword.
Description `string` ReadOnly Description of the given keyword.	`string` ReadOnly Description of the given keyword.
DefaultDisplay `string` ReadOnly Default display of the given keyword.	`string` ReadOnly Default display of the given keyword.

Response Formats

application/xml, text/xml

Sample

<Keyword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <Phrase>sample string 1</Phrase>
  <Plural>sample string 2</Plural>
  <Category>64</Category>
  <CategoryName>sample string 3</CategoryName>
  <Type>1</Type>
  <DefaultPhrase>sample string 4</DefaultPhrase>
  <DefaultPlural>sample string 5</DefaultPlural>
  <Description>sample string 6</Description>
  <DefaultDisplay>sample string 7</DefaultDisplay>
</Keyword>

application/json, text/json

Sample

{
  "ID": 1,
  "Phrase": "sample string 1",
  "Plural": "sample string 2",
  "Category": 64,
  "CategoryName": "sample string 3",
  "Type": 1,
  "DefaultPhrase": "sample string 4",
  "DefaultPlural": "sample string 5",
  "Description": "sample string 6",
  "DefaultDisplay": "sample string 7"
}