Versions Compared

Key

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

...

...

General Information

...

ServiceAPIMethodData ModelWorkflowGroup
multitenant/product/packagesGET

Data Model: 

...

ProductsN/AProduct

Description

List product packages

Input

...

Type: application/json


Name
Source
Mandatory
Type
Special Format
Description
idQueryYESStringN/AThe product id


Output

...

Response

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

Valid Response

{
Code Block
Code Block
languagejs
titleError Response Sample
languagejs
titleValid Response Sample
{

}

Invalid Response

linenumberstrue
collapsetrue
{
  "result": true,
  "data": [
    {
      "code": "TPROD_BASIC",
      "name": "basic package",
      "resultdescription":false, "this is a description for test product basic package",
      "errors"acl": {
        "dashboard": {
          "codesoauth":[460], [
            {
              "version": "1",
              "detailsget": [
                "Guest"
            {  ],
              "code":460post": [
                "Guest",
                "message":"Unable to find products""Tokenization"
              ],
              "delete": [
                "Tokenization"
              ]
            }
          ]
        }
      },
      "_TTL": 86400000
 }

...

Code

...

Description

...

460

...

Unable to find products

...

473

...

Missing required fields
Example (CURL)

Request

Code Block
languagebash
titleCalling List Products API
 > CURL -X GET http://127.0.0.1:4004/product/packages?id=%product_id%
   },
    {
      "code": "TPROD_EXAMPLE03",
      "name": "example03 package",
      "description": "this is a description for test product example03 package",
      "acl": {
        "dashboard": {
          "urac": [
            {
              "version": "2",
              "post": [
                "Guest Password Settings"
              ],
              "get": [
                "Guest Password Settings",
                "Guest Email Validation"
              ]
            }
          ]
        }
      },
      "_TTL": 86400000
    }
  ]
}

Invalid Response

Code Block
List Products API response
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result": truefalse,
    "errors":{
        "codes":[460],
        "datadetails":[
     [       {
                "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

461

Unable to find packages

602
Model error: + %model_error%