geointel/docs/17-max-prep/M9_API_VALIDATION_EXAMPLES.md

M9 API Validation Examples

All errors must use the documented API envelope.

Invalid Project Name

Request:

{ "name": "" }

Response:

{
  "success": false,
  "data": null,
  "error": {
    "code": "validation_error",
    "message": "Project name is required.",
    "details": { "field": "name" }
  },
  "meta": {}
}

Invalid GeoJSON Polygon

{
  "success": false,
  "data": null,
  "error": {
    "code": "invalid_geometry",
    "message": "Area geometry must be a valid Polygon or MultiPolygon in EPSG:4326.",
    "details": {
      "reason": "self_intersection"
    }
  },
  "meta": {}
}

Unsupported Dataset Type

{
  "success": false,
  "data": null,
  "error": {
    "code": "unsupported_dataset_type",
    "message": "This file type is not supported in V1.",
    "details": {
      "allowed_extensions": [".geojson", ".json", ".tif", ".tiff", ".gpkg"]
    }
  },
  "meta": {}
}

External Source Unavailable

{
  "success": false,
  "data": null,
  "error": {
    "code": "external_service_unavailable",
    "message": "The GRB service is unavailable. Use cached data or retry later.",
    "details": { "source": "GRB" }
  },
  "meta": {}
}

Job Failed

{
  "success": true,
  "data": {
    "job_id": "uuid",
    "status": "failed",
    "error_code": "model_not_available",
    "error_message": "No compatible detection model is configured."
  },
  "error": null,
  "meta": {}
}