POST api/colorapi/add?siteId={siteId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		globally unique identifier	None.

Body Parameters

ColorViewModel

Name	Type	Additional information
descriptions	Dictionary of string [key] and string [value]	None.
active	boolean	Required
code	string	Required String length: inclusive between 0 and 30
customer_id	globally unique identifier	Required
hexadecimal_code	string	Required String length: inclusive between 0 and 6
id	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "descriptions": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "active": true,
  "code": "sample string 2",
  "customer_id": "3323c13f-eb8b-4d68-8c7d-ec73cfb1a851",
  "hexadecimal_code": "sample string 4",
  "id": "a341621e-e08b-4ed8-9760-d147fb10a788"
}

application/xml, text/xml

Sample:

<color xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EntityModel">
  <active>true</active>
  <code>sample string 2</code>
  <customer_id>3323c13f-eb8b-4d68-8c7d-ec73cfb1a851</customer_id>
  <hexadecimal_code>sample string 4</hexadecimal_code>
  <id>a341621e-e08b-4ed8-9760-d147fb10a788</id>
  <descriptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </descriptions>
</color>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

globally unique identifier

Response Formats

application/json, text/json

Sample:

"983f2c83-ca19-4b3f-a858-6e7c333393c5"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">983f2c83-ca19-4b3f-a858-6e7c333393c5</guid>