Versions Compared

Key

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

General Information

...

ServiceAPIMethod
multitenant/products/consoleGET


Workflow:

Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
 {
  "result": true,
  "data": [
    {
      "_id": "5512867be603d7e01ab1688d",
      "locked": true,
      "code": "DSBRD",
      "name": "Console UI Product",
      "description": "This is the main Console UI Product.",
      "scope": {
          "acl": {
              "dashboard": {
                  "urac": {
                      "2": {
                          "access": true,
                          "apisPermission": "restricted",
                          "get": [
                              {
                                  "group": "Administration",
                                  "apis": {
                                      "/admin/all": {
                                          "access": true
                                      }
                                  }
                              },
                          ],
                          "post": [
                              {
                                  "group": "My Account",
                                  "apis": {
                                      "/account/changeEmail": {
                                          "access": true
                                      }
                                  }
                              },
                              
                          ],
                          "delete": [
                              {
                                  "group": "Administration",
                                  "apis": {
                                      "/admin/group/delete": {
                                          "access": true
                                      },
                                      "/admin/user/delete": {
                                          "access": true
                                      }
                                  }
                              }
                          ],
                          "put": [
                              {
                                  "group": "Administration",
                                  "apis": {
                                      "/admin/changeUserStatus": {
                                          "access": true
                                      },
                                  }
                              }
                          ]
                      }
                  }
              }
          }
      },
      "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"
                          ]
                      }
                  ]
              }
          },
          "_TTL": 604800000
        }
      ]
    }
  ]
}


Invalid Response

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



Error Codes



Code
Description
460
Unable to find products


Example (CURL)

...

Request

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

Response

Code Block
languagejs
titleList Console Products API response
{
   "result": true,
   "data": [
      {
         
      },
      {
         
      }
   ]
}