GET Designer/Services/GetColors?divisionId={divisionId}&websiteId={websiteId}&webApiClientKey={webApiClientKey}

Admin user of Artifi can create colors on Artifi server to make it available for users and users can use that colors in customizing the products.

If your e-commerce website needs all the colors present for particular website that you have created in Artifi account, This method will be helpful.

This operation gives list of all colors present in Artifi server for particular website id. This operation requires the website id.

When this operation invokes, it call back the JavaScript method with data consist of details of all colors present in the requested website (ColorHexValue, ColorId, ColorName, Code etc).

Request Information

Parameters

Name	Descriptions
divisionId	Division created in Artifi server by admin user contains all product and related details. This division contains the clipart, fonts, colors, product etc. This parameter represents the division of which colors are required.
websiteId	This is the website with which products, images and colors are associated. Admin user of Artifi can create one or more websites and assign products to each of the website. The Id of the website with which the product which user is customizing should be specified in this parameter is associated.
webApiClientKey	When any company gets registered with Artifi, Artifi will generate a special and unique key for that company which will be called as client key. This client key will be found in registered company's profile tab in Artifi Account. This client key will be used for client(company) authentication and will be called as WebApiClientKey.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "Response": "sample string 1",
  "Message": "",
  "Data": {
    "data": [
      {
        "ColorSetMappingModelList": [
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          },
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          },
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          }
        ],
        "Name": "sample string 1",
        "DivisionId": 2,
        "CategoryId": 2,
        "ColorSetCode": "code 1",
        "Id": 2,               
        "CategoryId": 3
},
       
      {
        "ColorSetMappingModelList": [
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          },
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          },
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          }
        ],
        "Name": "sample string 1",
        "DivisionId": 2,         
        "CategoryId": 3, 
        "ColorSetCode": "code 2",       
        "Id": 5,
        "LoginUserId": 1
      },
      {
        "ColorSetMappingModelList": [
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          },
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          },
          {
            "ColorId": 1,
            "ColorSetId": 2,
            "ColorName": "sample string 3",
            "ColorSetName": "sample string 4",
            "ColorHexValue": "sample string 5",
            "ColorImageUniqueName": "sample string 6",
            "StatusId": 1,
            "Code": "sample string 7",
            "Id": 8,
            "LoginUserId": 1
          }
        ],
        "Name": "sample string 1",
        "DivisionId": 2,        
        "CategoryId": 3,
        "ColorSetCode": "code 3",        
        "Id": 5,
        "LoginUserId": 1
      }
    ],
    "Id": 1,
    "LoginUserId": 1
  }
}