Apache OFBiz · JSON Structure

Apache Ofbiz Service Response Structure

Standard API response from an OFBiz service invocation.

Type: object Properties: 4
ERPCRME-CommerceBusiness ApplicationsApacheJavaOpen SourceSupply Chain

ServiceResponse is a JSON Structure definition published by Apache OFBiz, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

statusCode statusDescription successMessage data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-ofbiz/refs/heads/main/json-structure/apache-ofbiz-service-response-structure.json",
  "name": "ServiceResponse",
  "description": "Standard API response from an OFBiz service invocation.",
  "type": "object",
  "properties": {
    "statusCode": {
      "type": "int32",
      "description": "HTTP status code.",
      "example": 200
    },
    "statusDescription": {
      "type": "string",
      "description": "Human-readable status description.",
      "example": "OK"
    },
    "successMessage": {
      "type": "string",
      "description": "Success message if applicable.",
      "example": "OK"
    },
    "data": {
      "type": "object",
      "additionalProperties": true,
      "description": "Service output data. Structure varies by service."
    }
  }
}