Click or drag to resize

ESDocumentCategory Class

Ecommerce standards document that contains a list of category records
Inheritance Hierarchy

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

The ESDocumentCategory type exposes the following members.

Public methodESDocumentCategory
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.)
An example of the Category Ecommerce Standards document in its JSON serialised form
    "version": 1.3,
    "resultStatus": 1,
    "message":"The category data has been successfully obtained.",
    "dataTransferMode": "COMPLETE",
    "totalDataRecords": 3,
            "categoryCode":"Home and Stationery"
            "name":"Tables and Chairs",
            "description1":"View our extensive range of tables and chairs",
            "description2":"Range includes products from the ESD designers",
            "metaTitle":"Tables and Chairs From ESD Designers",
            "metaKeywords":"tables chairs esd furniture designers",
            "metaDescription":"Tables and chairs from the ESD designers",
            "ordering": 2,
            "name":"Paper Products",
            "description1":"View our extensive range of paper",
            "description2":"Range includes paper only sources from sustainable environments",
            "metaTitle":"Paper Products",
            "metaKeywords":"paper products environmental",
            "metaDescription":"Paper products from sustainable environments",
            "ordering": 1,
            "keyDownloadIDs":["DOWN-1", "DOWN-2","DOWN-3"],
See Also