Click or drag to resize

ESDocumentCategory Class

Ecommerce standards document that contains a list of category records, and a list of category tree records
Inheritance Hierarchy
SystemObject
  EcommerceStandardsDocumentsESDocument
    EcommerceStandardsDocumentsESDocumentCategory

Namespace:  EcommerceStandardsDocuments
Assembly:  EcommerceStandardsDocuments.Library (in EcommerceStandardsDocuments.Library.dll) Version: 1.4.0.0 (1.0.0.0)

The ESDocumentCategory type exposes the following members.

Constructors
Fields
  NameDescription
Public fieldcategoryTreeRecords
List of category tree records
Public fieldconfigs
A dictionary of additional configurations and settings to include with each Ecommerce Standard Document. Typically documents would contain the "dataFields" key that would have a comma delimited list of record properties that are expected to contain data when reading the document's records. Any records not containing data for properties in list could then have the data set to a default when saved to a database.
(Inherited from ESDocument.)
Public fielddataRecords
List of category records
Public fielddataTransferMode
Denotes if the data being placed into document is a complete data set, or partial data being transferred containing only data changes.
(Inherited from ESDocument.)
Public fieldmessage
Message providing details of if the data could be obtained when requesting the document. The message gives meaning to the result status.
(Inherited from ESDocument.)
Public fieldresultStatus
Code that denotes if the data could be successfully obtained for the document, and if not why. See ESDocumentConstants Class for the list of status codes
(Inherited from ESDocument.)
Public fieldtotalDataRecords
The total number of records placed within document. For documents that contain multiple record lists, please check the relevant documentation to see how this number applies.
(Inherited from ESDocument.)
Public fieldversion
Version of the Ecommerce Standards Document. Verifying the version of the document is critical for systems transferring and manipulating the data.
(Inherited from ESDocument.)
Top
Examples
An example of the Category Ecommerce Standards document in its JSON serialised form
Copy
{
    "version": 1.4,
    "resultStatus": 1,
    "message":"The category data has been successfully obtained.",
    "dataTransferMode": "COMPLETE",
    "totalDataRecords": 3,
    "configs":{
        "dataFieldsCategoryTree":"keyCategoryTreeID,categoryTreeCode,name,description,ordering",
        "dataFields":"keyCategoryID,categoryCode,keyCategoryParentID,name,description1,description2,description3,description4,metaTitle,metaKeywords,metaDescription,ordering"
    },
    "categoryTreeRecords":
    [
        {
            "keyCategoryTreeID":"1",
            "name":"Product Catalogue",
        },
        {
            "keyCategoryTreeID":"2-BRANDS",
            "categoryTreeCode":"BRANDS",
            "name":"Product Brands",
            "description":"View all the brands of products we sell.",
            "ordering":2
        }
    ],
    "dataRecords":
     [
        {
            "keyCategoryID":"2",
            "categoryCode":"Home and Stationery"
        },
        {
            "keyCategoryID":"123",
            "categoryCode":"tables-chairs",
            "keyCategoryTreeID":"1",
            "keyCategoryParentID":"2",
            "name":"Tables and Chairs",
            "description1":"View our extensive range of tables and chairs",
            "description2":"Range includes products from the ESD designers",
            "description3":"",
            "description4":"",
            "metaTitle":"Tables and Chairs From ESD Designers",
            "metaKeywords":"tables chairs esd furniture designers",
            "metaDescription":"Tables and chairs from the ESD designers",
            "ordering": 2,
            "keyProductIDs":["TAB-1","53432","CHAIR-5"],
            "keyDownloadIDs":[],
            "keyLabourIDs":[]
        },
        {
            "keyCategoryID":"124",
            "categoryCode":"paper",
            "keyCategoryTreeID":"1",
            "keyCategoryParentID":"2",
            "name":"Paper Products",
            "description1":"View our extensive range of paper",
            "description2":"Range includes paper only sources from sustainable environments",
            "description3":"",
            "description4":"",
            "metaTitle":"Paper Products",
            "metaKeywords":"paper products environmental",
            "metaDescription":"Paper products from sustainable environments",
            "ordering": 1,
            "keyProductIDs":["PROD-001","PROD-002"],
            "keyDownloadIDs":["DOWN-1", "DOWN-2","DOWN-3"],
            "keyLabourIDs":[]
        },
        {
            "keyCategoryID":"124",
            "categoryCode":"acme-brand",
            "keyCategoryTreeID":"2-BRANDS",
            "keyCategoryParentID":null,
            "name":"Paper Products",
            "description1":"View All Acme Brand's products",
            "description2":"Range shows all products made by the Acme corporation.",
            "description3":"",
            "description4":"",
            "metaTitle":"Acme Products",
            "metaKeywords":"",
            "metaDescription":"",
            "ordering": 1,
            "keyProductIDs":["PROD-003","PROD-004"],
            "keyDownloadIDs":[],
            "keyLabourIDs":[]
        }
    ]
}
See Also