Zum Inhalt
edoobox Docs
Kostenlos testen 7 Tage unverbindlich testen
Menü
Kostenlos testen 7 Tage unverbindlich testen
OpenAPI herunterladen
userduplicateAPI-Referenz
GET/v2/userduplicate/open

Offene Kundenduplikate zur Prüfung laden

Liest höchstens 200 offene Kandidatenpaare passend zur aktuellen Suchkonfiguration, nach Trefferwert und Aktualität sortiert. candidates enthält Kunden, Feldvergleiche und Auswirkungen; total ist die Anzahl der zurückgegebenen Paare, keine unbegrenzte Gesamtanzahl. Die Rückgabe steht direkt im Antwortobjekt.

Operation-ID get_v2_userduplicate_open

01

Vertrag & Verhalten

Dokumentationsstand
reviewed
Ändert Zustand
Nein
Als readOnly markiert
Ja
Für Automation markiert
Ja
GET-Verhalten laut Spezifikation

read

02

Authentifizierung

Eine der folgenden Alternativen muss erfüllt sein (ODER). Innerhalb jeder Alternative werden alle angegebenen Schemas gemeinsam benötigt (UND).

Alternative 1

bearerAuthhttp · bearer

Existing edoobox v2 access token. Never substitute API key/secret headers.

Format: JWT

Security-Schema als JSON
{
  "type": "http",
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "description": "Existing edoobox v2 access token. Never substitute API key/secret headers."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Alternative 2

sessionCookieapiKey

Existing browser login session, with the same permission checks as Bearer authentication.

cookie: _edlogin

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "cookie",
  "name": "_edlogin",
  "description": "Existing browser login session, with the same permission checks as Bearer authentication."
}
accountContextapiKey

Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account.

header: edid

Security-Schema als JSON
{
  "type": "apiKey",
  "in": "header",
  "name": "edid",
  "description": "Selected login/account context from the JWT, not a database primary key. Required even for a JWT with one account."
}

Berechtigungen

Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope.

03

Parameter

Header

languageoptional

Account language code, where the resource supports setLanguage().

string
Schema-Beispiel
"de"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "de"
  ]
}
04

Request Body

Kein Request Body in der Spezifikation beschrieben.

05

Antworten

9

HTTP-Status und Antwortinhalt gemeinsam auswerten. In dieser API können auch Antworten mit HTTP 200 einen Fehler enthalten.

200application/json

Die Felder stehen direkt im JSON-Antwortobjekt; kein data-Umschlag.

application/json

object
success boolean erforderlich
error boolean | string erforderlich
type string
field string
message string
config object
enabled boolean
candidate_threshold integer
auto_merge_threshold integer | null
survivor_strategy string
Erlaubte Werte
"newest""oldest"
max_merge_users integer
rules array
Array-Elemente
object
field string
enabled boolean
required boolean
weight integer

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

rules_hash string
matching_rules_hash string
version integer

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

limits object
max_merge_users integer

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

candidates array
Array-Elemente
object
id string
pattern
"^duplicate_[a-f0-9]{24}$"
score integer
required_match boolean
conflict_free boolean
auto_merge_eligible boolean
matched_fields array
Array-Elemente
object
field string
matched boolean
required boolean
weight integer

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

default_survivor string
pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"
users array
Array-Elemente
object
id string
pattern
"^user_[a-f0-9]{12}_-?[0-9]+$"
Schema-Beispiel
"user_012345abcdef_123456"
first_name string
last_name string
name string
email string
phone_number string
company string

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

fields array
Array-Elemente
object
field string
values object
Schema für zusätzliche Felder
Typ nicht eingeschränkt
has_conflict boolean

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

impact object
Schema für zusätzliche Felder
object
bookings integer
invoices integer
notes integer

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

total integer

Zusätzliche, hier nicht aufgeführte Felder sind erlaubt.

Vollständiges Schema als JSON
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "error": {
      "type": [
        "boolean",
        "string"
      ]
    },
    "type": {
      "type": "string"
    },
    "field": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "config": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "candidate_threshold": {
          "type": "integer"
        },
        "auto_merge_threshold": {
          "type": [
            "integer",
            "null"
          ]
        },
        "survivor_strategy": {
          "type": "string",
          "enum": [
            "newest",
            "oldest"
          ]
        },
        "max_merge_users": {
          "type": "integer"
        },
        "rules": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "field": {
                "type": "string"
              },
              "enabled": {
                "type": "boolean"
              },
              "required": {
                "type": "boolean"
              },
              "weight": {
                "type": "integer"
              }
            },
            "additionalProperties": true
          }
        },
        "rules_hash": {
          "type": "string"
        },
        "matching_rules_hash": {
          "type": "string"
        },
        "version": {
          "type": "integer"
        }
      },
      "additionalProperties": true
    },
    "limits": {
      "type": "object",
      "properties": {
        "max_merge_users": {
          "type": "integer"
        }
      },
      "additionalProperties": true
    },
    "candidates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^duplicate_[a-f0-9]{24}$"
          },
          "score": {
            "type": "integer"
          },
          "required_match": {
            "type": "boolean"
          },
          "conflict_free": {
            "type": "boolean"
          },
          "auto_merge_eligible": {
            "type": "boolean"
          },
          "matched_fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string"
                },
                "matched": {
                  "type": "boolean"
                },
                "required": {
                  "type": "boolean"
                },
                "weight": {
                  "type": "integer"
                }
              },
              "additionalProperties": true
            }
          },
          "default_survivor": {
            "type": "string",
            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
            "examples": [
              "user_012345abcdef_123456"
            ]
          },
          "users": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                  "examples": [
                    "user_012345abcdef_123456"
                  ]
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "phone_number": {
                  "type": "string"
                },
                "company": {
                  "type": "string"
                }
              },
              "additionalProperties": true
            }
          },
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string"
                },
                "values": {
                  "type": "object",
                  "additionalProperties": {}
                },
                "has_conflict": {
                  "type": "boolean"
                }
              },
              "additionalProperties": true
            }
          },
          "impact": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "bookings": {
                  "type": "integer"
                },
                "invoices": {
                  "type": "integer"
                },
                "notes": {
                  "type": "integer"
                }
              },
              "additionalProperties": true
            }
          }
        },
        "additionalProperties": true
      }
    },
    "total": {
      "type": "integer"
    }
  },
  "additionalProperties": true,
  "required": [
    "error",
    "success"
  ]
}
Beispiel
{
  "error": false,
  "success": true,
  "config": {
    "enabled": true,
    "candidate_threshold": 60,
    "auto_merge_threshold": null,
    "survivor_strategy": "newest",
    "max_merge_users": 10,
    "rules": [
      {
        "field": "email",
        "enabled": true,
        "required": false,
        "weight": 2
      }
    ],
    "rules_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "matching_rules_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "version": 2
  },
  "limits": {
    "max_merge_users": 10
  },
  "candidates": [],
  "total": 0
}
400application/json

Invalid request.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40006"
}
401application/json

Missing/expired token, missing account context, account paused or model-specific authorization failure.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40103"
}
402application/json

Missing/invalid action data or subscription/operation restriction.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80100"
}
403application/json

Permission denied. Browser CORS rejection may have an empty body.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED40340"
}
404application/json

Unknown resource/action or unsupported method.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80019"
}
422application/json

Validation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED80020"
}
429application/json

Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.

Response Header

Retry-After

Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.

string
Schema-Beispiel
"30"
Vollständiges Schema als JSON
{
  "type": "string",
  "examples": [
    "30"
  ]
}

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED42902"
}
502application/json

Server-side operation failed.

application/json

Typ nicht eingeschränkt

Kein Schema angegeben. Daraus lässt sich kein vollständiger Feldvertrag ableiten.

Beispiel
{
  "success": false,
  "error": "ED50201"
}
06

Quelle & Metadaten

Quelle laut Spezifikationapplication/models/v2/Userduplicate.php:12getUserduplicate()

Diese Angaben stammen unverändert aus der gelieferten OpenAPI-Datei. Zusätzliche Freigaben, Vorbedingungen, sensible Felder und Hinweise stehen in den Erweiterungen.

x-edoobox-mutates-state
false
x-edoobox-mutationReview
{
  "source": {
    "file": "application/models/v2/Userduplicatefunc.php",
    "line": 102
  },
  "reason": "Read duplicate status/configuration or already indexed candidates."
}
x-edoobox-runtimeMutationGuard
false
x-edoobox-get-effect
"read"
x-edoobox-documentationReview
{
  "file": "docs/openapi/operation-contracts/02-booking-users.json",
  "notes": []
}
x-edoobox-source
{
  "file": "application/models/v2/Userduplicate.php",
  "method": "getUserduplicate",
  "line": 12
}
x-edoobox-documentationStatus
"reviewed"
x-edoobox-readOnly
true
x-edoobox-safeForAutomation
true
x-edoobox-permission
{
  "resource": "userduplicate",
  "short": "usdu",
  "checkedByDispatcher": true,
  "levels": [
    1,
    3,
    4
  ],
  "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
}
Vollständige Operation als JSON
{
  "operationId": "get_v2_userduplicate_open",
  "summary": "Offene Kundenduplikate zur Prüfung laden",
  "description": "Liest höchstens 200 offene Kandidatenpaare passend zur aktuellen Suchkonfiguration, nach Trefferwert und Aktualität sortiert. candidates enthält Kunden, Feldvergleiche und Auswirkungen; total ist die Anzahl der zurückgegebenen Paare, keine unbegrenzte Gesamtanzahl. Die Rückgabe steht direkt im Antwortobjekt.",
  "tags": [
    "userduplicate"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Die Felder stehen direkt im JSON-Antwortobjekt; kein data-Umschlag.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "type": {
                "type": "string"
              },
              "field": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "config": {
                "type": "object",
                "properties": {
                  "enabled": {
                    "type": "boolean"
                  },
                  "candidate_threshold": {
                    "type": "integer"
                  },
                  "auto_merge_threshold": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "survivor_strategy": {
                    "type": "string",
                    "enum": [
                      "newest",
                      "oldest"
                    ]
                  },
                  "max_merge_users": {
                    "type": "integer"
                  },
                  "rules": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "field": {
                          "type": "string"
                        },
                        "enabled": {
                          "type": "boolean"
                        },
                        "required": {
                          "type": "boolean"
                        },
                        "weight": {
                          "type": "integer"
                        }
                      },
                      "additionalProperties": true
                    }
                  },
                  "rules_hash": {
                    "type": "string"
                  },
                  "matching_rules_hash": {
                    "type": "string"
                  },
                  "version": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true
              },
              "limits": {
                "type": "object",
                "properties": {
                  "max_merge_users": {
                    "type": "integer"
                  }
                },
                "additionalProperties": true
              },
              "candidates": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^duplicate_[a-f0-9]{24}$"
                    },
                    "score": {
                      "type": "integer"
                    },
                    "required_match": {
                      "type": "boolean"
                    },
                    "conflict_free": {
                      "type": "boolean"
                    },
                    "auto_merge_eligible": {
                      "type": "boolean"
                    },
                    "matched_fields": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string"
                          },
                          "matched": {
                            "type": "boolean"
                          },
                          "required": {
                            "type": "boolean"
                          },
                          "weight": {
                            "type": "integer"
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "default_survivor": {
                      "type": "string",
                      "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                      "examples": [
                        "user_012345abcdef_123456"
                      ]
                    },
                    "users": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "string",
                            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                            "examples": [
                              "user_012345abcdef_123456"
                            ]
                          },
                          "first_name": {
                            "type": "string"
                          },
                          "last_name": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "phone_number": {
                            "type": "string"
                          },
                          "company": {
                            "type": "string"
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "fields": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string"
                          },
                          "values": {
                            "type": "object",
                            "additionalProperties": {}
                          },
                          "has_conflict": {
                            "type": "boolean"
                          }
                        },
                        "additionalProperties": true
                      }
                    },
                    "impact": {
                      "type": "object",
                      "additionalProperties": {
                        "type": "object",
                        "properties": {
                          "bookings": {
                            "type": "integer"
                          },
                          "invoices": {
                            "type": "integer"
                          },
                          "notes": {
                            "type": "integer"
                          }
                        },
                        "additionalProperties": true
                      }
                    }
                  },
                  "additionalProperties": true
                }
              },
              "total": {
                "type": "integer"
              }
            },
            "additionalProperties": true,
            "required": [
              "error",
              "success"
            ]
          },
          "example": {
            "error": false,
            "success": true,
            "config": {
              "enabled": true,
              "candidate_threshold": 60,
              "auto_merge_threshold": null,
              "survivor_strategy": "newest",
              "max_merge_users": 10,
              "rules": [
                {
                  "field": "email",
                  "enabled": true,
                  "required": false,
                  "weight": 2
                }
              ],
              "rules_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "matching_rules_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
              "version": 2
            },
            "limits": {
              "max_merge_users": 10
            },
            "candidates": [],
            "total": 0
          }
        }
      }
    },
    "400": {
      "description": "Invalid request.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40006"
          }
        }
      }
    },
    "401": {
      "description": "Missing/expired token, missing account context, account paused or model-specific authorization failure.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40103"
          }
        }
      }
    },
    "402": {
      "description": "Missing/invalid action data or subscription/operation restriction.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80100"
          }
        }
      }
    },
    "403": {
      "description": "Permission denied. Browser CORS rejection may have an empty body.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED40340"
          }
        }
      }
    },
    "404": {
      "description": "Unknown resource/action or unsupported method.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80019"
          }
        }
      }
    },
    "422": {
      "description": "Validation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED80020"
          }
        }
      }
    },
    "429": {
      "description": "Request/login rate limit exceeded. Honor Retry-After when supplied; legacy rate-limit paths may omit it. Retry only proven reads within a bounded deadline; a mutation is never automatically replayed after an ambiguous response.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED42902"
          }
        }
      },
      "headers": {
        "Retry-After": {
          "description": "Optional server delay in whole seconds or an HTTP date. Absence is not permission for an immediate retry.",
          "schema": {
            "type": "string",
            "examples": [
              "30"
            ]
          }
        }
      }
    },
    "502": {
      "description": "Server-side operation failed.",
      "content": {
        "application/json": {
          "example": {
            "success": false,
            "error": "ED50201"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": false,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Userduplicatefunc.php",
      "line": 102
    },
    "reason": "Read duplicate status/configuration or already indexed candidates."
  },
  "x-edoobox-runtimeMutationGuard": false,
  "x-edoobox-get-effect": "read",
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/02-booking-users.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Userduplicate.php",
    "method": "getUserduplicate",
    "line": 12
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": true,
  "x-edoobox-safeForAutomation": true,
  "x-edoobox-permission": {
    "resource": "userduplicate",
    "short": "usdu",
    "checkedByDispatcher": true,
    "levels": [
      1,
      3,
      4
    ],
    "description": "Resource permission mapping from APIPermissions(), Authfunc::_getCheckJWT. Additional model/admin/plugin checks may apply; resources absent from api_permission do not acquire a fictitious scope."
  }
}