Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
titleValid Response Sample
 {
  "result": true,
  "data": [
    {
      "_id": "5512867be603d7e01ab1688d5d7764841e2c4b034b43ceea",
      "locked": true,
      "code": "DSBRD",
      "name": "Console UI Product",
      "description": "This is the main Console UI Product.",
      "console": true,
      "scope": {
          "acl": {
   
          "dashboard": {
     
            "urac": {
              "2": {
      "2": {         "access": true,
                "accessapisPermission": true"restricted",
                "get": [
         "apisPermission": "restricted",        {
                    "getgroup": ["Administration",
                    "apis": {
           {           "/admin/all": {
                        "groupaccess": "Administration",true
                      },
           "apis": {          "/admin/listUsers": {
                        "access": true
 "/admin/all": {                    },
                      "access/admin/changeUserStatus": true{
                        "access": true
                      },
                      "/admin/group/list": {
           }             "access": true
                },      }
                    ],}
                  }
       "post": [        ],
                "post": [
    {              {
                    "group": "My Account",
                    "apis": {
             "apis": {        "/account/changeEmail": {
                             "/account/changeEmail": {"access": true
                      },
                      "access/account/changePassword": true{
                        "access": true
            }          },
                      "/account/editProfile": {
}                        "access": true
     },                 }
                    }
                  }
],                ],
                "delete": [
                  {
           {         "group": "Administration",
                    "apis": {
   "group": "Administration",                  "/admin/group/delete": {
               "apis": {        "access": true
                      }
      "/admin/group/delete": {             }
                  }
          "access": true     ]
              }
            },
     },       "multitenant": {
              "1": {
                "/admin/user/deleteaccess": {false,
                "get": [
                  {
     "access": true              "group": "Product"
                  },
    }              {
                    }
"group": "Tenant"
                  }
          }      ],
                "post": [
  ],                {
          "put": [         "group": "Product"
                  },
    {              {
                    "group": "AdministrationTenant",
                  }
               "apis": { ],
                "put": [
                  {
 "/admin/changeUserStatus": {                  "group": "Product"
                  },
    "access": true             {
                    "group": "Tenant"
   },               }
                ],
  }              "delete": [
                 } {
                    "group": "Product"
   ]               },
       }           {
       }             "group": "Tenant"
}           }       },
       "packages": [        ]
{           "code": "DSBRD_GUEST",  }
        "name": "Guest",    }
        "locked": true, }
        }
"description": "This package is used to provide},
anyone access to login and forgot password. Once logged in the package linked to the user tenant will take over thus providing the right access to the logged in user.", "packages": [
        {
          "code": "DSBRD_GUEST",
          "name": "Guest",
          "locked": true,
          "description": "This package is used to provide anyone access to login and forgot password. Once logged in the package linked to the user tenant will take over thus providing the right access to the logged in user.",
          "acl": {
            "dashboard": {
              "urac": [
                {
                  "version": "2",
                  "post": [
                    "Guest Password Settings"
                  ],
                  "get": [
                    "Guest Password Settings",
                    "Guest Email Validation"
                  ]
                }
              ],
              "multitenant": [
                {
                  "version": "1",
                  "get": [
                    "Product",
                    "Tenant"
                  ],
                  "post": [
                    "Product",
                    "Tenant"
                  ],
                  "delete": [
                    "Product",
                    "Tenant"
                  ],
                  "put": [
                    "Product",
                    "Tenant"
                  ]
                }
              ]
            }
          },
          "_TTL": 604800000
        },
        {
          "code": "DSBRD_OWNER",
          "name": "Owner",
          "description": "This package is used to provide owner level access. This means the user who has this package will have access to everything.",
          "locked": true,
          "acl": {
            "dashboard": {
              "oauth": [
                {
                  "version": "1",
                  "get": [
                    "Guest"
                  ],
                  "post": [
                    "Guest",
                    "Tokenization"
                  ],
                  "delete": [
                    "Tokenization",
                    "User Tokenization",
                    "Cient Tokenization"
                  ]
                }
              ],
              "urac": [
                {
                  "version": "2",
                  "get": [
                    "Guest Email Account Settings",
                    "Administration",
                    "My Account",
                    "Guest Password Settings",
                    "Guest Email Validation"
                  ],
                  "post": [
                    "Administration",
                    "My Account",
                    "Guest Password Settings"
                  ],
                  "delete": [
                    "Administration"
                  ]
                }
              ],
              "dashboard": [
                {
                  "version": "1",
                  "get": [
                    "Environment",
                  ],
                  "post": [
                    "Environment",
                  ],
                  "put": [
                    "Environment",
                  ],
                  "delete": [
                    "Environment",
                  ]
                }
              ],
              "multitenant": [
                {
                  "aclversion": {"1",
                  "dashboardget": [
 {                   "urac": [Product",
                    "Tenant"
          {        ],
                  "versionpost": "2",[
                    "Product",
      "post": [             "Tenant"
                 "Guest Password],
Settings"                  "delete": [
       ],             "Product",
             "get": [      "Tenant"
                  ],
     "Guest Password Settings",           "put": [
                  "Guest Email Validation"Product",
                    "Tenant"
     ]             ]
         }       }
           ]   ]
            }
          },
          "_TTL": 604800000
        }
      ]
    }
  ]
}

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[460602],
        "details":[
            {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}



Error Codes



 CodeDescription
 460Unable to find products 602Model error: + %model_error%



Example (CURL)

...

Request

Code Block
languagebash
titleCalling List Console Products API
 > CURL -X GET http://127.0.0.1:4004/products/console

...