Appearance
Create New Images Order
API Information
- Request Path:
/market/order/programming/create - Request Method:
POST - Content-Type:
application/json
Request Headers
| Parameter | Type | Required | Description |
|---|---|---|---|
| Authorization | String | Yes | User authentication token |
| Content-Type | String | Yes | Must be set to application/json |
Request Body Structure
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| sensorType | Integer | Yes | Sensor type | 1=SAR, 2=Optical |
| geometry | String | Yes | Geometry (GeoJSON) | - |
| aoiId | Long | No | AOI ID; when provided, server uses AOI geometry | - |
| startDate | String | Yes | Start Time | yyyy-MM-dd HH:mm or yyyy-MM-ddTHH:mm:ss |
| endDate | String | Yes | End Time | yyyy-MM-dd HH:mm or yyyy-MM-ddTHH:mm:ss |
| recurring | Boolean | No | Is Recurring | - |
| recurringDay | Integer | No | Recurring Day | - |
| recurringUnit | Integer | No | Recurring Unit | 1-Day, 2-Week, 3-Month |
| maxCloud | Integer | No | Max Cloud Cover | 0-100 |
| resolutionLevel | Integer | Yes | Resolution level: 1-Ultra High, 2-High Resolution - Submeter, 3-High Resolution, 4-Medium-Low Resolution | 1/2/3/4 |
| outputFolderId | Long | No | Output folder ID | - |
| ossOutputId | Long | No | Existing object storage output config ID | - |
| ossOutput | Object | No | New object storage output config | - |
OssOutputPayload Structure (ossOutput)
| Field | Type | Required | Description | Constraints |
|---|---|---|---|---|
| name | String | No | Config name | - |
| endPoint | String | No | Endpoint | - |
| ak | String | No | Access key | - |
| sk | String | No | Secret key | - |
| accessPath | String | No | Base access path | - |
Request Body Example
json
{
"sensorType": 2,
"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": "2023-10-27 10:00:00",
"endDate": "2023-10-28 23:59:59",
"recurring": false,
"maxCloud": 20,
"resolutionLevel": 2
}Response Body Structure
CommonResponse Object
| Field | Type | Description |
|---|---|---|
| code | Integer | Response status code |
| message | String | Response message |
| data | OrderCreateResp | Response data |
OrderCreateResp Object
| Field | Type | Description |
|---|---|---|
| orderNo | String | Created order number |
Response Examples
Success Response
json
{
"code": 200,
"message": "success",
"data": {
"orderNo": "PROG_ORDER_202310270001"
}
}Failure Response
json
{
"code": 400,
"message": "Satellite not available",
"data": null
}Error Code Description
| Error Code | Description |
|---|---|
| 200 | Success |
| 400 | Request parameter error |
| 401 | Unauthorized |
| 500 | Server internal error |
Usage Instructions
- This API is used to create a satellite programming order
- User authentication is required
- Specify sensor type, time window and geometry
Notes
- Time window must be valid for the selected sensor type