Versions Compared

Key

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

General Information

...

NameSourceMandatoryTypeSpecial FormatDescription
codeBodyYESStringThe length is between 4 - 5Product code
nameBodyYESStringN/AProduct name
descriptionBodyNOStringN/A

Product description

scopeBodyNOObject
Product Scope

Output

...

Response

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

Valid Response

Code Block
languagejs
titleValid Response Sample
{
    "result": true,
    "data": [
        {
            "name": "Fadi2",
            "code": "FADI2",
            "description": "Some Description",
            "scope": {
                "acl": {
					"dashboard": {
						"multitenant": {
                                "1": {
                                    "access": false,
                                    "get": [
                                        {
                                            "/product": {
                                                "access": false
                                            },
                                            "group": 'Product'
                                        }
                                    ]
                                },
                                "2.1" : {
                                    "access": false,
                                    "get": [
                                        {
                                            "/product": {
                                                "access": false
                                            },
                                            "group": 'Product'
                                        }
                                    ]
                                }
                            }
					}
				}
            },
            "packages": [],
            "_id": "5d6fedabbed68d11b6f54636"
        }
    ]
}

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[468],
        "details":[
            {
                "code":468,
                "message":"Product already exists"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

468

Product already exists

602
Model error: + %model_error%
Example (CURL)

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X POST http://127.0.0.1:4000/multitenant/product -d {
    "code": "silver",
    "name": "Silver",
    "description": "product description"
}

Response

...

languagejs
titleList Products API response

...