Skip to content

Create Programming Simulation

API Information

  • Request Path: /market/order/programming/simulation/create
  • Request Method: POST
  • Content-Type: application/json

Request Headers

ParameterTypeRequiredDescription
AuthorizationStringYesUser authentication token
Content-TypeStringYesMust be set to application/json

Request Body Structure

FieldTypeRequiredDescriptionConstraints
providerStringYesProviderchangguang/tianyi
geometryStringYesGeometry (GeoJSON)-
startDateStringYesStart Timeyyyy-MM-dd HH:mm or yyyy-MM-dd HH:mm:ss
endDateStringYesEnd Timeyyyy-MM-dd HH:mm or yyyy-MM-dd HH:mm:ss
maxCloudIntegerNoMax Cloud Cover0-100
resolutionTypeIntegerNoResolution Type1-3(changguang), 4-8(tianyi): 1-Super High(0.3m), 2-Very High(0.5m), 3-High(1m), 4-Spotlight SP(1m), 5-Stripmap SM(3m), 6-Narrow Scan NS(12m), 7-Narrow Scan Tops(12m), 8-Wide Scan ES(20m)

Request Body Example

json
{
  "provider": "tianyi",
  "geometry": "{\"type\":\"Polygon\",\"coordinates\":[[[102.61282157031928,21.488503948497097],[106.99114976403081,21.488503948497097],[106.99114976403081,18.594746845159506],[102.61282157031928,18.594746845159506],[102.61282157031928,21.488503948497097]]]}",
  "startDate": "2026-03-07 14:00:00",
  "endDate": "2026-03-11 23:59:59",
  "maxCloud": 0,
  "resolutionType": 5
}

Response Body Structure

CommonResponse Object

FieldTypeDescription
codeIntegerResponse status code
messageStringResponse message
dataProgrammingSimulationCreateRespResponse data

ProgrammingSimulationCreateResp Object

FieldTypeDescription
taskNoStringSimulation task unique identifier

Response Examples

Success Response

json
{
  "code": 200,
  "message": "success",
  "data": {
    "taskNo": "SIM_20260307_xxxx"
  }
}

Failure Response

json
{
  "code": 400,
  "message": "Invalid parameters",
  "data": null
}

Error Code Description

Error CodeDescription
200Success
400Request parameter error
401Unauthorized
500Server internal error

Usage Instructions

  1. This API is used to create a programming simulation task for the given area and time window
  2. User authentication is required
  3. After creation, use the returned taskNo to query simulation results via /market/order/programming/simulation/results
  4. Simulation results are filled asynchronously via provider callback; poll results until status is success or failed

Notes

  • Simulation is asynchronous; query results later to get pass plans
  • Time window must be valid for the selected provider and resolution type