Sustema

ENTITY developer reference

ICServiceRemedyGrantStatus

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Safe projection of the same service-remedy entitlement, not another grant. The original acquisition/product scope still limits use. Pending grants have no actual usability window; active validity starts only at proved usable restoration. Where the approved permanent-loss/service-expiry policy applies, valid_until is 90 days after that start. Other remedies use their qualified accepted policy. Times and eligibility need semantic checks against that exact policy; a status word alone proves nothing. valid_from is the proved first-usable instant, never a creation, approval or planned future time. A grant that ends before any proved usability is not projected as held/expired/revoked with fabricated validity. Its original claim stays nonterminal under the original clock until an existing supported decline or alternative disposition resolves it; pending never means spendable.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

status

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for status
{
  "enum": [
    "pending_policy",
    "pending_funding",
    "active",
    "held",
    "expired",
    "revoked"
  ]
}

valid_from

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for valid_from
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

valid_until

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for valid_until
{
  "anyOf": [
    {
      "type": "string",
      "format": "date-time",
      "x-profile-maxLength": "string_characters_max"
    },
    {
      "type": "null"
    }
  ]
}

scope_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for scope_revision
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

available_units

Listed in this schema’s required array.

Declared type
"string"
Reading definition for available_units
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

reserved_units

Listed in this schema’s required array.

Declared type
"string"
Reading definition for reserved_units
{
  "type": "string",
  "pattern": "^(0|[1-9][0-9]*)$",
  "maxLength": 30,
  "x-profile-maxLength": "string_characters_max"
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "status": {
      "enum": [
        "pending_policy",
        "pending_funding",
        "active",
        "held",
        "expired",
        "revoked"
      ]
    },
    "valid_from": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "valid_until": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time",
          "x-profile-maxLength": "string_characters_max"
        },
        {
          "type": "null"
        }
      ]
    },
    "scope_revision": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "available_units": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    },
    "reserved_units": {
      "type": "string",
      "pattern": "^(0|[1-9][0-9]*)$",
      "maxLength": 30,
      "x-profile-maxLength": "string_characters_max"
    }
  },
  "required": [
    "status",
    "valid_from",
    "valid_until",
    "scope_revision",
    "available_units",
    "reserved_units"
  ],
  "description": "Safe projection of the same service-remedy entitlement, not another grant. The original acquisition/product scope still limits use. Pending grants have no actual usability window; active validity starts only at proved usable restoration. Where the approved permanent-loss/service-expiry policy applies, valid_until is 90 days after that start. Other remedies use their qualified accepted policy. Times and eligibility need semantic checks against that exact policy; a status word alone proves nothing. valid_from is the proved first-usable instant, never a creation, approval or planned future time. A grant that ends before any proved usability is not projected as held/expired/revoked with fabricated validity. Its original claim stays nonterminal under the original clock until an existing supported decline or alternative disposition resolves it; pending never means spendable.",
  "allOf": [
    {
      "if": {
        "properties": {
          "status": {
            "enum": [
              "pending_policy",
              "pending_funding"
            ]
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "valid_from": {
            "type": "null"
          },
          "valid_until": {
            "type": "null"
          },
          "available_units": {
            "const": "0"
          },
          "reserved_units": {
            "const": "0"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "status": {
            "enum": [
              "active",
              "held",
              "expired",
              "revoked"
            ]
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "valid_from": {
            "type": "string",
            "format": "date-time",
            "x-profile-maxLength": "string_characters_max"
          },
          "valid_until": {
            "type": "string",
            "format": "date-time",
            "x-profile-maxLength": "string_characters_max"
          }
        }
      }
    },
    {
      "if": {
        "properties": {
          "status": {
            "enum": [
              "held",
              "expired",
              "revoked"
            ]
          }
        },
        "required": [
          "status"
        ]
      },
      "then": {
        "properties": {
          "available_units": {
            "const": "0"
          }
        }
      }
    }
  ]
}

All API operations