TradeAware
  • Welcome to TradeAware User Guide
    • Getting Started
  • Using the TradeAware Web App
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Provide and Review Documents
    • Assess risk in your supply chain
    • Manage your transactions
    • Plot Upload and Analysis Trouble Shooting
    • How-to videos
  • Using the TradeAware API
    • API Access and Business Account Registration
    • Webhooks Guide
    • Authentication
      • Rotate client secret
      • Endpoints enabled for programmatic access
    • Upload and Analyzing Plots
    • Connect with your supply chain
    • Assess risk in your supply chain
    • Manage your transactions
    • API reference
      • Auth
      • Plots
        • Analyses of a specific Plot
        • Batch
          • GeoJSON format
      • Analyses
      • Attachments
      • Business invitations
        • Create a business invitation
        • Create multiple business invitations
        • Update a business invitation
        • List all received invitations
        • List all sent invitations
      • Business connections
      • Transactions
        • Create a Transaction
        • Retrieve Transactions
          • Get a transaction by id
          • List all transactions
        • Modify an existing Transaction
          • Update a Transaction
          • Add a Transaction Component
          • Update a Transaction Component
          • Delete a Transaction Component
        • Delete a Transaction
        • Submit a Transaction
        • Retrieve DDS Data
      • Risk Assessments
        • Supplier Risk Assessments
          • Create a Supplier Risk Assessment
          • Update a Supplier Risk Assessment
          • Retrieve Supplier Risk Assessments
            • Get a supplier risk assessment by id
            • Get all supplier risk assessments
          • Retrieve the history
        • Plot Risk Assessments
          • Create a Plot Risk Assessment
          • Update a Plot Risk Assessment
          • Retrieve Plot Risk Assessments
            • Get a plot risk assessment by id
            • Get all plot risk assessments
          • Retrieve the history
      • Survey responses
      • Health
      • Version
      • Specification
  • Additional Resources
    • FAQs
    • Contact Support
    • Terms and Conditions
Powered by GitBook
On this page
  1. Using the TradeAware API
  2. API reference
  3. Plots
  4. Batch

GeoJSON format

The plots endpoints supports full compatibility with the GeoJSON standard for representing geographic features. This enables easy integration with GIS tools and spatial data pipelines.

What is GeoJSON?

GeoJSON is a widely used format for encoding geographic data structures using JSON. It represents features (like plots) as JSON objects with geometry and associated properties.

Supported GeoJSON Types

The following GeoJSON object types are used for plots:

  • Feature: Represents a single plot.

  • FeatureCollection: Represents a collection of plots.

Content-Type and Accept Headers for GeoJSON

To use GeoJSON in your

  • Request Payload: Set Content-Type: application/geo+json

  • Responses: Set Accept: application/geo+json

The system will automatically serialize and deserialize GeoJSON according to these headers, converting Feature and FeatureCollection objects to and from the internal data model.

Plot as GeoJSON Feature

A single plot is represented as a Feature with the following structure:

{
  "type": "Feature",
  "id": "UUID",
  "geometry": {
    "type": "Polygon",
    "coordinates": [[[...]]]  // Lng/Lat pairs in GeoJSON format
  },
  "properties": {
    "name": "Plot A",
    "commodity": "timber",
    "createdAt": "2024-01-01T12:00:00Z",
    "updatedAt": "2024-01-05T12:00:00Z",
    "businessId": "business-uuid",
    // ....additional properties
  }
}

Multiple Plots as FeatureCollection

When listing or batch-creating multiple plots, the response or request will use a FeatureCollection:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": "plot-uuid-1",
      "geometry": {
        "type": "Polygon",
        "coordinates": [[[...]]]
      },
      "properties": {
        "name": "Plot 1",
        "commodity": "coffee"
        // ....additional properties
      }
    },
    {
      "type": "Feature",
      "id": "plot-uuid-2",
      "geometry": {
        "type": "Polygon",
        "coordinates": [[[...]]]
      },
      "properties": {
        "name": "Plot 2",
        "commodity": "cocoa"
        // ....additional properties
      }
    }
  ]
}

PreviousBatchNextAnalyses

Last updated 13 days ago