GET/v2/userduplicate/{id}/candidates

Duplikatkandidaten eines Kunden prüfen

Liest höchstens 50 offene Kandidaten für die öffentliche user-ID im Pfad. Fehlt deren Fingerprint, werden Index und Kandidaten dabei neu berechnet und gespeichert. user, config, limits und candidates stehen direkt im Antwortobjekt.

Operation-ID get_v2_userduplicate_id_candidates

Vertrag & Verhalten

Dokumentationsstand: reviewed
Ändert Zustand: Ja
Als readOnly markiert: Nein
Für Automation markiert: Nein

Dieser GET-Aufruf kann Zustand verändern. Die HTTP-Methode allein kennzeichnet hier keinen reinen Lesezugriff.

GET-Verhalten laut Spezifikation

maintenance

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.

Ressource: userduplicate · usdu
Levels: 1, 3, 4
Dispatcher-Prüfung: Ja

Parameter

Pfadparameter

iderforderlich

Öffentliche Kunden-ID, keine userduplicate-ID.

string

pattern: "^user_[a-f0-9]{12}_-?[0-9]+$"

Schema-Beispiel

"user_012345abcdef_123456"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
  "examples": [
    "user_012345abcdef_123456"
  ]
}

Header

languageoptional

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

string

Schema-Beispiel

"de"

Vollständiges Schema als JSON

{
  "type": "string",
  "examples": [
    "de"
  ]
}

X-Edoobox-If-Revisionoptional

Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review.

string

pattern: "^[a-f0-9]{32}$"

Schema-Beispiel

"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$",
  "examples": [
    "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  ]
}

Request Body

Kein Request Body in der Spezifikation beschrieben.

Antworten

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.

Response Header

`X-Edoobox-Revision`

Rotated account revision supplied for the next action in one reviewed sequence.

string

pattern: "^[a-f0-9]{32}$"

Vollständiges Schema als JSON

{
  "type": "string",
  "pattern": "^[a-f0-9]{32}$"
}

`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.

user 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.

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
      }
    },
    "user": {
      "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
    }
  },
  "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": [],
  "user": {
    "id": "user_012345abcdef_123456",
    "first_name": "Alex",
    "last_name": "Beispiel",
    "name": "Alex Beispiel",
    "email": "alex@example.invalid",
    "phone_number": "",
    "company": ""
  }
}

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"
}

409application/json

The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.

`application/json`

object

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

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED40901",
  "error_code": "mutation_revision_conflict"
}

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"
}

503application/json

The account mutation lock or revision store is unavailable. No unprotected fallback is executed.

Response Header

`application/json`

object

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

Vollständiges Schema als JSON

{
  "type": "object",
  "additionalProperties": true
}

Beispiel

{
  "error": "ED50301",
  "error_code": "mutation_revision_busy"
}

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

true

x-edoobox-mutationReview

{
  "source": {
    "file": "application/models/v2/Userduplicate.php",
    "line": 25,
    "reason": "GET candidates calls getCandidatesForUser(...,false). Forced refresh, merge, ignore and clear are separate POST actions."
  },
  "reason": "Read duplicate candidates; create missing derived fingerprint, blocking-key and candidate index data first.",
  "review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/20",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  }
}

x-edoobox-get-effect

"maintenance"

x-edoobox-get-permission-review

{
  "file": "docs/openapi/reviews/vue-get-permission-03.json",
  "pointer": "/operations/20",
  "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
  "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
}

x-edoobox-readonly-maintenance

true

x-edoobox-runtimeMutationGuard

true

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

false

x-edoobox-safeForAutomation

false

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_id_candidates",
  "summary": "Duplikatkandidaten eines Kunden prüfen",
  "description": "Liest höchstens 50 offene Kandidaten für die öffentliche user-ID im Pfad. Fehlt deren Fingerprint, werden Index und Kandidaten dabei neu berechnet und gespeichert. user, config, limits und candidates stehen direkt im Antwortobjekt.",
  "tags": [
    "userduplicate"
  ],
  "security": [
    {
      "bearerAuth": [],
      "accountContext": []
    },
    {
      "sessionCookie": [],
      "accountContext": []
    }
  ],
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "required": true,
      "description": "Öffentliche Kunden-ID, keine userduplicate-ID.",
      "schema": {
        "type": "string",
        "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
        "examples": [
          "user_012345abcdef_123456"
        ]
      }
    },
    {
      "name": "language",
      "in": "header",
      "required": false,
      "description": "Account language code, where the resource supports setLanguage().",
      "schema": {
        "type": "string",
        "examples": [
          "de"
        ]
      }
    },
    {
      "name": "X-Edoobox-If-Revision",
      "in": "header",
      "required": false,
      "schema": {
        "type": "string",
        "pattern": "^[a-f0-9]{32}$",
        "examples": [
          "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
        ]
      },
      "description": "Optional account mutation revision from a preceding authenticated auth-context snapshot. The dispatcher compares it while holding the account lock; mismatch409 requires a new review."
    }
  ],
  "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
                }
              },
              "user": {
                "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
              }
            },
            "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": [],
            "user": {
              "id": "user_012345abcdef_123456",
              "first_name": "Alex",
              "last_name": "Beispiel",
              "name": "Alex Beispiel",
              "email": "alex@example.invalid",
              "phone_number": "",
              "company": ""
            }
          }
        }
      },
      "headers": {
        "X-Edoobox-Revision": {
          "schema": {
            "type": "string",
            "pattern": "^[a-f0-9]{32}$"
          },
          "description": "Rotated account revision supplied for the next action in one reviewed sequence."
        }
      }
    },
    "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"
          }
        }
      }
    },
    "409": {
      "description": "The account changed after the reviewed read. No domain operation is dispatched; obtain fresh state and review again.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED40901",
            "error_code": "mutation_revision_conflict"
          }
        }
      }
    },
    "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"
          }
        }
      }
    },
    "503": {
      "description": "The account mutation lock or revision store is unavailable. No unprotected fallback is executed.",
      "headers": {
        "Retry-After": {
          "schema": {
            "type": "integer",
            "const": 1
          }
        }
      },
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "additionalProperties": true
          },
          "example": {
            "error": "ED50301",
            "error_code": "mutation_revision_busy"
          }
        }
      }
    }
  },
  "x-edoobox-mutates-state": true,
  "x-edoobox-mutationReview": {
    "source": {
      "file": "application/models/v2/Userduplicate.php",
      "line": 25,
      "reason": "GET candidates calls getCandidatesForUser(...,false). Forced refresh, merge, ignore and clear are separate POST actions."
    },
    "reason": "Read duplicate candidates; create missing derived fingerprint, blocking-key and candidate index data first.",
    "review": {
      "file": "docs/openapi/reviews/vue-get-permission-03.json",
      "pointer": "/operations/20",
      "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
      "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
    }
  },
  "x-edoobox-get-effect": "maintenance",
  "x-edoobox-get-permission-review": {
    "file": "docs/openapi/reviews/vue-get-permission-03.json",
    "pointer": "/operations/20",
    "sha256": "cd3a09695d376f9f3c02b6f01b4407cec6498ab07aded113fd0432c98805e20a",
    "scope": "Resource-handler effect. Shared account lifecycle maintenance, read caches and technical revision fences remain separately authorized."
  },
  "x-edoobox-readonly-maintenance": true,
  "x-edoobox-runtimeMutationGuard": true,
  "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": false,
  "x-edoobox-safeForAutomation": false,
  "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."
  }
}

Aufruf vorbereiten

Beispiel

Platzhalter ersetzen und Vertragsangaben prüfen. Die Beispiele werden hier nicht ausgeführt.

cURL

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
# cURL: PATH_* bereits URL-kodiert setzen. JavaScript/Python kodieren die unveränderten Pfadwerte selbst.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${PATH_ID:?PATH_ID setzen}"
curl --request 'GET' \
  --url "${API_ORIGIN%/}"'/v2/userduplicate/'"${PATH_ID}"'/candidates' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}"

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/userduplicate/{id}/candidates";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/userduplicate/{id}/candidates"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Ohne JavaScript können Sie die weiteren Aufrufbeispiele hier aufklappen und den Code manuell kopieren.

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/userduplicate/{id}/candidates";
path = path.replaceAll("{id}", encodeURIComponent(required("PATH_ID")));
const origin = required('API_ORIGIN');
const url = new URL((origin.endsWith('/') ? origin.slice(0, -1) : origin) + path);
const headers = {};
headers["Authorization"] = "Bearer " + required("AUTH_BEARERAUTH");
headers["edid"] = "" + required("AUTH_ACCOUNTCONTEXT");
const response = await fetch(url, { method: "GET", headers, redirect: 'manual' });
const text = await response.text();
console.log(response.status, text);
// HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Python

# Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
import os
import urllib.parse
import urllib.request
import urllib.error

path = "/v2/userduplicate/{id}/candidates"
path = path.replace("{id}", urllib.parse.quote(os.environ["PATH_ID"], safe=""))
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]

# Redirects nicht automatisch verfolgen.
class NoRedirect(urllib.request.HTTPRedirectHandler):
    def redirect_request(self, req, fp, code, msg, headers, newurl):
        return None
request = urllib.request.Request(url, headers=headers, method="GET")
try:
    response = urllib.request.build_opener(NoRedirect).open(request, timeout=30)
except urllib.error.HTTPError as error:
    response = error
print(response.status, response.read().decode("utf-8", errors="replace"))
# HTTP-Status und dokumentierte error/success-Felder gemeinsam prüfen.

Server aus der Spezifikation

https://app2.edoobox.com

edoobox API

Verwenden Sie die für Ihre Integration bestätigte API-Basis-URL. Ein lokaler Entwicklungsserver ist keine Produktionsadresse.

Als Markdown lesenEin Endpunkt. Vollständig. Für Menschen und LLM.