GET yarns/libraries

Retrieves the yarn libraries available for recoloring products.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The yarn libraries.

Collection of YarnLibrary

Name	Type	Additional information
YarnLibraryId	integer	None.
Name	string	None.
Description	string	None.
Enabled	boolean	None.
Yarns	Collection of Yarn	None.
Brands	Collection of YarnLibraryBrandProperties	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "yarnLibraryId": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "enabled": true,
    "yarns": [
      {
        "yarnId": 1,
        "yarnTypeId": 2,
        "yarnType": "sample string 3",
        "code": "sample string 4",
        "name": "sample string 5",
        "constructions": [
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          },
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          }
        ],
        "properties": {
          "isMetallic": true
        }
      },
      {
        "yarnId": 1,
        "yarnTypeId": 2,
        "yarnType": "sample string 3",
        "code": "sample string 4",
        "name": "sample string 5",
        "constructions": [
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          },
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          }
        ],
        "properties": {
          "isMetallic": true
        }
      }
    ],
    "brands": [
      {
        "brandId": 1,
        "sortOrder": 2,
        "enabled": true
      },
      {
        "brandId": 1,
        "sortOrder": 2,
        "enabled": true
      }
    ]
  },
  {
    "yarnLibraryId": 1,
    "name": "sample string 2",
    "description": "sample string 3",
    "enabled": true,
    "yarns": [
      {
        "yarnId": 1,
        "yarnTypeId": 2,
        "yarnType": "sample string 3",
        "code": "sample string 4",
        "name": "sample string 5",
        "constructions": [
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          },
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          }
        ],
        "properties": {
          "isMetallic": true
        }
      },
      {
        "yarnId": 1,
        "yarnTypeId": 2,
        "yarnType": "sample string 3",
        "code": "sample string 4",
        "name": "sample string 5",
        "constructions": [
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          },
          {
            "yarnConstructionId": 1,
            "parentYarnId": 2
          }
        ],
        "properties": {
          "isMetallic": true
        }
      }
    ],
    "brands": [
      {
        "brandId": 1,
        "sortOrder": 2,
        "enabled": true
      },
      {
        "brandId": 1,
        "sortOrder": 2,
        "enabled": true
      }
    ]
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

text/html

Sample:

Sample not available.