Schemas
Every JSON Schema 2020-12 document of the Exchange API v1. Each is served at its $id,
https://ingest.profit-base.online/exchange/v1/schemas/<name>.schema.json; the files here are copies.
| Schema | Title | Description |
|---|---|---|
| account-check-request.schema.json | Account check request | An RSI handle the client saw in the game log. |
| account-check-response.schema.json | Account check response | Whether the handle belongs to the signed-in member. The stored handle is never returned. |
| blueprint-draft.schema.json | Blueprint draft | Blueprints to stage for review in the browser; nothing is written until the member confirms. |
| blueprint.schema.json | Blueprint | One product in the member’s blueprint set. |
| change-result.schema.json | Change result | The compact outcome of a change set (at most 32 KiB): counts, and per-op detail only for ops that were not applied. |
| change-set.schema.json | Change set | A batch of at most 500 ops against one resource, sent with an Idempotency-Key. |
| draft-result.schema.json | Draft result | The single-use handoff the client opens in the browser. |
| envelope.schema.json | Offline-file envelope | The wrapper of an offline exchange file. It carries no handle, player, source folder or file path. |
| extensions.schema.json | Extensions | Namespaced client extensions. Keys are reverse-DNS identifiers; the Basetool never interprets an extension unless it is registered. |
| installation.schema.json | Installation | The label a client gives this installation, and what the server knows of it. |
| item-ref.schema.json | Item reference | Identifies a catalogue entry — a blueprint product, an item, a material or a ship type. The server resolves the first field it can, in the order bt, scRecord, scGuid, uexId, locKey, name. |
| location-list.schema.json | Location list | The warehouse’s non-hidden locations. |
| location-ref.schema.json | Location reference | A warehouse location, resolved against the Basetool’s location list: first by its UEX link, then by the exact name. A place without a warehouse location is LOCATION_UNKNOWN. |
| location.schema.json | Location | A non-hidden warehouse location a client may offer. |
| material-kind.schema.json | Material kind | Read-only classification a client uses to route rows to its own lists. None of it decides a lot’s quality. A UEX flag the Basetool does not know for the material is left out. |
| org-demand.schema.json | Org demand | Anonymised open demand of the units the member belongs to. Carries no names and no free text. |
| org-stock-lot.schema.json | Org stock lot | The shared stock of one unit’s pool of one material at one location, quality and stolen state, summed over every holder, with the amounts earmarked to job orders and to missions and, for a Logistician of the pool under exchange.orgstock.details, its single entries. The same material at the same place in two units is two lots. |
| org-stock-members.schema.json | Org stock members | The roster of a unit a Logistician books stock in for: the unit’s direct members, without those who withhold their name, ordered by name. |
| org-unit-list.schema.json | Org unit list | The org units the member directly belongs to, leadership first, then areas, squadrons and special commands, each by name. |
| org-unit.schema.json | Org unit | An org unit of the organisation: one the member directly belongs to, or the one a ship belongs to. |
| page.schema.json | Page | A snapshot page or a change-feed page of one resource. |
| problem.schema.json | Problem | RFC 9457 problem details with a stable code from the exchange error registry. |
| provenance.schema.json | Provenance | Where an entry came from and when it was observed. |
| quality.schema.json | Quality | Material quality from 0 to 1000, stored as sent for every material; 0 for an item, and for a material whose quality the client does not know. |
| quantity.schema.json | Quantity | An amount with its unit. PIECE amounts are whole. An SCU amount may carry any number of decimals; the server rounds it half-up to three. |
| refinery-draft.schema.json | Refinery draft | Refinery work orders read from screenshots, staged for review in the browser. The SC Extractor’s existing refinery-extract format (ADR-0008). |
| resolve-request.schema.json | Resolve request | Item references to resolve to Basetool keys. |
| resolve-response.schema.json | Resolve response | One result per requested reference, in request order. |
| service-document.schema.json | Service document | What this token may do and what the server expects. |
| ship.schema.json | Ship | One of the member’s own ships. Purchase data is never exchanged. |
| stock-lot.schema.json | Stock lot | The member’s stock, personal and shared, of one material at one location, quality and stolen state, summed across org-unit pools. It has no org unit and no row id. |
| tombstone.schema.json | Tombstone | A removal in the change feed, kept 90 days, naming who removed the entry. |