Back

GET colors/{id}

Read a single color by color Id.

Request Information

URI Parameters

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

Guid ID of the color to be read.

Body Parameters

None.

Response Information

Resource Description (Color)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID integer Required on Update

ID of the given color.
SiteID globally unique identifier Required

ID of the site for the given color.
Rank integer Required

Rank of the given color.
Name string Required

Name of the given color. (Max length 50 characters)
Code string Required

Hex Value of the given color.

Response Formats

application/xml, text/xml

Sample
<Color xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>1</ID>
  <SiteID>167fc44b-618b-4ebe-8611-dbec9005c300</SiteID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Code>sample string 2</Code>
</Color>

application/json, text/json

Sample
{
  "ID": 1,
  "SiteID": "167fc44b-618b-4ebe-8611-dbec9005c300",
  "Rank": 1,
  "Name": "sample string 1",
  "Code": "sample string 2"
}