Versions Compared

Key

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

...

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

Valid Response

Expand
titleSAMPLE
Code Block
languagejson
{
  "result": true,
  "data": {
    "limit": 10,
    "start": 0,
    "size": 1,
    "records": [
      {
        "_id": "5e409c94c5a59210a815262c",
        "name": "pay",
        "configuration": {
          "subType": "ecommerce",
          "port": 4102,
          "group": "Marketplace",
          "requestTimeout": 30,
          "requestTimeoutRenewal": 5,
          "maintenance": {
            "port": {
              "type": "maintenance"
            },
            "readiness": "/heartbeat"
          }
        },
        "description": "MS pay service for marketplace",
        "metadata": {
          "tags": [
            "order",
            "ecommerce"
          ],
          "program": [
            "marketplace"
          ]
        },
        "settings": {
          "acl": {
            "public": {
              "ro": true
            }
          },
          "recipes": [],
          "environments": {}
        },
        "src": {
          "provider": "github",
          "owner": "ht",
          "repo": "mkpl.order"
        },
        "type": "service",
        "ui": {
          "main": "Gateway",
          "sub": ""
        },
        "versions": [
          {
            "version": "1",
            "extKeyRequired": true,
            "oauth": true,
            "provision_ACL": false,
            "tenant_Profile": false,
            "urac": false,
            "urac_ACL": false,
            "urac_Config": false,
            "urac_GroupConfig": false,
            "urac_Profile": false,
            "apis": [
              {
                "l": "pay items",
                "v": "/pay",
                "m": "post",
                "group": "Pay"
              },
              {
                "l": "Get all pay ",
                "v": "/pays",
                "m": "get",
                "group": "Pay"
              }
            ],
            "documentation": {}
          }
        ]
      }
    ],
    "count": 1
  }
}

Invalid Response

Expand
titleSAMPLE
Code Block
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

...