Field-level diff between two guide versions.

Guide diff

GET /v1/partners/{id}/guide/diff

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/partners/{id}/guide/diff' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "changes": [
    {
      "after": {},
      "before": {},
      "change": "string",
      "path": "string"
    }
  ],
  "from_version": 1,
  "to_version": 1
}

Path parameters

id · string · required

Partner ID

Query parameters

from · integer (int32) · required

Base version

to · integer (int32) · required

Target version

Response

GuideDiff

changes · DiffEntry[] · required

Show DiffEntry

after · object

before · object

change · string · required

added, removed, or changed.

path · string · required

Dotted path, e.g. validation.rules[0].mandatory.

from_version · integer (int32) · required

to_version · integer (int32) · required

Status codes

Code	Meaning
200	Guide diff
404	Unknown version

cURL

curl --request GET \
  --url 'https://edi.stateset.com/v1/partners/{id}/guide/diff' \
  --header "Authorization: Bearer $STATESET_EDI_API_KEY"

200

{
  "changes": [
    {
      "after": {},
      "before": {},
      "change": "string",
      "path": "string"
    }
  ],
  "from_version": 1,
  "to_version": 1
}