Skip to content

Conventions

Every endpoint in the Auradonors API shares a small set of conventions. Internalizing them once means you don’t have to re-read them on each resource page.

  • Pagination — page + pageSize query parameters and the PaginatedResult response envelope used by every list endpoint.
  • Errors — the RFC 7807 ProblemDetails envelope, the five canonical status mappings, the traceId extension, and the typed code model.
  • Dates — a bare date is a calendar day in the tenant’s time zone and a range includes its end day; a value with a zone designator is an exact instant.
  • Idempotency — how to make order creation safe to retry through network failures.
  • Rate limits — current per-policy limits and the 429 shape.