Request Information

URI Parameters

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

None.

Body Parameters (Color)

This object takes all the parameters needed to create a new 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.

Request 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>6d0c95f7-5b4b-4c66-8fde-78b3f243d7f3</SiteID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Code>sample string 2</Code>
</Color>

application/json, text/json

Sample
{
  "ID": 1,
  "SiteID": "6d0c95f7-5b4b-4c66-8fde-78b3f243d7f3",
  "Rank": 1,
  "Name": "sample string 1",
  "Code": "sample string 2"
}

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>5cac054a-a0b0-43f7-9027-7147d14707b5</SiteID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Code>sample string 2</Code>
</Color>

application/json, text/json

Sample
{
  "ID": 1,
  "SiteID": "5cac054a-a0b0-43f7-9027-7147d14707b5",
  "Rank": 1,
  "Name": "sample string 1",
  "Code": "sample string 2"
}