| GET | /CategoryColours/{BrandName}/{DeviceName}/Category/{FriendlyCategoryName} | ||
|---|---|---|---|
| GET | /CategoryColours/{BrandName}/{DeviceName}/Range/{FriendlyRangeName}/Category/{FriendlyCategoryName} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BrandName | path | string | No | |
| FriendlyRangeName | path | string | No | |
| FriendlyCategoryName | path | string | No | |
| DeviceName | path | Device | No | |
| Skip | query | int? | No | |
| Take | query | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Name | form | string | No | |
| NameStripped | form | string | No | |
| RangeName | form | string | No | |
| RangeNameStripped | form | string | No | |
| CategoryColours | form | IList<CategoryColour> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CategoryNameStripped | form | string | No | |
| RangeNameStripped | form | string | No | |
| PositionX | form | string | No | |
| PositionY | form | string | No | |
| MasterColour | form | CategoryMasterColour | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CategoryNameStripped | form | string | No | |
| RangeNameStripped | form | string | No | |
| Colours | form | IList<Colour> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Code | form | string | No | |
| Name | form | string | No | |
| NameStripped | form | string | No | |
| SpecifierNumber | form | string | No | |
| ChipNumber | form | string | No | |
| ChipPosition | form | string | No | |
| ChipBarcode | form | string | No | |
| ValidFrom | form | DateTime? | No | |
| ValidTo | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Red | form | int? | No | |
| Green | form | int? | No | |
| Blue | form | int? | No | |
| LRV | form | int? | No | |
| Mask | form | Mask | No | |
| BaseId | form | string | No | |
| Name | form | string | No | |
| WoodType | form | string | No | |
| Coats | form | string | No | |
| ColourScheme | form | ColourScheme | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | |
| Url | form | string | No | |
| ThumbnailUrl | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | |
| Type | form | string | No | |
| Description | form | string | No | |
| MasterColourId | form | string | No | |
| ColourSchemeMasterColours | form | List<ColourSchemeMasterColour> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Colours | form | List<Colour> | No | |
| RelatedMasterColours | form | List<RelatedMasterColours> | No | |
| LinkedColourCards | form | List<ColourCardForMasterColour> | No | |
| LinkedImages | form | List<ImageForMasterColour> | No | |
| LinkedColourSchemes | form | List<ColourScheme> | No | |
| LinkedProducts | form | List<Product> | No | |
| RangeName | form | string | No | |
| RangeNameStripped | form | string | No | |
| CategoryName | form | string | No | |
| CategoryNameStripped | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RangeName | form | string | No | |
| RangeNameStripped | form | string | No | |
| CategoryName | form | string | No | |
| CategoryNameStripped | form | string | No | |
| PositionX | form | int | No | |
| PositionY | form | int | No | |
| Colours | form | List<Colour> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int? | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| Url | form | string | No | |
| Orientation | form | string | No | |
| Locations | form | string | No | |
| Source | form | string | No | |
| Width | form | int? | No | |
| Height | form | int? | No | |
| Size | form | int? | No | |
| Copyright | form | string | No | |
| Tags | form | string | No | |
| TagsArray | form | string[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | |
| NameStripped | form | string | No | |
| Description | form | string | No | |
| ProductType | form | string | No | |
| RangeName | form | string | No | |
| RangeNameStripped | form | string | No | |
| IndexOrder | form | int? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /csv/reply/CategoryColours HTTP/1.1
Host: digital-prod-umbracosharedapi-appservice.azurewebsites.net
Content-Type: text/csv
Content-Length: length
{"brandName":"String","friendlyRangeName":"String","friendlyCategoryName":"String","deviceName":0,"skip":0,"take":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"name":"String","nameStripped":"String","rangeName":"String","rangeNameStripped":"String"}