CatalogRoleDTO Object

Overview

The REST API makes extensive use of the CatalogRoleDTO object whenever working with a single catalog role.  This article will help you to know the various members of this object.

Requirements

The following pre-requisites will be necessary to accomplish the goals of this article:

  • General understanding of REST and API’s
  • Understanding of C# and/or JavaScript

Getting Started

There are no tasks needed to get started with understanding this object. 

CatalogRoleDTO

The CatalogRoleDTO object will contain all of the details of a single catalog role for your Hotcakes Commerce store.

Members

The following table gives you details on the various members of the CatalogRoleDTO object.  The descriptions are based upon default functionality and the default Viewset included with Hotcakes.

Member Default Description
CatalogRoleId Null Long The unique ID or primary key of the catalog role.
ReferenceId Null Guid The unique ID or primary key of one of following entities: product, category, product type.
RoleName (empty string) The name of the security role as it appears in the CMS.
RoleType 0 This property specifies what object will be linked with catalog role. The possible values are:
  • ProductRole = 0
  • CategoryRole = 1
  • ProductTypeRole = 2

 

Example of CatalogRoleDTO

{
   "Errors":[

   ],
   "Content":{
      "CatalogRoleId":5,
      "RoleName":"Registered Users",
      "ReferenceId":"5d520070-17e5-4587-bddb-9935bc584b6c",
      "RoleType":0
   }
}
Have more questions? Submit a request

Need More Help?

Do you need more assistance with this article? Please review your support options.