General Information
| Service | API | Method |
|---|---|---|
| multitenant | /product | GET |
Data Model: Products
Workflow:
Input
Type: application/json
Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | The product id |
| code | Body | YES | String | The Length is 4 - 5 | The product code |
Output
Valid Response
Valid Response Sample
{
"result": true,
"data": {
"_id": "5d776ce4e8c4bb0424e3bc7d",
"locked": true,
"code": "DSBRD",
"name": "Console UI Product",
"description": "This is the main Console UI Product.",
"console": true,
"scope": {
"acl": {
"dashboard": {
"urac": {
"2": {
"access": true,
"apisPermission": "restricted",
"get": [
{
"group": "Administration",
"apis": {
"/admin/all": {
"access": true
},
"/admin/listUsers": {
"access": true
},
"/admin/changeUserStatus": {
"access": true
},
"/admin/group/list": {
"access": true
}
}
},
],
"post": [
{
"group": "Administration",
"apis": {
"/admin/addUser": {
"access": true
},
"/admin/editUser": {
"access": true
},
"/admin/group/add": {
"access": true
},
"/admin/group/edit": {
"access": true
}
}
}
],
"delete": [
{
"group": "Administration",
"apis": {
"/admin/group/delete": {
"access": true
}
}
}
]
}
},
"multitenant": {
"1": {
"access": false,
"get": [
{
"group": "Product"
},
{
"group": "Tenant"
}
],
"post": [
{
"group": "Product"
},
{
"group": "Tenant"
}
],
"put": [
{
"group": "Product"
},
{
"group": "Tenant"
}
],
"delete": [
{
"group": "Product"
},
{
"group": "Tenant"
}
]
}
}
}
}
},
"packages": [
{
"code": "DSBRD_OWNER",
"name": "Owner",
"description": "This package is used to provide owner level access. This means the user who has this package will have access to everything.",
"locked": true,
"acl": {
"dashboard":
"urac": [
{
"version": "2",
"get": [
"Administration",
],
"post": [
"Administration",
],
"delete": [
"Administration"
]
}
],
"multitenant": [
{
"version": "1",
"get": [
"Product",
"Tenant"
],
"post": [
"Product",
"Tenant"
],
"delete": [
"Product",
"Tenant"
],
"put": [
"Product",
"Tenant"
]
}
]
}
},
"_TTL": 604800000
},
"_TTL": 21600000
}
]
}
}
Invalid Response
Error Response Sample
{
"result":false,
"errors":{
"codes":[460],
"details":[
{
"code":460,
"message":"Unable to find products"
}
]
}
}
Error Codes
Code | Description |
|---|---|
460 | Unable to find products |
474 | Missing required field: either id or code |
602 | Model error: + %model_error% |
Example (CURL)
Request
Calling List Products API
> CURL -X GET http://127.0.0.1:4004/product?id=%product_id%
Response
List Products API response
{
"result": true,
"data": [
{
}
]
}
0 Comments