POST api/colorapi/add?siteId={siteId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| siteId | globally unique identifier |
None. |
Body Parameters
ColorViewModel| Name | Description | 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": "9fcd6793-ca5b-42bd-bff2-5858f824d02b",
"hexadecimal_code": "sample string 4",
"id": "2d6c8e9a-26ee-41d5-93ad-86871c7d04c9"
}
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>9fcd6793-ca5b-42bd-bff2-5858f824d02b</customer_id>
<hexadecimal_code>sample string 4</hexadecimal_code>
<id>2d6c8e9a-26ee-41d5-93ad-86871c7d04c9</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 identifierResponse Formats
application/json, text/json
Sample:
"42bc2b55-4d9d-421c-9afa-18e30ed2e6c5"
application/xml, text/xml
Sample:
<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">42bc2b55-4d9d-421c-9afa-18e30ed2e6c5</guid>