API Reference Summary

API Reference Summary

This page is a practical summary of the RavenColonial routes this plugin uses or documents. For the full inferred OpenAPI reference, see the repository document:

https://github.com/Fenris159/ravencolonial_edmc/blob/main/docs/RavenColonial_API_Reference.md

Base URL

The documented API base URL is:

https://ravencolonial100-awcbdvabgze4c5cq.canadacentral-01.azurewebsites.net/

The plugin can be configured to use a different API base when needed.

Project Routes

Method	Route	Plugin use
PUT	/api/project	Create or link a build project from dock context and depot snapshot.
GET	/api/project/{buildId}	Load project details for overlay and project state.
PATCH	/api/project/{buildId}	Sync remaining need from ColonisationConstructionDepot.
POST	/api/project/{buildId}/contribute/{cmdr}	Record commander contribution history.
POST	/api/project/{buildId}/complete	Mark a project complete when completion is detected.

Important distinction:

• PATCH /api/project/{buildId} updates remaining need.
• /contribute records commander history only.
• /supply is not used for journal-driven delivery because depot PATCH is authoritative.

System and Site Routes

Method	Route	Plugin use
GET	/api/system/{id64}/{marketId}	Resolve active or completed project at current dock context.
GET	/api/v2/system/{id64}/architect	Determine architect behavior for plan-location refresh.
GET	/api/v2/system/{id64}/sites	Load plan rows and live link safety checks.
PATCH	/api/v2/system/{nameOrNum}/sites/{siteId}	Targeted completed-site repair for fields such as marketId or name.

Fleet Carrier Routes

Method	Route	Plugin use
GET	/api/cmdr/{cmdr}/fc/all	Load commander-linked carriers and cargo baseline.
GET	/api/cmdr/{cmdr}/active	Include active-project linkedFC market IDs in cargo update eligibility.
GET	/api/fc/{marketId}	Manual or guarded overlay manifest refresh.
PATCH	/api/fc/{marketId}/cargo	Apply signed cargo deltas when cargo moves in or out of eligible carriers.

Commander Routes

Method	Route	Plugin use
POST	/api/cmdr/currentShip	Publish current ship cargo/loadout snapshot when enabled.
GET	/api/cmdr/{cmdr}/active	Active project data and linked FC market IDs.

Payload Shapes

Cargo Map

{
  "steel": 120,
  "titanium": -32
}

For Fleet Carrier PATCH, values are signed deltas.

Depot Sync Project Patch

{
  "buildId": "project-id",
  "commodities": {
    "steel": 761,
    "titanium": 1525
  },
  "maxNeed": 2286,
  "colonisationConstructionDepot": {
    "...": "full journal depot snapshot"
  }
}

Current Ship Snapshot

{
  "cmdr": "Commander Name",
  "name": "Ship Name",
  "type": "type9",
  "maxCargo": 784,
  "cargo": {
    "steel": 512
  }
}

Authentication

Authenticated write routes require the RavenColonial API key configured in EDMC settings.