Versions Compared

Key

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

General Information

...

ServiceAPIMethodData ModelWorkflow
multitenant/product/packageGET

...

...

N/A

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
codeproductCodeQueryYESStringmax length is 6The product code
packageCodeQueryYESStringN/AThe package code


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
linenumberstrue
collapsetrue
{
  "result": true,
  "data":
    {
      "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 Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[460],
        "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
Unable to find products
461

Unable to find package

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

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:4004/product/package?code=%product_code%&packageCode=%package_code%

Response

...

languagejs
titleList Products API response

...