offerAPI-Referenz

POST/v2/offer/list/files

Datei zu einer Ressource hochladen

Lädt eine Datei hoch und ordnet sie der über meta angegebenen kontoeigenen Ressource zu. Multipart-Teil file enthält die Bytes; meta ist ein JSON-String {data:{resource_type,resource_id,filetype,...}}. resource_id muss exakt die zum resource_type passende öffentliche offer-, user- oder admin-ID sein. Für Angebotsdateien: internalOfferFile (geschützt) oder externalOfferFile (öffentlich), jeweils bis 20 MiB. Weitere Typen: avatar (8 MiB, JPEG/PNG/WebP), sign und image2/image3 (2 MiB, JPEG/PNG/GIF/WebP). image1 ist im Getter vorhanden, wird vom Upload-Hook aber abgelehnt. Avatare und Signaturen ersetzen bestehende gleichartige Einträge. Dateityp-, Eigentümer- und Kontoprüfungen gelten vor dem Schreiben.

Operation-ID post_v2_offer_list_files

Vertrag & Verhalten

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

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: offer · offe
Levels: 2, 3, 4
Dispatcher-Prüfung: Ja

Parameter

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

erforderlich

`multipart/form-data`

object

file string erforderlich

Uploaded file bytes; enforce server MIME and size limits.

format: "binary"

meta string erforderlich

JSON-Umschlag mit data.resource_type, data.resource_id und data.filetype als Pflichtangaben; filename und sprachcodiertes description sind optional. Die Ressource muss im Konto bestehen. Beispiel synthetisch.

contentMediaType: "application/json"

Schema-Beispiel

"{\"data\":{\"resource_type\":\"offer\",\"resource_id\":\"offer_012345abcdef_123456\",\"filetype\":\"externalOfferFile\",\"filename\":\"example.pdf\"}}"

Schema-Regel contentSchema

object

data object erforderlich

resource_type string erforderlich

Erlaubte Werte

"offer""user""admin"

resource_id Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

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

Schema-Beispiel

"offer_012345abcdef_123456"

Variante 2 string

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

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

Schema-Beispiel

"user_012345abcdef_123456"

Variante 3 string

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

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

Schema-Beispiel

"admin_012345abcdef_123456"

filetype string erforderlich

Erlaubte Werte

"avatar""sign""internalOfferFile""externalOfferFile""image2""image3"

filename string

description object

Schema für zusätzliche Felder

string

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

Zusätzliche Felder sind in diesem Teilschema ausgeschlossen.

Vollständiges Schema als JSON

{
  "type": "object",
  "required": [
    "file",
    "meta"
  ],
  "properties": {
    "file": {
      "type": "string",
      "format": "binary",
      "description": "Uploaded file bytes; enforce server MIME and size limits."
    },
    "meta": {
      "type": "string",
      "contentMediaType": "application/json",
      "description": "JSON-Umschlag mit data.resource_type, data.resource_id und data.filetype als Pflichtangaben; filename und sprachcodiertes description sind optional. Die Ressource muss im Konto bestehen. Beispiel synthetisch.",
      "examples": [
        "{\"data\":{\"resource_type\":\"offer\",\"resource_id\":\"offer_012345abcdef_123456\",\"filetype\":\"externalOfferFile\",\"filename\":\"example.pdf\"}}"
      ],
      "contentSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "resource_type": {
                "type": "string",
                "enum": [
                  "offer",
                  "user",
                  "admin"
                ]
              },
              "resource_id": {
                "anyOf": [
                  {
                    "type": "string",
                    "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                    "examples": [
                      "offer_012345abcdef_123456"
                    ]
                  },
                  {
                    "type": "string",
                    "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                    "examples": [
                      "user_012345abcdef_123456"
                    ]
                  },
                  {
                    "type": "string",
                    "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                    "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                    "examples": [
                      "admin_012345abcdef_123456"
                    ]
                  }
                ]
              },
              "filetype": {
                "type": "string",
                "enum": [
                  "avatar",
                  "sign",
                  "internalOfferFile",
                  "externalOfferFile",
                  "image2",
                  "image3"
                ]
              },
              "filename": {
                "type": "string"
              },
              "description": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": true,
            "required": [
              "resource_type",
              "resource_id",
              "filetype"
            ]
          }
        },
        "additionalProperties": true,
        "required": [
          "data"
        ]
      }
    }
  },
  "additionalProperties": false
}

Illustrative multipart parts; supply actual file bytes.

{
  "file": "<binary file bytes>",
  "meta": "{\"data\":{\"resource_type\":\"offer\",\"resource_id\":\"offer_012345abcdef_123456\",\"filetype\":\"externalOfferFile\",\"filename\":\"example.pdf\"}}"
}

Antworten

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

200application/json

Daten des beschriebenen Ergebnisses im JSON-data-Feld; error und Ergebniskennzeichen beachten.

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

error boolean | string

error_code string

data object

id Typ nicht eingeschränkt erforderlich

anyOf · Mindestens eine Variante muss passen

Variante 1 string

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

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

Schema-Beispiel

"files_012345abcdef_123456"

Variante 2 array

Array-Elemente

string

Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.

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

Schema-Beispiel

"files_012345abcdef_123456"

Variante 3 null

insert boolean erforderlich

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

type 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"
      ]
    },
    "error_code": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string",
              "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
              "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
              "examples": [
                "files_012345abcdef_123456"
              ]
            },
            {
              "type": "array",
              "items": {
                "type": "string",
                "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                "examples": [
                  "files_012345abcdef_123456"
                ]
              }
            },
            {
              "type": "null"
            }
          ]
        },
        "insert": {
          "type": "boolean"
        }
      },
      "additionalProperties": true,
      "required": [
        "id",
        "insert"
      ]
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": true
}

Beispiel

{
  "success": true,
  "error": false,
  "data": {
    "id": "files_012345abcdef_123456",
    "insert": true
  }
}

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/Offer.php:681postOffer()

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-runtimeMutationGuard

true

x-edoobox-documentationReview

{
  "file": "docs/openapi/operation-contracts/03-offers-places.json",
  "notes": []
}

x-edoobox-source

{
  "file": "application/models/v2/Offer.php",
  "method": "postOffer",
  "line": 681,
  "branch": {
    "file": "application/models/v2/Offer.php",
    "line": 691
  }
}

x-edoobox-documentationStatus

"reviewed"

x-edoobox-readOnly

false

x-edoobox-safeForAutomation

false

x-edoobox-permission

{
  "resource": "offer",
  "short": "offe",
  "checkedByDispatcher": true,
  "levels": [
    2,
    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": "post_v2_offer_list_files",
  "summary": "Datei zu einer Ressource hochladen",
  "description": "Lädt eine Datei hoch und ordnet sie der über meta angegebenen kontoeigenen Ressource zu. Multipart-Teil file enthält die Bytes; meta ist ein JSON-String {data:{resource_type,resource_id,filetype,...}}. resource_id muss exakt die zum resource_type passende öffentliche offer-, user- oder admin-ID sein. Für Angebotsdateien: internalOfferFile (geschützt) oder externalOfferFile (öffentlich), jeweils bis 20 MiB. Weitere Typen: avatar (8 MiB, JPEG/PNG/WebP), sign und image2/image3 (2 MiB, JPEG/PNG/GIF/WebP). image1 ist im Getter vorhanden, wird vom Upload-Hook aber abgelehnt. Avatare und Signaturen ersetzen bestehende gleichartige Einträge. Dateityp-, Eigentümer- und Kontoprüfungen gelten vor dem Schreiben.",
  "tags": [
    "offer"
  ],
  "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"
        ]
      }
    },
    {
      "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": "Daten des beschriebenen Ergebnisses im JSON-data-Feld; error und Ergebniskennzeichen beachten.",
      "content": {
        "application/json": {
          "example": {
            "success": true,
            "error": false,
            "data": {
              "id": "files_012345abcdef_123456",
              "insert": true
            }
          },
          "schema": {
            "type": "object",
            "properties": {
              "success": {
                "type": "boolean"
              },
              "error": {
                "type": [
                  "boolean",
                  "string"
                ]
              },
              "error_code": {
                "type": "string"
              },
              "data": {
                "type": "object",
                "properties": {
                  "id": {
                    "anyOf": [
                      {
                        "type": "string",
                        "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                        "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                        "examples": [
                          "files_012345abcdef_123456"
                        ]
                      },
                      {
                        "type": "array",
                        "items": {
                          "type": "string",
                          "pattern": "^files_[a-f0-9]{12}_-?[0-9]+$",
                          "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                          "examples": [
                            "files_012345abcdef_123456"
                          ]
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "insert": {
                    "type": "boolean"
                  }
                },
                "additionalProperties": true,
                "required": [
                  "id",
                  "insert"
                ]
              },
              "type": {
                "type": "string"
              }
            },
            "additionalProperties": true
          }
        }
      },
      "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,
  "requestBody": {
    "required": true,
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "required": [
            "file",
            "meta"
          ],
          "properties": {
            "file": {
              "type": "string",
              "format": "binary",
              "description": "Uploaded file bytes; enforce server MIME and size limits."
            },
            "meta": {
              "type": "string",
              "contentMediaType": "application/json",
              "description": "JSON-Umschlag mit data.resource_type, data.resource_id und data.filetype als Pflichtangaben; filename und sprachcodiertes description sind optional. Die Ressource muss im Konto bestehen. Beispiel synthetisch.",
              "examples": [
                "{\"data\":{\"resource_type\":\"offer\",\"resource_id\":\"offer_012345abcdef_123456\",\"filetype\":\"externalOfferFile\",\"filename\":\"example.pdf\"}}"
              ],
              "contentSchema": {
                "type": "object",
                "properties": {
                  "data": {
                    "type": "object",
                    "properties": {
                      "resource_type": {
                        "type": "string",
                        "enum": [
                          "offer",
                          "user",
                          "admin"
                        ]
                      },
                      "resource_id": {
                        "anyOf": [
                          {
                            "type": "string",
                            "pattern": "^offer_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                            "examples": [
                              "offer_012345abcdef_123456"
                            ]
                          },
                          {
                            "type": "string",
                            "pattern": "^user_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                            "examples": [
                              "user_012345abcdef_123456"
                            ]
                          },
                          {
                            "type": "string",
                            "pattern": "^admin_[a-f0-9]{12}_-?[0-9]+$",
                            "description": "Öffentliche v2-ID im gewählten Konto; Beispiel ist synthetisch.",
                            "examples": [
                              "admin_012345abcdef_123456"
                            ]
                          }
                        ]
                      },
                      "filetype": {
                        "type": "string",
                        "enum": [
                          "avatar",
                          "sign",
                          "internalOfferFile",
                          "externalOfferFile",
                          "image2",
                          "image3"
                        ]
                      },
                      "filename": {
                        "type": "string"
                      },
                      "description": {
                        "type": "object",
                        "additionalProperties": {
                          "type": "string"
                        }
                      }
                    },
                    "additionalProperties": true,
                    "required": [
                      "resource_type",
                      "resource_id",
                      "filetype"
                    ]
                  }
                },
                "additionalProperties": true,
                "required": [
                  "data"
                ]
              }
            }
          },
          "additionalProperties": false
        },
        "examples": {
          "upload": {
            "summary": "Illustrative multipart parts; supply actual file bytes.",
            "value": {
              "file": "<binary file bytes>",
              "meta": "{\"data\":{\"resource_type\":\"offer\",\"resource_id\":\"offer_012345abcdef_123456\",\"filetype\":\"externalOfferFile\",\"filename\":\"example.pdf\"}}"
            }
          }
        }
      }
    }
  },
  "x-edoobox-runtimeMutationGuard": true,
  "x-edoobox-documentationReview": {
    "file": "docs/openapi/operation-contracts/03-offers-places.json",
    "notes": []
  },
  "x-edoobox-source": {
    "file": "application/models/v2/Offer.php",
    "method": "postOffer",
    "line": 681,
    "branch": {
      "file": "application/models/v2/Offer.php",
      "line": 691
    }
  },
  "x-edoobox-documentationStatus": "reviewed",
  "x-edoobox-readOnly": false,
  "x-edoobox-safeForAutomation": false,
  "x-edoobox-permission": {
    "resource": "offer",
    "short": "offe",
    "checkedByDispatcher": true,
    "levels": [
      2,
      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.
# Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
# Bodydatei request-body.bin für multipart/form-data vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
: "${API_ORIGIN:?API_ORIGIN setzen}"
: "${AUTH_BEARERAUTH:?AUTH_BEARERAUTH setzen}"
: "${AUTH_ACCOUNTCONTEXT:?AUTH_ACCOUNTCONTEXT setzen}"
: "${REQUEST_CONTENT_TYPE:?REQUEST_CONTENT_TYPE setzen}"
curl --request 'POST' \
  --url "${API_ORIGIN%/}"'/v2/offer/list/files' \
  --header 'Authorization: Bearer '"${AUTH_BEARERAUTH}" \
  --header 'edid: '"${AUTH_ACCOUNTCONTEXT}" \
  --header 'Content-Type: '"${REQUEST_CONTENT_TYPE}" \
  --data-binary '@request-body.bin'

JavaScript

// Zeigt Authentifizierungsalternative 1; alle Verfahren dieser Alternative sind gemeinsam erforderlich.
// Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
// Bodydatei request-body.bin für multipart/form-data vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import { readFileSync } from 'node:fs';
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/offer/list/files";
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");
headers['Content-Type'] = required('REQUEST_CONTENT_TYPE');
const body = readFileSync("request-body.bin");
const response = await fetch(url, { method: "POST", headers, body, 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.
# Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
# Bodydatei request-body.bin für multipart/form-data vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import os
import urllib.parse
import urllib.request
import urllib.error
from pathlib import Path

path = "/v2/offer/list/files"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = os.environ["REQUEST_CONTENT_TYPE"]
body = Path("request-body.bin").read_bytes()

# 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="POST", data=body)
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.
// Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
// Bodydatei request-body.bin für multipart/form-data vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import { readFileSync } from 'node:fs';
const required = (name) => {
  const value = process.env[name];
  if (!value) throw new Error(`Set ${name}`);
  return value;
};
let path = "/v2/offer/list/files";
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");
headers['Content-Type'] = required('REQUEST_CONTENT_TYPE');
const body = readFileSync("request-body.bin");
const response = await fetch(url, { method: "POST", headers, body, 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.
# Request Body selbst gemäss Definition vorbereiten; unbekannte Pflichtfelder werden nicht erfunden.
# Bodydatei request-body.bin für multipart/form-data vorbereiten. REQUEST_CONTENT_TYPE einschliesslich nötiger Multipart-Boundary setzen.
import os
import urllib.parse
import urllib.request
import urllib.error
from pathlib import Path

path = "/v2/offer/list/files"
url = os.environ["API_ORIGIN"].rstrip("/") + path
headers = {}
headers["Authorization"] = "Bearer " + os.environ["AUTH_BEARERAUTH"]
headers["edid"] = "" + os.environ["AUTH_ACCOUNTCONTEXT"]
headers["Content-Type"] = os.environ["REQUEST_CONTENT_TYPE"]
body = Path("request-body.bin").read_bytes()

# 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="POST", data=body)
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.