Page Comparison

General Information

...

Service	API	Method	Data Model	Workflow	Group
multitenant	/product	GET	Products	N/A	Product

Description

This API gets the product record that has an id or a code that matches the one sent in the query.

...

Get product

Input

...

Code Block
Type: application/json

Name	Source	Mandatory	Type	Special Format	Description
id	Query	NO	String	N/A	The product id
code	Query	NO	String	The Length is 4 - 5	The product code

Output

...

Response

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

Valid Response

jstruetrue

Code Block

language

Expand

linenumbers

title	Valid Response Sample

Code Block

language

collapse

js

{
    "code" : "TPROD",
    "name" : "Test Product",
    "description" : "this is a description for test product",
    "console": false,
    "scope": {
        "acl": {
           "dashboard": {
               "multitenant": {
                   "1": {
                       "access": false,
                       "get": [
                           {
                               "apis": {
                                   "/product": {
                                       "access": false
                                   }
                               },
                               "group": "Product"
                           }
                       ]
                   },
                   "1x2": {
                       "access": true,
                       "get": [
                           {
                               "apis": {
                                   "/tenant": {
                                       "access": false
                                   }
                               },
                               "group": "Tenant"
                           }
                       ],
                       "post": [
                           {
                               "apis": {
                                   "/tenant": {
                                       "access": true
                                   }
                               },
                               "group": "Tenant"
                           }
                       ]
                   }
               },
               "urac": {
                   "1": {
                       "access": true,
                       "apisPermission": "restricted",
                       "get": [
                           {
                               "apis": {
                                   "/user": {
                                       "access": false
                                   }
                               },
                               "group": "Administrator"
                           }
                       ]
                   },
                   "2x5": {
                       "access": true,
                       "apisPermission": "restricted",
                       "post": [
                           {
                               "apis": {
                                   "/account/changeEmail": {
                                       "access": true
                                   },
                                   "/account/changePassword": {
                                       "access": true
                                   },
                                   "/account/editProfile": {
                                       "access": true
                                   }
                               },
                               "group": "My Account"
                           }
                       ],
                       "get": [
                           {
                               "apis": {
                                   "/account/getUser": {
                                       "access": true
                                   }
                               },
                               "group": "My Account"
                           }
                       ]
                   }
               }
           }
        }
    },
    "packages" : [
        {
            "code" : "TPROD_BASIC",
            "name" : "basic package",
            "description" : "this is a description for test product basic package",
            "acl" : {
                "dashboard": {
                    "multitenant": [
                        {
                            "version": "1",
                            "get": [
                                "Product"
                            ]
                        },
                        {
                            "version": "1.2",
                            "get": [
                                "Tenant"
                            ]
                        }
                    ],
                    "urac": [
                        {
                            "version": "1",
                            "get": [
                                "Administrator",
                            ]
                        },
                        {
                            "version": "3",
                            "get": [
                                "Administrator",
                                "My Account",
                            ]
                        }
                    ]
                }
            },
            "_TTL" : 86400000 // 24 hours
        },
        {
            "code" : "TPROD_EXAMPLE03",
            "name" : "example03 package",
            "description" : "this is a description for test product example03 package",
            "acl" : {
                "dashboard": {
                    "urac": [
                        {
                            "version": "2.5",
                            "get": [
                                "My Account",
                            ],
                            "put": [
                                "My Account",
                            ],
                            "delete": [
                                "My Account",
                            ],
                            "post": [
                                "My Account",
                            ]
                        }
                    ]
                }
            },
            "_TTL" : 86400000 // 24 hours
        }
    ]
}

Invalid Response