GET - /products

General Information


ServiceAPIMethodData ModelWorkflowGroup
multitenant/productsGETProductsN/AProduct

Description

List products

Input


Type: application/json

No input data for this API

Output


Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Valid Response Sample
{
  "result": true,
  "data": [
    {
      "_id": "5d7762264305c302f032b24b",
      "code": "TPROD",
      "name": "Test Product",
      "description": "this is a description for test product",
      "console": false,
      "packages": [
        {
          "code": "TPROD_BASIC",
          "name": "basic package",
          "description": "this is a description for test product basic package",
          "acl": {
            "dashboard": {
              "oauth": [
                {
                  "version": "1",
                  "get": [
                    "Guest"
                  ],
                  "post": [
                    "Guest",
                    "Tokenization"
                  ],
                  "delete": [
                    "Tokenization"
                  ]
                }
              ]
            }
          },
          "_TTL": 86400000
        },
        {
          "code": "TPROD_EXAMPLE03",
          "name": "example03 package",
          "description": "this is a description for test product example03 package",
          "acl": {
            "dashboard": {
              "urac": [
                {
                  "version": "2",
                  "post": [
                    "Guest Password Settings"
                  ],
                  "get": [
                    "Guest Password Settings",
                    "Guest Email Validation"
                  ]
                }
              ]
            }
          },
          "_TTL": 86400000
        }
      ]
    },
    {
      "_id": "5d7762264305c302f032b24c",
      "code": "TEST2",
      "name": "Test 2 Product",
      "description": "this is a description for test 2 product",
      "console": false,
      "packages": [
        {
          "code": "TEST2_NEWS",
          "name": "news package",
          "description": "this is a description for test 2 product news package",
          "acl": {
            "dashboard": {
              "oauth": [
                {
                  "version": "1",
                  "get": [
                    "Guest"
                  ],
                  "post": [
                    "Guest",
                    "Tokenization"
                  ],
                  "delete": [
                    "Tokenization"
                  ]
                }
              ]
            }
          },
          "_TTL": 86400000
        },
        {
          "code": "TEST2_NEW",
          "name": "new package",
          "description": "this is a description for test 2 product new package",
          "acl": {
            "dashboard": {
              "urac": [
                {
                  "version": "2",
                  "post": [
                    "Guest Password Settings"
                  ],
                  "get": [
                    "Guest Password Settings",
                    "Guest Email Validation"
                  ]
                }
              ]
            }
          },
          "_TTL": 86400000
        }
      ]
    }
  ]
}

Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


Code
Description
602
Model error: + %model_error%