POST colors

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

Name	Description
ID `integer` Required on Update ID of the given color.	`integer` Required on Update ID of the given color.
SiteID `globally unique identifier` Required ID of the site for the given color.	`globally unique identifier` Required ID of the site for the given color.
Rank `integer` Required Rank of the given color.	`integer` Required Rank of the given color.
Name `string` Required Name of the given color. (Max length 50 characters)	`string` Required Name of the given color. (Max length 50 characters)
Code `string` Required Hex Value of the given color.	`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>d718d1ba-aae2-4b81-bf7c-378ad08ee031</SiteID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Code>sample string 2</Code>
</Color>

application/json, text/json

Sample

{
  "ID": 1,
  "SiteID": "d718d1ba-aae2-4b81-bf7c-378ad08ee031",
  "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

Name	Description
ID `integer` Required on Update ID of the given color.	`integer` Required on Update ID of the given color.
SiteID `globally unique identifier` Required ID of the site for the given color.	`globally unique identifier` Required ID of the site for the given color.
Rank `integer` Required Rank of the given color.	`integer` Required Rank of the given color.
Name `string` Required Name of the given color. (Max length 50 characters)	`string` Required Name of the given color. (Max length 50 characters)
Code `string` Required Hex Value of the given color.	`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>dd59b759-bd43-49af-a732-986bbbebd66f</SiteID>
  <Rank>1</Rank>
  <Name>sample string 1</Name>
  <Code>sample string 2</Code>
</Color>

application/json, text/json

Sample

{
  "ID": 1,
  "SiteID": "dd59b759-bd43-49af-a732-986bbbebd66f",
  "Rank": 1,
  "Name": "sample string 1",
  "Code": "sample string 2"
}