Versions Compared

Version Old Version 2 New Version Current
Changes made by

Fadi Nasr (Unlicensed)

Ragheb Bou Dargham (Unlicensed)

Saved on

Key

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

...

...

General Information

...

Service

API

Method

Data Model

Workflow

Group

multitenant

/product

GET

Data Model: 

Products

N/A

Product

Description

Get product

Input

...

Code Block
Type: application/json


Name

Source

Mandatory

Type

Special Format

Description

id

Query

YES

NO

String

N/A

the

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

Expand
titleValid Response Sample
Code Block
languagejs
{
"result": true, "data": [{ _id: "5c9e2466ab9d56e06a390b81", code: "TESTP", name: "test product", description: null, scope: { acl: { manual: { endpointservice: { "1": { access: false } } } } }, packages: [ { code: "TESTP_TESTP", name: "test package", description: null, acl: { manual: { endpointservice: [ { version: "1" } ] } }, _TTL: 604800000 } ] }] }

Invalid Response

Code Block
languagejs
titleError Response Sample
{ "result":false, "errors":{

    "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",
                            "
codes
get":
[460],
 [
                                "My Account",
                            ],
                            "
details
put": [
                                "My Account",
                            ],
{
                   "
code":460,
delete": [
                                "My Account",
                            ],
                            "
message":"Unable to find products"
post": [
                                "My Account",
                            ]
                        }
                    ]
                }
}

...

Code

...

Description

...

460

...

474

...

Missing required field: either id or code

...

426

...

Invalid Product ID provided

Example (CURL)

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:4004/product?id=%product_id%

...

  },
            "_TTL" : 86400000 // 24 hours
        }
    ]
}

Invalid Response

List Products API response
Expand
titleError Response Sample
Code Block
languagejs
title
{
    "result":false,
    "errors":
true,
{
        "codes":[460],
        "
data
details":[
[
       {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes

...

Code

Description

400

Business logic required data are missing

460

Unable to find products

602

Model error: + %model_error%