ARNPROXY

Proxynotiz lesen

GET/account/api/v1/proxies/{id}/note

Autorisierung

AuthorizationBearer YOUR_ARNPROXY_API_KEY
Erforderliche Berechtigungread
Acceptapplication/json

Parameter

NameTypBeschreibung
id
pathErforderlich
integerEigene Datensatz-ID für diesen Vorgang; 1–2147483647. Keine angezeigte Bestellnummer oder Anbieter-ID.

Anfragebeispiel

cURL
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    'https://www.arnproxy.com/account/api/v1/proxies/YOUR_PROXY_ID/note'

Beispiele werden hier nicht ausgeführt. Speichern Sie den API-Schlüssel in einer serverseitigen Umgebungsvariablen, nie in URLs oder Browsercode. Bereiten Sie request.json für POST vor.

Antworten

200Erfolgsantwort
application/json
{
    "ok": true,
    "data": {
        "proxy_id": 12345,
        "note": "Example label",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "note_update_available": true,
        "clear_with_empty_string": true,
        "source": "arnproxy_records",
        "maximum_length": 500,
        "maximum_utf8_bytes": 2000,
        "full_unicode_supported": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}
Antwortfelder und Typen
NameTypBeschreibung
okbooleanErfolgskennzeichen; bei false error.code prüfen.
dataobjectVorgangsspezifisches Ergebnis; Beispiele sind synthetisch und dienen der Veranschaulichung.
data.proxy_idintegerZugehörige ARNPROXY-Datensatz-ID statt interner Anbieter-ID verwenden.
data.notestringVorgangsspezifischer Wert für note. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.revisionstringAktualitätskennung unverändert an die zugehörige Änderung/Preisbestätigung zurückgeben.
data.note_update_availablebooleanVorgangsspezifischer Wert für note update available. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.clear_with_empty_stringbooleanVorgangsspezifischer Wert für clear with empty string. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.sourcestringDatenquelle; lokale Datensätze und Live-Anbieterabfragen sind unterschiedliche Nachweise.
data.maximum_lengthintegerVorgangsspezifischer Wert für maximum length. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.maximum_utf8_bytesintegerVorgangsspezifischer Wert für maximum utf8 bytes. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
data.full_unicode_supportedbooleanVorgangsspezifischer Wert für full unicode supported. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
metaobjectMetadaten zu Anfragezuordnung und Datenquelle.
meta.request_idstringKennung dieser HTTP-Anfrage, kein Vorgangsschlüssel oder Bestell-ID.
meta.phasestringVorgangsspezifischer Wert für phase. Rückgabetyp beibehalten und Verhaltenshinweise beachten.
meta.sourcestringDatenquelle; lokale Datensätze und Live-Anbieterabfragen sind unterschiedliche Nachweise.

Fehlerantwort

HTTP 401 · INVALID_API_KEY
{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

Authentifizierung und Validierung können eine Anfrage vor der Ausführung ablehnen. Beachten Sie die Fehlerreferenz und bewahren Sie request_id für den Support auf. Senden Sie niemals Schlüssel oder Passwörter. Fehler & Limits →

Verhalten & wichtige Hinweise

  • Bestehendes Proxy-Notizfeld im Kundenpanel, keine Anbietersendung. Maximal 500 Zeichen gemäß GET-Speichergrenzen. note="" löscht. revision vorher über proxy_note lesen. Identischer Text ergibt changed:false; veraltete revision überschreibt keine anderen Inhalte. Kein Idempotency-Key; nach Unklarheit neu lesen.

Suche in der aktuellen Sprache. Schließen mit Esc