GET 3dCartWebAPI/v1/Categories/{categoryid}/Options
Get the options from a specific Category
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| categoryid |
Catalog ID |
integer |
Default value is 0 |
| limit |
Maximum number of items that can be returned |
integer |
Default value is 0 |
| offset |
Starting point for the return data |
integer |
Default value is 0 |
Body Parameters
None.
Sample Request |
|
Response Information
Resource Description
Collection of OptionSet| Name | Description | Type | Additional information |
|---|---|---|---|
| OptionSetID |
Primary key, auto-incremented. database reference = prodfeatures.id |
integer |
None. |
| OptionSetName |
database reference = prodfeatures.featurecaption |
string |
String length: inclusive between 0 and 255 |
| OptionSorting |
database reference = prodfeatures.sorting |
decimal number |
None. |
| OptionRequired |
database reference = prodfeatures.featurerequired |
boolean |
None. |
| OptionType |
database reference = prodfeatures.featuretype |
string |
String length: inclusive between 0 and 10 |
| OptionURL |
database reference = prodfeatures.url |
string |
String length: inclusive between 0 and 65535 |
| OptionAdditionalInformation |
database reference = prodfeatures.info |
string |
String length: inclusive between 0 and 65535 |
| OptionSizeLimit |
database reference = prodfeatures.textlimit |
integer |
None. |
| OptionList | Collection of Options |
None. |
Response Formats
application/json, text/json
[
{
"OptionSetID": 1,
"OptionSetName": "sample string 1",
"OptionSorting": 1.1,
"OptionRequired": true,
"OptionType": "sample string 2",
"OptionURL": "sample string 3",
"OptionAdditionalInformation": "sample string 4",
"OptionSizeLimit": 1,
"OptionList": [
{
"OptionID": 1,
"OptionName": "sample string 1",
"OptionSelected": true,
"OptionHide": true,
"OptionValue": 1.1,
"OptionPartNumber": "sample string 2",
"OptionSorting": 1.1,
"OptionImagePath": "sample string 3",
"OptionBundleCatalogId": 1,
"OptionBundleQuantity": 1
},
{
"OptionID": 1,
"OptionName": "sample string 1",
"OptionSelected": true,
"OptionHide": true,
"OptionValue": 1.1,
"OptionPartNumber": "sample string 2",
"OptionSorting": 1.1,
"OptionImagePath": "sample string 3",
"OptionBundleCatalogId": 1,
"OptionBundleQuantity": 1
}
]
},
{
"OptionSetID": 1,
"OptionSetName": "sample string 1",
"OptionSorting": 1.1,
"OptionRequired": true,
"OptionType": "sample string 2",
"OptionURL": "sample string 3",
"OptionAdditionalInformation": "sample string 4",
"OptionSizeLimit": 1,
"OptionList": [
{
"OptionID": 1,
"OptionName": "sample string 1",
"OptionSelected": true,
"OptionHide": true,
"OptionValue": 1.1,
"OptionPartNumber": "sample string 2",
"OptionSorting": 1.1,
"OptionImagePath": "sample string 3",
"OptionBundleCatalogId": 1,
"OptionBundleQuantity": 1
},
{
"OptionID": 1,
"OptionName": "sample string 1",
"OptionSelected": true,
"OptionHide": true,
"OptionValue": 1.1,
"OptionPartNumber": "sample string 2",
"OptionSorting": 1.1,
"OptionImagePath": "sample string 3",
"OptionBundleCatalogId": 1,
"OptionBundleQuantity": 1
}
]
}
]
application/xml, text/xml
<ArrayOfOptionSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<OptionSet>
<OptionSetID>1</OptionSetID>
<OptionSetName>sample string 1</OptionSetName>
<OptionSorting>1.1</OptionSorting>
<OptionRequired>true</OptionRequired>
<OptionType>sample string 2</OptionType>
<OptionURL>sample string 3</OptionURL>
<OptionAdditionalInformation>sample string 4</OptionAdditionalInformation>
<OptionSizeLimit>1</OptionSizeLimit>
<OptionList>
<Options>
<OptionID>1</OptionID>
<OptionName>sample string 1</OptionName>
<OptionSelected>true</OptionSelected>
<OptionHide>true</OptionHide>
<OptionValue>1.1</OptionValue>
<OptionPartNumber>sample string 2</OptionPartNumber>
<OptionSorting>1.1</OptionSorting>
<OptionImagePath>sample string 3</OptionImagePath>
<OptionBundleCatalogId>1</OptionBundleCatalogId>
<OptionBundleQuantity>1</OptionBundleQuantity>
</Options>
<Options>
<OptionID>1</OptionID>
<OptionName>sample string 1</OptionName>
<OptionSelected>true</OptionSelected>
<OptionHide>true</OptionHide>
<OptionValue>1.1</OptionValue>
<OptionPartNumber>sample string 2</OptionPartNumber>
<OptionSorting>1.1</OptionSorting>
<OptionImagePath>sample string 3</OptionImagePath>
<OptionBundleCatalogId>1</OptionBundleCatalogId>
<OptionBundleQuantity>1</OptionBundleQuantity>
</Options>
</OptionList>
</OptionSet>
<OptionSet>
<OptionSetID>1</OptionSetID>
<OptionSetName>sample string 1</OptionSetName>
<OptionSorting>1.1</OptionSorting>
<OptionRequired>true</OptionRequired>
<OptionType>sample string 2</OptionType>
<OptionURL>sample string 3</OptionURL>
<OptionAdditionalInformation>sample string 4</OptionAdditionalInformation>
<OptionSizeLimit>1</OptionSizeLimit>
<OptionList>
<Options>
<OptionID>1</OptionID>
<OptionName>sample string 1</OptionName>
<OptionSelected>true</OptionSelected>
<OptionHide>true</OptionHide>
<OptionValue>1.1</OptionValue>
<OptionPartNumber>sample string 2</OptionPartNumber>
<OptionSorting>1.1</OptionSorting>
<OptionImagePath>sample string 3</OptionImagePath>
<OptionBundleCatalogId>1</OptionBundleCatalogId>
<OptionBundleQuantity>1</OptionBundleQuantity>
</Options>
<Options>
<OptionID>1</OptionID>
<OptionName>sample string 1</OptionName>
<OptionSelected>true</OptionSelected>
<OptionHide>true</OptionHide>
<OptionValue>1.1</OptionValue>
<OptionPartNumber>sample string 2</OptionPartNumber>
<OptionSorting>1.1</OptionSorting>
<OptionImagePath>sample string 3</OptionImagePath>
<OptionBundleCatalogId>1</OptionBundleCatalogId>
<OptionBundleQuantity>1</OptionBundleQuantity>
</Options>
</OptionList>
</OptionSet>
</ArrayOfOptionSet>